POST api/GiftCardOps/GetAssociatedGiftCards

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientID	integer	None.
OOCustID	integer	None.
UnifiedCustomerID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 1,
  "OOCustID": 2,
  "UnifiedCustomerID": 3
}

application/xml, text/xml

Sample:

<GetGiftCardListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><ClientID>1</ClientID><OOCustID>2</OOCustID><UnifiedCustomerID>3</UnifiedCustomerID></GetGiftCardListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetGiftCardListResponse

Name	Type	Additional information
Success	boolean	None.
ErrorMessage	string	None.
GiftCards	Collection of GiftCardSummary	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "GiftCards": [
    {
      "PurchaserID": 1,
      "ClaimerID": 1,
      "GiftCardID": 2,
      "CardNumber": "sample string 3",
      "Balance": 4.0,
      "Details": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "CustomerCard": true
    },
    {
      "PurchaserID": 1,
      "ClaimerID": 1,
      "GiftCardID": 2,
      "CardNumber": "sample string 3",
      "Balance": 4.0,
      "Details": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "CustomerCard": true
    }
  ]
}

application/xml, text/xml

Sample:

<GetGiftCardListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><ErrorMessage>sample string 2</ErrorMessage><GiftCards><GiftCardSummary><Balance>4</Balance><CardNumber>sample string 3</CardNumber><ClaimerID>1</ClaimerID><CustomerCard>true</CustomerCard><Details xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:KeyValueOfstringstring><d4p1:Key>sample string 1</d4p1:Key><d4p1:Value>sample string 2</d4p1:Value></d4p1:KeyValueOfstringstring><d4p1:KeyValueOfstringstring><d4p1:Key>sample string 3</d4p1:Key><d4p1:Value>sample string 4</d4p1:Value></d4p1:KeyValueOfstringstring></Details><GiftCardID>2</GiftCardID><PurchaserID>1</PurchaserID></GiftCardSummary><GiftCardSummary><Balance>4</Balance><CardNumber>sample string 3</CardNumber><ClaimerID>1</ClaimerID><CustomerCard>true</CustomerCard><Details xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:KeyValueOfstringstring><d4p1:Key>sample string 1</d4p1:Key><d4p1:Value>sample string 2</d4p1:Value></d4p1:KeyValueOfstringstring><d4p1:KeyValueOfstringstring><d4p1:Key>sample string 3</d4p1:Key><d4p1:Value>sample string 4</d4p1:Value></d4p1:KeyValueOfstringstring></Details><GiftCardID>2</GiftCardID><PurchaserID>1</PurchaserID></GiftCardSummary></GiftCards><Success>true</Success></GetGiftCardListResponse>