Needio.Services

<back to all web services

CreateKeyHolderRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Service/CreateKeyHolder/
CreateKeyHolderRequest Parameters:
NameParameterData TypeRequiredDescription
KeyHolderqueryKeyHolderCreateDtoNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
CreateKeyHolderResponse 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
CreatedDateformDateTimeNo
CreatedByformint?No
ModifiedDateformDateTime?No
ModifiedByformint?No
ServiceKeyHolderState Enum:
NameValue
AtHome0
AtOffice1
AtService2
Returned3
KeyHolderCreateDto Parameters:
NameParameterData TypeRequiredDescription
HolderStateformServiceKeyHolderStateNo
KeyManagementIdformintNo
HolderUserIdformint?No
CreateKeyHolderResponse Parameters:
NameParameterData TypeRequiredDescription
KeyHolderformKeyHolderDtoNo

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

HTTP + XML

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

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

<CreateKeyHolderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <KeyHolder xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Services">
    <d2p1:HolderState>AtHome</d2p1:HolderState>
    <d2p1:HolderUserId>0</d2p1:HolderUserId>
    <d2p1:KeyManagementId>0</d2p1:KeyManagementId>
  </KeyHolder>
</CreateKeyHolderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateKeyHolderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <KeyHolder xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Services">
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Interfaces">0</CreatedBy>
    <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Interfaces">0001-01-01T00:00:00</CreatedDate>
    <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Interfaces">0</ModifiedBy>
    <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Interfaces">0001-01-01T00:00:00</ModifiedDate>
    <d2p1:HolderState>AtHome</d2p1:HolderState>
    <d2p1:HolderUserId>0</d2p1:HolderUserId>
    <d2p1:KeyHolderId>0</d2p1:KeyHolderId>
    <d2p1:KeyManagementId>0</d2p1:KeyManagementId>
  </KeyHolder>
</CreateKeyHolderResponse>