GET api/General/OfferManage/GetCouponCodesPaged?pageNo={pageNo}&pageSize={pageSize}&offerId={offerId}&searchTerm={searchTerm}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageNo

integer

Required

pageSize

integer

Required

offerId

integer

None.

searchTerm

string

None.

Body Parameters

None.

Response Information

Resource Description

OfferCouponCodePagedAPIVM
NameDescriptionTypeAdditional information
Coupons

Collection of utblOfferCouponCode

None.

TotalRecords

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Coupons": [
    {
      "RecordID": 1,
      "OfferID": 2,
      "Code": "sample string 3",
      "CodeTitle": "sample string 4",
      "CodeDescription": "sample string 5",
      "PerCouponOfferAmount": 1.0,
      "CodeBGTheme": "sample string 6"
    },
    {
      "RecordID": 1,
      "OfferID": 2,
      "Code": "sample string 3",
      "CodeTitle": "sample string 4",
      "CodeDescription": "sample string 5",
      "PerCouponOfferAmount": 1.0,
      "CodeBGTheme": "sample string 6"
    }
  ],
  "TotalRecords": 1
}

application/xml, text/xml

Sample:
<OfferCouponCodePagedAPIVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/General.Operations.CustomModels">
  <Coupons xmlns:d2p1="http://schemas.datacontract.org/2004/07/General.Operations.Models">
    <d2p1:utblOfferCouponCode>
      <d2p1:Code>sample string 3</d2p1:Code>
      <d2p1:CodeBGTheme>sample string 6</d2p1:CodeBGTheme>
      <d2p1:CodeDescription>sample string 5</d2p1:CodeDescription>
      <d2p1:CodeTitle>sample string 4</d2p1:CodeTitle>
      <d2p1:OfferID>2</d2p1:OfferID>
      <d2p1:PerCouponOfferAmount>1</d2p1:PerCouponOfferAmount>
      <d2p1:RecordID>1</d2p1:RecordID>
    </d2p1:utblOfferCouponCode>
    <d2p1:utblOfferCouponCode>
      <d2p1:Code>sample string 3</d2p1:Code>
      <d2p1:CodeBGTheme>sample string 6</d2p1:CodeBGTheme>
      <d2p1:CodeDescription>sample string 5</d2p1:CodeDescription>
      <d2p1:CodeTitle>sample string 4</d2p1:CodeTitle>
      <d2p1:OfferID>2</d2p1:OfferID>
      <d2p1:PerCouponOfferAmount>1</d2p1:PerCouponOfferAmount>
      <d2p1:RecordID>1</d2p1:RecordID>
    </d2p1:utblOfferCouponCode>
  </Coupons>
  <TotalRecords>1</TotalRecords>
</OfferCouponCodePagedAPIVM>