Needio.Services

<back to all web services

GetAllKeyManRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/KeyMan/GetAllKeyMan
GetAllKeyManRequest Parameters:
NameParameterData TypeRequiredDescription
ServiceIdqueryintNo
OfferIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetAllKeyManResponse Parameters:
NameParameterData TypeRequiredDescription
KeyManagementLogsformList<KeyManagementLogDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
KeyManagementLogDto Parameters:
NameParameterData TypeRequiredDescription
KeyManagementLogIdformintNo
KeyStateformServiceKeyStateNo
KeyManagementIdformintNo
CreationAuditedBaseDto Parameters:
NameParameterData TypeRequiredDescription
CreatedOnformDateTimeNo
CreatedByformint?No
ServiceKeyState Enum:
NameValue
AtHome110
Waiting111
NotSent113
Shipped116
AtOffice121
AtService122
WaitingReturn131
Returning136
Returned141
GetAllKeyManResponse Parameters:
NameParameterData TypeRequiredDescription
KeyManagementLogsformList<KeyManagementLogDto>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 /KeyMan/GetAllKeyMan HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ServiceId":0,"OfferId":0,"start":"\/Date(1638920079229+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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