DELETE api/v1/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": "8b36c7fc-1e07-472f-9e77-e0f8f92b70ca", "CardId": "38e1c9c8-b654-4463-9fed-5b87e1510419", "ExternalCardNumber": "sample string 2", "InternalCardNumber": 1 }, { "UserId": "8b36c7fc-1e07-472f-9e77-e0f8f92b70ca", "CardId": "38e1c9c8-b654-4463-9fed-5b87e1510419", "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>38e1c9c8-b654-4463-9fed-5b87e1510419</CardId> <ExternalCardNumber>sample string 2</ExternalCardNumber> <InternalCardNumber>1</InternalCardNumber> <UserId>8b36c7fc-1e07-472f-9e77-e0f8f92b70ca</UserId> </RemoveUserCardViewModel> <RemoveUserCardViewModel> <CardId>38e1c9c8-b654-4463-9fed-5b87e1510419</CardId> <ExternalCardNumber>sample string 2</ExternalCardNumber> <InternalCardNumber>1</InternalCardNumber> <UserId>8b36c7fc-1e07-472f-9e77-e0f8f92b70ca</UserId> </RemoveUserCardViewModel> </CardsRemoved> <Result> <Description>sample string 2</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>1</ResultCode> </Result> </RemoveAllCardsResult>