DELETE api/v2/Users/{id}/UserCards/{cardId}
Removes a Card from an existing User. Returns Success/Error code.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
User Id |
globally unique identifier |
Required |
cardId |
Card Id |
globally unique identifier |
None. |
Body Parameters
RemoveUserCardViewModelName | 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. |
InternalCardNumber |
Conditional: If CardId is null, then this must be the Blub0x Internal card number. If this card does not belong to the same User provided in UserId, then a NotFound error code will be returned. |
integer |
None. |
Request Formats
application/json, text/json
{ "UserId": "6050cd42-4bfe-4552-b5ce-2a02246129e1", "CardId": "c5b7589e-3282-4a95-a1b8-c9f74cd3354e", "ExternalCardNumber": "sample string 2", "InternalCardNumber": 1 }
application/xml, text/xml
<RemoveUserCardViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <CardId>c5b7589e-3282-4a95-a1b8-c9f74cd3354e</CardId> <ExternalCardNumber>sample string 2</ExternalCardNumber> <InternalCardNumber>1</InternalCardNumber> <UserId>6050cd42-4bfe-4552-b5ce-2a02246129e1</UserId> </RemoveUserCardViewModel>
application/x-www-form-urlencoded
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
{ "ResultCode": 1, "Description": "sample string 2" }
application/xml, text/xml
<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>