Needio.Services

<back to all web services

GetKeyHolderListRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Service/GetKeyHolderList
GetKeyHolderListRequest Parameters:
NameParameterData TypeRequiredDescription
KeyHolderIdqueryint?No
HolderStatequeryServiceKeyHolderState?No
UserAddressIdqueryint?No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetKeyHolderListResponse Parameters:
NameParameterData TypeRequiredDescription
KeyHoldersformList<KeyHolderDto>No
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
GetKeyHolderListResponse Parameters:
NameParameterData TypeRequiredDescription
KeyHoldersformList<KeyHolderDto>No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Service/GetKeyHolderList HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"KeyHolderId":0,"HolderState":0,"UserAddressId":0,"start":"\/Date(1638858800522+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"KeyHolders":[{"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}}