DELETE api/v2/Users/{id}/UserCards/RemoveAllCards
Removes all Cards from an existing User. Returns a list of cards removed
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
User Id |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
RemoveAllCardsResultName | Description | Type | Additional information |
---|---|---|---|
Result |
Operation result |
Result |
None. |
CardsRemoved |
List of cards removed |
Collection of RemoveUserCardViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": { "ResultCode": 1, "Description": "sample string 2" }, "CardsRemoved": [ { "UserId": "064dbc7c-e6cf-414c-9a06-dde45a08dafe", "CardId": "e781f2be-40c9-4871-87c6-1c2768065562", "ExternalCardNumber": "sample string 2", "InternalCardNumber": 1 }, { "UserId": "064dbc7c-e6cf-414c-9a06-dde45a08dafe", "CardId": "e781f2be-40c9-4871-87c6-1c2768065562", "ExternalCardNumber": "sample string 2", "InternalCardNumber": 1 } ] }
application/xml, text/xml
Sample:
<RemoveAllCardsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <CardsRemoved> <RemoveUserCardViewModel> <CardId>e781f2be-40c9-4871-87c6-1c2768065562</CardId> <ExternalCardNumber>sample string 2</ExternalCardNumber> <InternalCardNumber>1</InternalCardNumber> <UserId>064dbc7c-e6cf-414c-9a06-dde45a08dafe</UserId> </RemoveUserCardViewModel> <RemoveUserCardViewModel> <CardId>e781f2be-40c9-4871-87c6-1c2768065562</CardId> <ExternalCardNumber>sample string 2</ExternalCardNumber> <InternalCardNumber>1</InternalCardNumber> <UserId>064dbc7c-e6cf-414c-9a06-dde45a08dafe</UserId> </RemoveUserCardViewModel> </CardsRemoved> <Result> <Description>sample string 2</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>1</ResultCode> </Result> </RemoveAllCardsResult>