POST api/GiftCardOps/LoadGiftCard

LoadGiftCard Adds the specified amount of money to the specified gift card.

Request Information

URI Parameters

None.

Body Parameters

LoadGiftCardRequest
NameDescriptionTypeAdditional information
ClientID

integer

None.

CardNumber

string

None.

Amount

decimal number

None.

TransactionIdent

integer

None.

OnlineTransactionIdent

integer

None.

Details

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientID": 1,
  "CardNumber": "sample string 2",
  "Amount": 3.0,
  "TransactionIdent": 4,
  "OnlineTransactionIdent": 5,
  "Details": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<LoadGiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><Amount>3</Amount><CardNumber>sample string 2</CardNumber><ClientID>1</ClientID><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><OnlineTransactionIdent>5</OnlineTransactionIdent><TransactionIdent>4</TransactionIdent></LoadGiftCardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoadGiftCardResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

transactionID

integer

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "transactionID": 2,
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample:
<LoadGiftCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><ErrorMessage>sample string 3</ErrorMessage><Success>true</Success><transactionID>2</transactionID></LoadGiftCardResponse>