POST api/v2/Users/AssignBluIDMobileCredential
API to add BluID Mobile Credential
Request Information
URI Parameters
None.
Body Parameters
BluIDMobileCredentialAssignViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Represents the ID of the User to obtain a BluID credential for |
globally unique identifier |
Required |
| MobileCredentialPoolId |
Represents the Mobile Credential Pool from which the card will be assigned - this should be configured in the BluSKY before making this call |
globally unique identifier |
Required |
| SendEmail |
Whether we need to send email to the User |
boolean |
Required |
| APISessionId |
This API session ID will help to tag the response with the call |
globally unique identifier |
Required |
| CallbackURL |
BluB0X will call this URL once the Credential is assigned |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserId": "faa40d7c-fc54-4c51-acd3-d9641294fb34",
"MobileCredentialPoolId": "d742b12b-f041-4052-883d-1b613c6635ed",
"SendEmail": true,
"APISessionId": "f2f64139-9864-4c08-a94f-629688945995",
"CallbackURL": "sample string 5"
}
application/xml, text/xml
Sample:
<BluIDMobileCredentialAssignViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <APISessionId>f2f64139-9864-4c08-a94f-629688945995</APISessionId> <CallbackURL>sample string 5</CallbackURL> <MobileCredentialPoolId>d742b12b-f041-4052-883d-1b613c6635ed</MobileCredentialPoolId> <SendEmail>true</SendEmail> <UserId>faa40d7c-fc54-4c51-acd3-d9641294fb34</UserId> </BluIDMobileCredentialAssignViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Result| Name | 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>