POST api/GiftCardOps/RegisterGiftCard

RegisterGiftCard Links a gift card to a Customer

Request Information

URI Parameters

None.

Body Parameters

RegisterGiftCardRequest
NameDescriptionTypeAdditional information
ClientID

integer

None.

CardNumber

string

None.

PurchasingOOCustID

integer

None.

PurchasingUCID

integer

None.

CustomerFirstName

string

None.

CustomerLastName

string

None.

CustomerEmail

string

None.

Phone

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientID": 1,
  "CardNumber": "sample string 2",
  "PurchasingOOCustID": 3,
  "PurchasingUCID": 4,
  "CustomerFirstName": "sample string 5",
  "CustomerLastName": "sample string 6",
  "CustomerEmail": "sample string 7",
  "Phone": "sample string 8"
}

application/xml, text/xml

Sample:
<RegisterGiftCardRequest 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><CustomerEmail>sample string 7</CustomerEmail><CustomerFirstName>sample string 5</CustomerFirstName><CustomerLastName>sample string 6</CustomerLastName><Phone>sample string 8</Phone><PurchasingOOCustID>3</PurchasingOOCustID><PurchasingUCID>4</PurchasingUCID></RegisterGiftCardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RegisterGiftCardResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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