POST api/v2/Users/AddHIDCredential
Creates a HID Mobile credential for a given User
Request Information
URI Parameters
None.
Body Parameters
HidCredentialViewModelName | Description | Type | Additional information |
---|---|---|---|
UserId |
Represents the ID of the User to obtain a credential for |
globally unique identifier |
None. |
HidPartNumber |
Represents the HID Part Number - this should be configured in the BluSKY before making this call |
globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserId": "736d7f52-6a36-4df8-b096-9bdf6d445aa9", "HidPartNumber": "6dad59d3-1bd4-4bca-8189-07d3e5c14571" }
application/xml, text/xml
Sample:
<HidCredentialViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <HidPartNumber>6dad59d3-1bd4-4bca-8189-07d3e5c14571</HidPartNumber> <UserId>736d7f52-6a36-4df8-b096-9bdf6d445aa9</UserId> </HidCredentialViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultName | Description | Type | Additional information |
---|---|---|---|
ResultCode |
Represents the result code |
integer |
None. |
Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ResultCode": 1, "Description": "sample string 2" }
application/xml, text/xml
Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 2</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>1</ResultCode> </Result>