GET api/General/OfferManage/GetCreatedGiftCardList?AddedByUserID={AddedByUserID}&PageNo={PageNo}&PageSize={PageSize}&SearchTerm={SearchTerm}&ValidityStartDate={ValidityStartDate}&ValidityEndDate={ValidityEndDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AddedByUserID

string

Required

PageNo

integer

Default value is 1

PageSize

integer

Default value is 10

SearchTerm

string

None.

ValidityStartDate

date

None.

ValidityEndDate

date

None.

Body Parameters

None.

Response Information

Resource Description

CreatedGiftCouponPagedAPIVM
NameDescriptionTypeAdditional information
GiftCards

Collection of CreatedGiftCouponView

None.

TotalRecords

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "GiftCards": [
    {
      "OfferID": 1,
      "OfferName": "sample string 2",
      "OfferCount": 3,
      "OfferAmount": 4.0,
      "TotalOfferAmount": 5.0,
      "OfferDescription": "sample string 6",
      "CodeBGTheme": "sample string 7",
      "ValidityStartDate": "2025-12-07T10:01:20.0737655+05:30",
      "ValidityEndDate": "2025-12-07T10:01:20.0737655+05:30",
      "CouponCodes": [
        {
          "CouponCode": "sample string 1",
          "IsRedeemed": true,
          "IsUsed": true
        },
        {
          "CouponCode": "sample string 1",
          "IsRedeemed": true,
          "IsUsed": true
        }
      ]
    },
    {
      "OfferID": 1,
      "OfferName": "sample string 2",
      "OfferCount": 3,
      "OfferAmount": 4.0,
      "TotalOfferAmount": 5.0,
      "OfferDescription": "sample string 6",
      "CodeBGTheme": "sample string 7",
      "ValidityStartDate": "2025-12-07T10:01:20.0737655+05:30",
      "ValidityEndDate": "2025-12-07T10:01:20.0737655+05:30",
      "CouponCodes": [
        {
          "CouponCode": "sample string 1",
          "IsRedeemed": true,
          "IsUsed": true
        },
        {
          "CouponCode": "sample string 1",
          "IsRedeemed": true,
          "IsUsed": true
        }
      ]
    }
  ],
  "TotalRecords": 1
}

application/xml, text/xml

Sample:
<CreatedGiftCouponPagedAPIVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/General.Operations.CustomModels">
  <GiftCards>
    <CreatedGiftCouponView>
      <CodeBGTheme>sample string 7</CodeBGTheme>
      <CouponCodes>
        <GiftCouponWiseView>
          <CouponCode>sample string 1</CouponCode>
          <IsRedeemed>true</IsRedeemed>
          <IsUsed>true</IsUsed>
        </GiftCouponWiseView>
        <GiftCouponWiseView>
          <CouponCode>sample string 1</CouponCode>
          <IsRedeemed>true</IsRedeemed>
          <IsUsed>true</IsUsed>
        </GiftCouponWiseView>
      </CouponCodes>
      <OfferAmount>4</OfferAmount>
      <OfferCount>3</OfferCount>
      <OfferDescription>sample string 6</OfferDescription>
      <OfferID>1</OfferID>
      <OfferName>sample string 2</OfferName>
      <TotalOfferAmount>5</TotalOfferAmount>
      <ValidityEndDate>2025-12-07T10:01:20.0737655+05:30</ValidityEndDate>
      <ValidityStartDate>2025-12-07T10:01:20.0737655+05:30</ValidityStartDate>
    </CreatedGiftCouponView>
    <CreatedGiftCouponView>
      <CodeBGTheme>sample string 7</CodeBGTheme>
      <CouponCodes>
        <GiftCouponWiseView>
          <CouponCode>sample string 1</CouponCode>
          <IsRedeemed>true</IsRedeemed>
          <IsUsed>true</IsUsed>
        </GiftCouponWiseView>
        <GiftCouponWiseView>
          <CouponCode>sample string 1</CouponCode>
          <IsRedeemed>true</IsRedeemed>
          <IsUsed>true</IsUsed>
        </GiftCouponWiseView>
      </CouponCodes>
      <OfferAmount>4</OfferAmount>
      <OfferCount>3</OfferCount>
      <OfferDescription>sample string 6</OfferDescription>
      <OfferID>1</OfferID>
      <OfferName>sample string 2</OfferName>
      <TotalOfferAmount>5</TotalOfferAmount>
      <ValidityEndDate>2025-12-07T10:01:20.0737655+05:30</ValidityEndDate>
      <ValidityStartDate>2025-12-07T10:01:20.0737655+05:30</ValidityStartDate>
    </CreatedGiftCouponView>
  </GiftCards>
  <TotalRecords>1</TotalRecords>
</CreatedGiftCouponPagedAPIVM>