GET api/Coupon/GetCouponList

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
CouponList	Collection of CouponDetailDto	None.
success	boolean	None.
code	string	None.
message	string	None.
errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "CouponList": [
    {
      "CouponID": 1,
      "CouponCode": "sample string 2",
      "CouponDescription": "sample string 3",
      "CouponName": "sample string 4",
      "CouponImageDetails": [
        {
          "CouponID": 1,
          "CouponImage": "sample string 2"
        },
        {
          "CouponID": 1,
          "CouponImage": "sample string 2"
        }
      ],
      "CouponImage": "sample string 5",
      "CouponExpiryDate": "2025-06-15T07:58:04.3396766+03:00",
      "CouponType": "sample string 7",
      "CouponValue": 8.0,
      "MerchantName": "sample string 9",
      "MerchantImageLocation": "sample string 10",
      "MerchantMobile": "sample string 11",
      "MerhantEmail": "sample string 12",
      "MerchantPhoneNumber": "sample string 13",
      "CategoryId": 1,
      "Rate": 1.0,
      "FlatAmount": 1.0,
      "RangeMin": 1.0,
      "RangeMax": 1.0,
      "ForEachAmount": 1.0,
      "LicenseNumber": "sample string 14",
      "LicenseImageLocation": "sample string 15",
      "IsActive": true
    },
    {
      "CouponID": 1,
      "CouponCode": "sample string 2",
      "CouponDescription": "sample string 3",
      "CouponName": "sample string 4",
      "CouponImageDetails": [
        {
          "CouponID": 1,
          "CouponImage": "sample string 2"
        },
        {
          "CouponID": 1,
          "CouponImage": "sample string 2"
        }
      ],
      "CouponImage": "sample string 5",
      "CouponExpiryDate": "2025-06-15T07:58:04.3396766+03:00",
      "CouponType": "sample string 7",
      "CouponValue": 8.0,
      "MerchantName": "sample string 9",
      "MerchantImageLocation": "sample string 10",
      "MerchantMobile": "sample string 11",
      "MerhantEmail": "sample string 12",
      "MerchantPhoneNumber": "sample string 13",
      "CategoryId": 1,
      "Rate": 1.0,
      "FlatAmount": 1.0,
      "RangeMin": 1.0,
      "RangeMax": 1.0,
      "ForEachAmount": 1.0,
      "LicenseNumber": "sample string 14",
      "LicenseImageLocation": "sample string 15",
      "IsActive": true
    }
  ],
  "success": true,
  "code": "sample string 2",
  "message": "sample string 3",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<CouponListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Features.CouponSystem.Models">
  <code xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">sample string 2</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">sample string 3</message>
  <success xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">true</success>
  <CouponList>
    <CouponDetailDto>
      <CategoryId>1</CategoryId>
      <CouponCode>sample string 2</CouponCode>
      <CouponDescription>sample string 3</CouponDescription>
      <CouponExpiryDate>2025-06-15T07:58:04.3396766+03:00</CouponExpiryDate>
      <CouponID>1</CouponID>
      <CouponImage>sample string 5</CouponImage>
      <CouponImageDetails>
        <CouponImagesList>
          <CouponID>1</CouponID>
          <CouponImage>sample string 2</CouponImage>
        </CouponImagesList>
        <CouponImagesList>
          <CouponID>1</CouponID>
          <CouponImage>sample string 2</CouponImage>
        </CouponImagesList>
      </CouponImageDetails>
      <CouponName>sample string 4</CouponName>
      <CouponType>sample string 7</CouponType>
      <CouponValue>8</CouponValue>
      <FlatAmount>1</FlatAmount>
      <ForEachAmount>1</ForEachAmount>
      <IsActive>true</IsActive>
      <LicenseImageLocation>sample string 15</LicenseImageLocation>
      <LicenseNumber>sample string 14</LicenseNumber>
      <MerchantImageLocation>sample string 10</MerchantImageLocation>
      <MerchantMobile>sample string 11</MerchantMobile>
      <MerchantName>sample string 9</MerchantName>
      <MerchantPhoneNumber>sample string 13</MerchantPhoneNumber>
      <MerhantEmail>sample string 12</MerhantEmail>
      <RangeMax>1</RangeMax>
      <RangeMin>1</RangeMin>
      <Rate>1</Rate>
    </CouponDetailDto>
    <CouponDetailDto>
      <CategoryId>1</CategoryId>
      <CouponCode>sample string 2</CouponCode>
      <CouponDescription>sample string 3</CouponDescription>
      <CouponExpiryDate>2025-06-15T07:58:04.3396766+03:00</CouponExpiryDate>
      <CouponID>1</CouponID>
      <CouponImage>sample string 5</CouponImage>
      <CouponImageDetails>
        <CouponImagesList>
          <CouponID>1</CouponID>
          <CouponImage>sample string 2</CouponImage>
        </CouponImagesList>
        <CouponImagesList>
          <CouponID>1</CouponID>
          <CouponImage>sample string 2</CouponImage>
        </CouponImagesList>
      </CouponImageDetails>
      <CouponName>sample string 4</CouponName>
      <CouponType>sample string 7</CouponType>
      <CouponValue>8</CouponValue>
      <FlatAmount>1</FlatAmount>
      <ForEachAmount>1</ForEachAmount>
      <IsActive>true</IsActive>
      <LicenseImageLocation>sample string 15</LicenseImageLocation>
      <LicenseNumber>sample string 14</LicenseNumber>
      <MerchantImageLocation>sample string 10</MerchantImageLocation>
      <MerchantMobile>sample string 11</MerchantMobile>
      <MerchantName>sample string 9</MerchantName>
      <MerchantPhoneNumber>sample string 13</MerchantPhoneNumber>
      <MerhantEmail>sample string 12</MerhantEmail>
      <RangeMax>1</RangeMax>
      <RangeMin>1</RangeMin>
      <Rate>1</Rate>
    </CouponDetailDto>
  </CouponList>
</CouponListResponse>