POST api/v2/Users/AssignBluIDMobileCredential
API to add BluID Mobile Credential
Request Information
URI Parameters
None.
Body Parameters
BluIDMobileCredentialAssignViewModelName | 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": "05eb2bd1-7153-4306-b7d7-35380e1c15ca", "MobileCredentialPoolId": "1cb2d5c4-c9fb-40af-92d6-95a9c22fa799", "SendEmail": true, "APISessionId": "897940b5-8d1e-408a-9f54-28b72ac7fcad", "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>897940b5-8d1e-408a-9f54-28b72ac7fcad</APISessionId> <CallbackURL>sample string 5</CallbackURL> <MobileCredentialPoolId>1cb2d5c4-c9fb-40af-92d6-95a9c22fa799</MobileCredentialPoolId> <SendEmail>true</SendEmail> <UserId>05eb2bd1-7153-4306-b7d7-35380e1c15ca</UserId> </BluIDMobileCredentialAssignViewModel>
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>