POST api/v1/Users/RevokeBluIDMobileCredential
API to revoke BluID Mobile Credential
Request Information
URI Parameters
None.
Body Parameters
BluIDMobileCredentialRevokeViewModelName | Description | Type | Additional information |
---|---|---|---|
UserId |
Represents the ID of the User to obtain Revoke BluID credential for |
globally unique identifier |
Required |
CardNumber |
Represents the Card Number which you want to revoke |
integer |
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 revoked |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserId": "6d3a5b1a-a016-4bc5-ade9-9590cde8f2fc", "CardNumber": 2, "SendEmail": true, "APISessionId": "c92a29a7-6b59-4ed4-829b-d03c1bd72fbd", "CallbackURL": "sample string 5" }
application/xml, text/xml
Sample:
<BluIDMobileCredentialRevokeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <APISessionId>c92a29a7-6b59-4ed4-829b-d03c1bd72fbd</APISessionId> <CallbackURL>sample string 5</CallbackURL> <CardNumber>2</CardNumber> <SendEmail>true</SendEmail> <UserId>6d3a5b1a-a016-4bc5-ade9-9590cde8f2fc</UserId> </BluIDMobileCredentialRevokeViewModel>
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>