Needio.Services

<back to all web services

GetKeyManagementListRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Service/GetKeyManagementList
GetKeyManagementListRequest Parameters:
NameParameterData TypeRequiredDescription
KeyManagementIdqueryint?No
KeyStatequeryServiceKeyState?No
ActiveYnquerybool?No
UserAddressIdqueryint?No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetKeyManagementListResponse Parameters:
NameParameterData TypeRequiredDescription
KeyManagementsformList<KeyManagementDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
KeyManagementDto Parameters:
NameParameterData TypeRequiredDescription
KeyManagementIdformintNo
KeyStateformServiceKeyStateNo
ActiveYnformboolNo
UserAddressIdformintNo
AuditedBaseDto Parameters:
NameParameterData TypeRequiredDescription
CreatedOnformDateTimeNo
CreatedByformint?No
ModifiedOnformDateTime?No
ModifiedByformint?No
ServiceKeyState Enum:
NameValue
AtHome110
Waiting111
NotSent113
Shipped116
AtOffice121
AtService122
WaitingReturn131
Returning136
Returned141
GetKeyManagementListResponse Parameters:
NameParameterData TypeRequiredDescription
KeyManagementsformList<KeyManagementDto>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Service/GetKeyManagementList HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"KeyManagementId":0,"KeyState":0,"ActiveYn":false,"UserAddressId":0,"start":"\/Date(1638562976510+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"KeyManagements":[{"KeyManagementId":0,"KeyState":110,"ActiveYn":false,"UserAddressId":0,"CreatedOn":"\/Date(-62135596800000-0000)\/","CreatedBy":0,"ModifiedOn":"\/Date(-62135596800000-0000)\/","ModifiedBy":0}],"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}