Needio.Services

<back to all web services

CreateKeyManagementRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Service/CreateKeyManagement/
CreateKeyManagementRequest Parameters:
NameParameterData TypeRequiredDescription
KeyManagementqueryKeyManagementCreateDtoNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
CreateKeyManagementResponse Parameters:
NameParameterData TypeRequiredDescription
KeyManagementformKeyManagementDtoNo
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
KeyManagementCreateDto Parameters:
NameParameterData TypeRequiredDescription
KeyManagementIdformint?No
KeyStateformServiceKeyStateNo
ActiveYnformboolNo
UserAddressIdformintNo
CreateKeyManagementResponse Parameters:
NameParameterData TypeRequiredDescription
KeyManagementformKeyManagementDtoNo

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/CreateKeyManagement/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateKeyManagementRequest 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>
  <KeyManagement xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Services">
    <d2p1:ActiveYn>false</d2p1:ActiveYn>
    <d2p1:KeyManagementId>0</d2p1:KeyManagementId>
    <d2p1:KeyState>AtHome</d2p1:KeyState>
    <d2p1:UserAddressId>0</d2p1:UserAddressId>
  </KeyManagement>
</CreateKeyManagementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateKeyManagementResponse 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>
  <KeyManagement 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>
    <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Interfaces">0001-01-01T00:00:00</CreatedOn>
    <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Interfaces">0</ModifiedBy>
    <ModifiedOn xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models.Interfaces">0001-01-01T00:00:00</ModifiedOn>
    <d2p1:ActiveYn>false</d2p1:ActiveYn>
    <d2p1:KeyManagementId>0</d2p1:KeyManagementId>
    <d2p1:KeyState>AtHome</d2p1:KeyState>
    <d2p1:UserAddressId>0</d2p1:UserAddressId>
  </KeyManagement>
</CreateKeyManagementResponse>