GET api/rewards/promo-code/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

None.

Response Information

Resource Description

VoucherSettingOutputModel

Name	Type	Additional information
Id	string	None.
VoucherCode	string	None.
CampaignCode	string	None.
CampaignName	string	None.
VoucherType	string	None.
TotalCount	integer	None.
RedeemCount	integer	None.
VoucherBalance	integer	None.
ImageUrl	string	None.
RedemptionPoint	decimal number	None.
DiscountAmount	decimal number	None.
IsActive	boolean	None.
IsFeatured	boolean	None.
StartDate	string	None.
EndDate	string	None.
StartTime	date	None.
EndTime	date	None.
MaxCapRedemptionType	string	None.
MaxCapPerMember	integer	None.
ValidityPeriodType	string	None.
ValidityPeriodValue	integer	None.
Title	string	None.
Description	string	None.
ShortDescription	string	None.
TermAndCondition	string	None.
LanguageCode	string	None.
IsCollected	boolean	None.
PaymentURL	string	None.
Images	Collection of VoucherSettingImageModel	None.
Route	string	None.
Params	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "VoucherCode": "sample string 2",
  "CampaignCode": "sample string 3",
  "CampaignName": "sample string 4",
  "VoucherType": "sample string 5",
  "TotalCount": 6,
  "RedeemCount": 7,
  "VoucherBalance": 8,
  "ImageUrl": "sample string 9",
  "RedemptionPoint": 10.0,
  "DiscountAmount": 11.0,
  "IsActive": true,
  "IsFeatured": true,
  "StartDate": "sample string 12",
  "EndDate": "sample string 13",
  "StartTime": "2025-04-04T13:28:28.7189875+08:00",
  "EndTime": "2025-04-04T13:28:28.7189875+08:00",
  "MaxCapRedemptionType": "sample string 14",
  "MaxCapPerMember": 15,
  "ValidityPeriodType": "sample string 16",
  "ValidityPeriodValue": 17,
  "Title": "sample string 18",
  "Description": "sample string 19",
  "ShortDescription": "sample string 20",
  "TermAndCondition": "sample string 21",
  "LanguageCode": "sample string 22",
  "IsCollected": true,
  "PaymentURL": "sample string 23",
  "Images": [
    {
      "ImageUrl": "sample string 1"
    },
    {
      "ImageUrl": "sample string 1"
    }
  ],
  "Route": "sample string 24",
  "Params": {}
}

application/xml, text/xml

Sample:

<VoucherSettingOutputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <Params />
  <Route>sample string 24</Route>
  <CampaignCode>sample string 3</CampaignCode>
  <CampaignName>sample string 4</CampaignName>
  <Description>sample string 19</Description>
  <DiscountAmount>11</DiscountAmount>
  <EndDate>sample string 13</EndDate>
  <EndTime>2025-04-04T13:28:28.7189875+08:00</EndTime>
  <Id>sample string 1</Id>
  <ImageUrl>sample string 9</ImageUrl>
  <Images>
    <VoucherSettingOutputModel.VoucherSettingImageModel>
      <ImageUrl>sample string 1</ImageUrl>
    </VoucherSettingOutputModel.VoucherSettingImageModel>
    <VoucherSettingOutputModel.VoucherSettingImageModel>
      <ImageUrl>sample string 1</ImageUrl>
    </VoucherSettingOutputModel.VoucherSettingImageModel>
  </Images>
  <IsActive>true</IsActive>
  <IsCollected>true</IsCollected>
  <IsFeatured>true</IsFeatured>
  <LanguageCode>sample string 22</LanguageCode>
  <MaxCapPerMember>15</MaxCapPerMember>
  <MaxCapRedemptionType>sample string 14</MaxCapRedemptionType>
  <PaymentURL>sample string 23</PaymentURL>
  <RedeemCount>7</RedeemCount>
  <RedemptionPoint>10</RedemptionPoint>
  <ShortDescription>sample string 20</ShortDescription>
  <StartDate>sample string 12</StartDate>
  <StartTime>2025-04-04T13:28:28.7189875+08:00</StartTime>
  <TermAndCondition>sample string 21</TermAndCondition>
  <Title>sample string 18</Title>
  <TotalCount>6</TotalCount>
  <ValidityPeriodType>sample string 16</ValidityPeriodType>
  <ValidityPeriodValue>17</ValidityPeriodValue>
  <VoucherBalance>8</VoucherBalance>
  <VoucherCode>sample string 2</VoucherCode>
  <VoucherType>sample string 5</VoucherType>
</VoucherSettingOutputModel>