POST api/GiftCardOps/CreateGiftCard

CreateGiftCard generates a new card number based upon location parameters (LeadingDigits:the actual digits to lead all generated numbers , TotalDigits: the total number of digits in the card number)

Request Information

URI Parameters

None.

Body Parameters

CreateGiftCardRequest

Name	Type	Additional information
ClientID	integer	None.
PurchasingOOCustID	integer	None.
PurchasingUCID	integer	None.
CustomerFirstName	string	None.
CustomerLastName	string	None.
CustomerEmail	string	None.
Phone	string	None.
EmployeeID	integer	None.
EmployeeName	string	None.
ManagerID	integer	None.
ManagerName	string	None.
Details	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 1,
  "PurchasingOOCustID": 2,
  "PurchasingUCID": 3,
  "CustomerFirstName": "sample string 4",
  "CustomerLastName": "sample string 5",
  "CustomerEmail": "sample string 6",
  "Phone": "sample string 7",
  "EmployeeID": 8,
  "EmployeeName": "sample string 9",
  "ManagerID": 10,
  "ManagerName": "sample string 11",
  "Details": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<CreateGiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><ClientID>1</ClientID><CustomerEmail>sample string 6</CustomerEmail><CustomerFirstName>sample string 4</CustomerFirstName><CustomerLastName>sample string 5</CustomerLastName><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><EmployeeID>8</EmployeeID><EmployeeName>sample string 9</EmployeeName><ManagerID>10</ManagerID><ManagerName>sample string 11</ManagerName><Phone>sample string 7</Phone><PurchasingOOCustID>2</PurchasingOOCustID><PurchasingUCID>3</PurchasingUCID></CreateGiftCardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateGiftCardResponse

Name	Type	Additional information
Success	boolean	None.
CardNumber	string	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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