Skip to main content
 
 
 
BluINFO

RemoveUserCard

Overview 

Removes a Card from an existing User. Returns Success/Error code.

Request Information


Method

POST - api/Person/RemoveUserCard

URI Parameters

None.

Body Parameters

RemoveUserCardViewModel

Name Description Type Additional information
UserId

Required: The PK of the existing User that you want to remove the card from.

globally unique identifier

None.

CardId

Optional: The PK of the existing Card that you want to remove from the User. Retrieve by calling Person/GetUserById

globally unique identifier

None.

ExternalCardNumber

Conditional: If CardId is null, then this must be the External number imprinted on the card you wish to remove. If this card does not belong to the same User provided in UserId, then a NotFound error code will be returned.

string

None.

JSON

{
  "UserId": "736926c3-238f-45f1-9d0d-9d4c33f3f121",
  "CardId": "20baee11-cfd0-4034-8482-f4e51d116d14",
  "ExternalCardNumber": "sample string 2"
}

XML

<RemoveUserCardViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <CardId>20baee11-cfd0-4034-8482-f4e51d116d14</CardId>
  <ExternalCardNumber>sample string 2</ExternalCardNumber>
  <UserId>736926c3-238f-45f1-9d0d-9d4c33f3f121</UserId>
</RemoveUserCardViewModel>

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 

JSON

{
  "ResultCode": 1,
  "Description": "sample string 2"
}

XML

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <Description>sample string 2</Description>
  <ResultCode>1</ResultCode>
</Result>
  • Was this article helpful?