POST api/Book/ApplyGiftCard

Request Information

URI Parameters

None.

Body Parameters

FPGiftCardRequest
NameDescriptionTypeAdditional information
DiscountRequest

GiftCardRequest

None.

SoapAuthentication

SoapAuthentication

None.

Request Formats

application/json, text/json

Sample:
{
  "DiscountRequest": {
    "ContractId": 1,
    "ContractLocatorKey": "sample string 2",
    "GiftCardCode": "sample string 3"
  },
  "SoapAuthentication": {
    "UserName": "sample string 1",
    "Password": "sample string 2"
  }
}

text/html

Sample:
{"DiscountRequest":{"ContractId":1,"ContractLocatorKey":"sample string 2","GiftCardCode":"sample string 3"},"SoapAuthentication":{"UserName":"sample string 1","Password":"sample string 2"}}

application/xml, text/xml

Sample:
<FPGiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FPWebBox.BusinessObjects">
  <DiscountRequest>
    <ContractId>1</ContractId>
    <ContractLocatorKey>sample string 2</ContractLocatorKey>
    <GiftCardCode>sample string 3</GiftCardCode>
  </DiscountRequest>
  <SoapAuthentication>
    <Password>sample string 2</Password>
    <UserName>sample string 1</UserName>
  </SoapAuthentication>
</FPGiftCardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GiftCardResponse
NameDescriptionTypeAdditional information
ContractId

integer

None.

GiftCardCode

string

None.

GiftCardAmount

decimal number

None.

Message

string

None.

ErrorCode

string

None.

ErrorNode

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ContractId": 1,
  "GiftCardCode": "sample string 2",
  "GiftCardAmount": 3.1,
  "Message": "sample string 4",
  "ErrorCode": "sample string 5",
  "ErrorNode": "sample string 6"
}

text/html

Sample:
{"ContractId":1,"GiftCardCode":"sample string 2","GiftCardAmount":3.1,"Message":"sample string 4","ErrorCode":"sample string 5","ErrorNode":"sample string 6"}

application/xml, text/xml

Sample:
<GiftCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FPWebBox.BusinessObjects">
  <ContractId>1</ContractId>
  <ErrorCode>sample string 5</ErrorCode>
  <ErrorNode>sample string 6</ErrorNode>
  <GiftCardAmount>3.1</GiftCardAmount>
  <GiftCardCode>sample string 2</GiftCardCode>
  <Message>sample string 4</Message>
</GiftCardResponse>