POST api/v1/Users/AddHIDCredential

Creates a HID Mobile credential for a given User

Request Information

URI Parameters

None.

Body Parameters

HidCredentialViewModel
NameDescriptionTypeAdditional 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": "efe38961-61e0-4ed6-a9fb-545e41efbf18",
  "HidPartNumber": "cd7f0809-f7f0-4ee5-9e84-b24928ed0649"
}

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>cd7f0809-f7f0-4ee5-9e84-b24928ed0649</HidPartNumber>
  <UserId>efe38961-61e0-4ed6-a9fb-545e41efbf18</UserId>
</HidCredentialViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional 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>