Needio.Services

<back to all web services

GetKeyHolderRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Service/GetKeyHolder/{KeyHolderId}
GetKeyHolderRequest Parameters:
NameParameterData TypeRequiredDescription
KeyHolderIdpathintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetKeyHolderResponse Parameters:
NameParameterData TypeRequiredDescription
KeyHolderformKeyHolderDtoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
KeyHolderDto Parameters:
NameParameterData TypeRequiredDescription
KeyHolderIdformintNo
HolderStateformServiceKeyHolderStateNo
KeyManagementIdformintNo
HolderUserIdformint?No
AuditedBaseDto Parameters:
NameParameterData TypeRequiredDescription
CreatedOnformDateTimeNo
CreatedByformint?No
ModifiedOnformDateTime?No
ModifiedByformint?No
ServiceKeyHolderState Enum:
NameValue
AtHome0
AtOffice1
AtService2
Returned3
GetKeyHolderResponse Parameters:
NameParameterData TypeRequiredDescription
KeyHolderformKeyHolderDtoNo

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/GetKeyHolder/{KeyHolderId} HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"KeyHolder":{"KeyHolderId":0,"HolderState":0,"KeyManagementId":0,"HolderUserId":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}}