POST api/GiftCardOps/GetGiftCard

GetGiftCard returns a summary for the specified gift card

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ClientID		integer	None.
CardNumber		string	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 1,
  "CardNumber": "sample string 2"
}

application/xml, text/xml

Sample:

<QueryGiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><CardNumber>sample string 2</CardNumber><ClientID>1</ClientID></QueryGiftCardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GiftCardSummary

Name	Type	Additional information
PurchaserID	integer	None.
ClaimerID	integer	None.
GiftCardID	integer	None.
CardNumber	string	None.
Balance	decimal number	None.
Details	Dictionary of string [key] and string [value]	None.
CustomerCard	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "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:

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