DELETE api/v1/Users/{id}/UserCards/RemoveAllCards

Removes all Cards from an existing User. Returns a list of cards removed

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

User Id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

RemoveAllCardsResult
NameDescriptionTypeAdditional 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": "a1c62712-1ba3-4229-9dc1-ebeb0e377951",
      "CardId": "a6aa9fef-5d69-40ac-9322-9c32d90236d1",
      "ExternalCardNumber": "sample string 2",
      "InternalCardNumber": 1
    },
    {
      "UserId": "a1c62712-1ba3-4229-9dc1-ebeb0e377951",
      "CardId": "a6aa9fef-5d69-40ac-9322-9c32d90236d1",
      "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>a6aa9fef-5d69-40ac-9322-9c32d90236d1</CardId>
      <ExternalCardNumber>sample string 2</ExternalCardNumber>
      <InternalCardNumber>1</InternalCardNumber>
      <UserId>a1c62712-1ba3-4229-9dc1-ebeb0e377951</UserId>
    </RemoveUserCardViewModel>
    <RemoveUserCardViewModel>
      <CardId>a6aa9fef-5d69-40ac-9322-9c32d90236d1</CardId>
      <ExternalCardNumber>sample string 2</ExternalCardNumber>
      <InternalCardNumber>1</InternalCardNumber>
      <UserId>a1c62712-1ba3-4229-9dc1-ebeb0e377951</UserId>
    </RemoveUserCardViewModel>
  </CardsRemoved>
  <Result>
    <Description>sample string 2</Description>
    <HttpStatusCode>Continue</HttpStatusCode>
    <ResultCode>1</ResultCode>
  </Result>
</RemoveAllCardsResult>