POST api/v2/Users/AssignBluIDMobileCredential

API to add BluID Mobile Credential

Request Information

URI Parameters

None.

Body Parameters

BluIDMobileCredentialAssignViewModel
NameDescriptionTypeAdditional 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": "341a02cf-1db8-4620-9f35-5e5f10c5e98a",
  "MobileCredentialPoolId": "440a6b18-ccee-4fb8-8fc5-1b348479f9c7",
  "SendEmail": true,
  "APISessionId": "eb9b0513-cb56-4e0a-acd1-766e64875a00",
  "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>eb9b0513-cb56-4e0a-acd1-766e64875a00</APISessionId>
  <CallbackURL>sample string 5</CallbackURL>
  <MobileCredentialPoolId>440a6b18-ccee-4fb8-8fc5-1b348479f9c7</MobileCredentialPoolId>
  <SendEmail>true</SendEmail>
  <UserId>341a02cf-1db8-4620-9f35-5e5f10c5e98a</UserId>
</BluIDMobileCredentialAssignViewModel>

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>