POST api/GiftCardOps/GetGiftCardDetails

GetGiftCardDetails returns the available funds on the specified gift card and the user that claimed the gift card if a user claimed it.

Request Information

URI Parameters

None.

Body Parameters

GetGiftCardDetailsRequest

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:

<GetGiftCardDetailsRequest 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></GetGiftCardDetailsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetGiftCardDetailsResponse

Name	Type	Additional information
Success	boolean	None.
Balance	decimal number	None.
ErrorMessage	string	None.
GiftCardNumber	string	None.
Customer	UnifiedCustomer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Balance": 2.0,
  "ErrorMessage": "sample string 3",
  "GiftCardNumber": "sample string 4",
  "Customer": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "EmailAddress": "sample string 3",
    "Phone": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<GetGiftCardDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><Balance>2</Balance><Customer><EmailAddress>sample string 3</EmailAddress><FirstName>sample string 1</FirstName><LastName>sample string 2</LastName><Phone>sample string 4</Phone></Customer><ErrorMessage>sample string 3</ErrorMessage><GiftCardNumber>sample string 4</GiftCardNumber><Success>true</Success></GetGiftCardDetailsResponse>