GET api/General/Offer/GetOfferList?PageNo={PageNo}&PageSize={PageSize}&SearchTerm={SearchTerm}&ByDate={ByDate}&PartnerID={PartnerID}&AdminAddedOnly={AdminAddedOnly}&IsCustomerSpecific={IsCustomerSpecific}

Request Information

URI Parameters

Name	Type	Additional information
PageNo	integer	Required
PageSize	integer	Required
SearchTerm	string	Required
ByDate	date	Required
PartnerID	string	Required
AdminAddedOnly	boolean	Required
IsCustomerSpecific	boolean	Required

Body Parameters

None.

Response Information

Resource Description

OfferApiVM

Name	Description	Type	Additional information
OfferDetailList		Collection of utblOfferDetail	None.
TotalRecords		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OfferDetailList": [
    {
      "CouponID": "sample string 1",
      "Title": "sample string 2",
      "Description": "sample string 3",
      "LongDesc": "sample string 4",
      "OfferCode": "sample string 5",
      "OfferPercent": 1,
      "OfferMaxAmt": 6.0,
      "MinTransAmt": 7.0,
      "OfferType": "sample string 8",
      "ValidFrom": "2025-12-07T10:01:21.0136468+05:30",
      "ValidUpto": "2025-12-07T10:01:21.0136468+05:30",
      "IsCustomerSpecific": true,
      "OfferedByPartner": true,
      "AutoApply": true,
      "PartnerID": "sample string 14",
      "CouponType": "sample string 15",
      "ApplicableFor": "sample string 16",
      "DailyLimit": 1,
      "UserID": "sample string 17",
      "TransDate": "2025-12-07T10:01:21.0136468+05:30",
      "BudgetAmount": 1.0,
      "BudgetUsedAmount": 1.0,
      "TimeSlots": [
        {
          "DayNo": 1,
          "DayName": "sample string 2",
          "OpeningTime": "sample string 3",
          "ClosingTime": "sample string 4",
          "IsSelected": true
        },
        {
          "DayNo": 1,
          "DayName": "sample string 2",
          "OpeningTime": "sample string 3",
          "ClosingTime": "sample string 4",
          "IsSelected": true
        }
      ],
      "CustList": [
        "sample string 1",
        "sample string 2"
      ],
      "Customers": [
        {
          "CustomerID": "sample string 1",
          "CustomerName": "sample string 2"
        },
        {
          "CustomerID": "sample string 1",
          "CustomerName": "sample string 2"
        }
      ]
    },
    {
      "CouponID": "sample string 1",
      "Title": "sample string 2",
      "Description": "sample string 3",
      "LongDesc": "sample string 4",
      "OfferCode": "sample string 5",
      "OfferPercent": 1,
      "OfferMaxAmt": 6.0,
      "MinTransAmt": 7.0,
      "OfferType": "sample string 8",
      "ValidFrom": "2025-12-07T10:01:21.0136468+05:30",
      "ValidUpto": "2025-12-07T10:01:21.0136468+05:30",
      "IsCustomerSpecific": true,
      "OfferedByPartner": true,
      "AutoApply": true,
      "PartnerID": "sample string 14",
      "CouponType": "sample string 15",
      "ApplicableFor": "sample string 16",
      "DailyLimit": 1,
      "UserID": "sample string 17",
      "TransDate": "2025-12-07T10:01:21.0136468+05:30",
      "BudgetAmount": 1.0,
      "BudgetUsedAmount": 1.0,
      "TimeSlots": [
        {
          "DayNo": 1,
          "DayName": "sample string 2",
          "OpeningTime": "sample string 3",
          "ClosingTime": "sample string 4",
          "IsSelected": true
        },
        {
          "DayNo": 1,
          "DayName": "sample string 2",
          "OpeningTime": "sample string 3",
          "ClosingTime": "sample string 4",
          "IsSelected": true
        }
      ],
      "CustList": [
        "sample string 1",
        "sample string 2"
      ],
      "Customers": [
        {
          "CustomerID": "sample string 1",
          "CustomerName": "sample string 2"
        },
        {
          "CustomerID": "sample string 1",
          "CustomerName": "sample string 2"
        }
      ]
    }
  ],
  "TotalRecords": 1
}

application/xml, text/xml

Sample:

<OfferApiVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/General.Operations.CustomModels">
  <OfferDetailList xmlns:d2p1="http://schemas.datacontract.org/2004/07/General.Operations.Models">
    <d2p1:utblOfferDetail>
      <d2p1:ApplicableFor>sample string 16</d2p1:ApplicableFor>
      <d2p1:AutoApply>true</d2p1:AutoApply>
      <d2p1:BudgetAmount>1</d2p1:BudgetAmount>
      <d2p1:BudgetUsedAmount>1</d2p1:BudgetUsedAmount>
      <d2p1:CouponID>sample string 1</d2p1:CouponID>
      <d2p1:CouponType>sample string 15</d2p1:CouponType>
      <d2p1:CustList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CustList>
      <d2p1:Customers>
        <d2p1:CustomerInOffer>
          <d2p1:CustomerID>sample string 1</d2p1:CustomerID>
          <d2p1:CustomerName>sample string 2</d2p1:CustomerName>
        </d2p1:CustomerInOffer>
        <d2p1:CustomerInOffer>
          <d2p1:CustomerID>sample string 1</d2p1:CustomerID>
          <d2p1:CustomerName>sample string 2</d2p1:CustomerName>
        </d2p1:CustomerInOffer>
      </d2p1:Customers>
      <d2p1:DailyLimit>1</d2p1:DailyLimit>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:IsCustomerSpecific>true</d2p1:IsCustomerSpecific>
      <d2p1:LongDesc>sample string 4</d2p1:LongDesc>
      <d2p1:MinTransAmt>7</d2p1:MinTransAmt>
      <d2p1:OfferCode>sample string 5</d2p1:OfferCode>
      <d2p1:OfferMaxAmt>6</d2p1:OfferMaxAmt>
      <d2p1:OfferPercent>1</d2p1:OfferPercent>
      <d2p1:OfferType>sample string 8</d2p1:OfferType>
      <d2p1:OfferedByPartner>true</d2p1:OfferedByPartner>
      <d2p1:PartnerID>sample string 14</d2p1:PartnerID>
      <d2p1:TimeSlots>
        <d2p1:OfferTimeSlots>
          <d2p1:ClosingTime>sample string 4</d2p1:ClosingTime>
          <d2p1:DayName>sample string 2</d2p1:DayName>
          <d2p1:DayNo>1</d2p1:DayNo>
          <d2p1:IsSelected>true</d2p1:IsSelected>
          <d2p1:OpeningTime>sample string 3</d2p1:OpeningTime>
        </d2p1:OfferTimeSlots>
        <d2p1:OfferTimeSlots>
          <d2p1:ClosingTime>sample string 4</d2p1:ClosingTime>
          <d2p1:DayName>sample string 2</d2p1:DayName>
          <d2p1:DayNo>1</d2p1:DayNo>
          <d2p1:IsSelected>true</d2p1:IsSelected>
          <d2p1:OpeningTime>sample string 3</d2p1:OpeningTime>
        </d2p1:OfferTimeSlots>
      </d2p1:TimeSlots>
      <d2p1:Title>sample string 2</d2p1:Title>
      <d2p1:TransDate>2025-12-07T10:01:21.0136468+05:30</d2p1:TransDate>
      <d2p1:UserID>sample string 17</d2p1:UserID>
      <d2p1:ValidFrom>2025-12-07T10:01:21.0136468+05:30</d2p1:ValidFrom>
      <d2p1:ValidUpto>2025-12-07T10:01:21.0136468+05:30</d2p1:ValidUpto>
    </d2p1:utblOfferDetail>
    <d2p1:utblOfferDetail>
      <d2p1:ApplicableFor>sample string 16</d2p1:ApplicableFor>
      <d2p1:AutoApply>true</d2p1:AutoApply>
      <d2p1:BudgetAmount>1</d2p1:BudgetAmount>
      <d2p1:BudgetUsedAmount>1</d2p1:BudgetUsedAmount>
      <d2p1:CouponID>sample string 1</d2p1:CouponID>
      <d2p1:CouponType>sample string 15</d2p1:CouponType>
      <d2p1:CustList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CustList>
      <d2p1:Customers>
        <d2p1:CustomerInOffer>
          <d2p1:CustomerID>sample string 1</d2p1:CustomerID>
          <d2p1:CustomerName>sample string 2</d2p1:CustomerName>
        </d2p1:CustomerInOffer>
        <d2p1:CustomerInOffer>
          <d2p1:CustomerID>sample string 1</d2p1:CustomerID>
          <d2p1:CustomerName>sample string 2</d2p1:CustomerName>
        </d2p1:CustomerInOffer>
      </d2p1:Customers>
      <d2p1:DailyLimit>1</d2p1:DailyLimit>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:IsCustomerSpecific>true</d2p1:IsCustomerSpecific>
      <d2p1:LongDesc>sample string 4</d2p1:LongDesc>
      <d2p1:MinTransAmt>7</d2p1:MinTransAmt>
      <d2p1:OfferCode>sample string 5</d2p1:OfferCode>
      <d2p1:OfferMaxAmt>6</d2p1:OfferMaxAmt>
      <d2p1:OfferPercent>1</d2p1:OfferPercent>
      <d2p1:OfferType>sample string 8</d2p1:OfferType>
      <d2p1:OfferedByPartner>true</d2p1:OfferedByPartner>
      <d2p1:PartnerID>sample string 14</d2p1:PartnerID>
      <d2p1:TimeSlots>
        <d2p1:OfferTimeSlots>
          <d2p1:ClosingTime>sample string 4</d2p1:ClosingTime>
          <d2p1:DayName>sample string 2</d2p1:DayName>
          <d2p1:DayNo>1</d2p1:DayNo>
          <d2p1:IsSelected>true</d2p1:IsSelected>
          <d2p1:OpeningTime>sample string 3</d2p1:OpeningTime>
        </d2p1:OfferTimeSlots>
        <d2p1:OfferTimeSlots>
          <d2p1:ClosingTime>sample string 4</d2p1:ClosingTime>
          <d2p1:DayName>sample string 2</d2p1:DayName>
          <d2p1:DayNo>1</d2p1:DayNo>
          <d2p1:IsSelected>true</d2p1:IsSelected>
          <d2p1:OpeningTime>sample string 3</d2p1:OpeningTime>
        </d2p1:OfferTimeSlots>
      </d2p1:TimeSlots>
      <d2p1:Title>sample string 2</d2p1:Title>
      <d2p1:TransDate>2025-12-07T10:01:21.0136468+05:30</d2p1:TransDate>
      <d2p1:UserID>sample string 17</d2p1:UserID>
      <d2p1:ValidFrom>2025-12-07T10:01:21.0136468+05:30</d2p1:ValidFrom>
      <d2p1:ValidUpto>2025-12-07T10:01:21.0136468+05:30</d2p1:ValidUpto>
    </d2p1:utblOfferDetail>
  </OfferDetailList>
  <TotalRecords>1</TotalRecords>
</OfferApiVM>