POST api/Syndication/GetCouponList

Returns a list of active coupons eligible for the brands the dealer carries. Authorization required. Messaging tailored to dealer's brands.

Request Information

URI Parameters

None.

Body Parameters

RequestCouponList

Name	Description	Type	Additional information
SiteKey		string	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteKey": "sample string 1"
}

application/xml, text/xml

Sample:

<RequestCouponList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Request">
  <SiteKey>sample string 1</SiteKey>
</RequestCouponList>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestCouponList'.

Response Information

Resource Description

ResponseCouponList

Name	Type	Additional information
Coupons	Collection of jCoupon	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Coupons": [
    {
      "ID": "sample string 1",
      "CampaignID": "sample string 2",
      "Title": "sample string 3",
      "Description": "sample string 4",
      "PrimaryImage": "sample string 5",
      "Disclaimer": "sample string 6",
      "DynamicDisclaimer": "sample string 7",
      "Country": "sample string 8",
      "EligibleBrands": [
        {
          "BrandCode": "sample string 1",
          "BrandName": "sample string 2"
        },
        {
          "BrandCode": "sample string 1",
          "BrandName": "sample string 2"
        }
      ],
      "EligibleCategories": [
        {
          "CategoryId": "sample string 1",
          "CategoryName": "sample string 2"
        },
        {
          "CategoryId": "sample string 1",
          "CategoryName": "sample string 2"
        }
      ],
      "EligibleSubcategories": [
        {
          "SubCategoryId": "sample string 1",
          "SubcategoryName": "sample string 2"
        },
        {
          "SubCategoryId": "sample string 1",
          "SubcategoryName": "sample string 2"
        }
      ],
      "EligibleProducts": [
        {
          "ProductId": "sample string 1",
          "ProductName": "sample string 2"
        },
        {
          "ProductId": "sample string 1",
          "ProductName": "sample string 2"
        }
      ],
      "TieredMessages": [
        {
          "BrandCode": "sample string 1",
          "OfferTierPriority": 2,
          "Title": "sample string 3",
          "Description": "sample string 4",
          "BrandDisclaimer": "sample string 5",
          "BrandImage": "sample string 6"
        },
        {
          "BrandCode": "sample string 1",
          "OfferTierPriority": 2,
          "Title": "sample string 3",
          "Description": "sample string 4",
          "BrandDisclaimer": "sample string 5",
          "BrandImage": "sample string 6"
        }
      ]
    },
    {
      "ID": "sample string 1",
      "CampaignID": "sample string 2",
      "Title": "sample string 3",
      "Description": "sample string 4",
      "PrimaryImage": "sample string 5",
      "Disclaimer": "sample string 6",
      "DynamicDisclaimer": "sample string 7",
      "Country": "sample string 8",
      "EligibleBrands": [
        {
          "BrandCode": "sample string 1",
          "BrandName": "sample string 2"
        },
        {
          "BrandCode": "sample string 1",
          "BrandName": "sample string 2"
        }
      ],
      "EligibleCategories": [
        {
          "CategoryId": "sample string 1",
          "CategoryName": "sample string 2"
        },
        {
          "CategoryId": "sample string 1",
          "CategoryName": "sample string 2"
        }
      ],
      "EligibleSubcategories": [
        {
          "SubCategoryId": "sample string 1",
          "SubcategoryName": "sample string 2"
        },
        {
          "SubCategoryId": "sample string 1",
          "SubcategoryName": "sample string 2"
        }
      ],
      "EligibleProducts": [
        {
          "ProductId": "sample string 1",
          "ProductName": "sample string 2"
        },
        {
          "ProductId": "sample string 1",
          "ProductName": "sample string 2"
        }
      ],
      "TieredMessages": [
        {
          "BrandCode": "sample string 1",
          "OfferTierPriority": 2,
          "Title": "sample string 3",
          "Description": "sample string 4",
          "BrandDisclaimer": "sample string 5",
          "BrandImage": "sample string 6"
        },
        {
          "BrandCode": "sample string 1",
          "OfferTierPriority": 2,
          "Title": "sample string 3",
          "Description": "sample string 4",
          "BrandDisclaimer": "sample string 5",
          "BrandImage": "sample string 6"
        }
      ]
    }
  ],
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseCouponList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Response">
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Coupons xmlns:d2p1="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Catalog">
    <d2p1:jCoupon>
      <d2p1:CampaignID>sample string 2</d2p1:CampaignID>
      <d2p1:Country>sample string 8</d2p1:Country>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Disclaimer>sample string 6</d2p1:Disclaimer>
      <d2p1:DynamicDisclaimer>sample string 7</d2p1:DynamicDisclaimer>
      <d2p1:EligibleBrands>
        <d2p1:jCouponBrand>
          <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
          <d2p1:BrandName>sample string 2</d2p1:BrandName>
        </d2p1:jCouponBrand>
        <d2p1:jCouponBrand>
          <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
          <d2p1:BrandName>sample string 2</d2p1:BrandName>
        </d2p1:jCouponBrand>
      </d2p1:EligibleBrands>
      <d2p1:EligibleCategories>
        <d2p1:jCouponCategory>
          <d2p1:CategoryId>sample string 1</d2p1:CategoryId>
          <d2p1:CategoryName>sample string 2</d2p1:CategoryName>
        </d2p1:jCouponCategory>
        <d2p1:jCouponCategory>
          <d2p1:CategoryId>sample string 1</d2p1:CategoryId>
          <d2p1:CategoryName>sample string 2</d2p1:CategoryName>
        </d2p1:jCouponCategory>
      </d2p1:EligibleCategories>
      <d2p1:EligibleProducts>
        <d2p1:jCouponProduct>
          <d2p1:ProductId>sample string 1</d2p1:ProductId>
          <d2p1:ProductName>sample string 2</d2p1:ProductName>
        </d2p1:jCouponProduct>
        <d2p1:jCouponProduct>
          <d2p1:ProductId>sample string 1</d2p1:ProductId>
          <d2p1:ProductName>sample string 2</d2p1:ProductName>
        </d2p1:jCouponProduct>
      </d2p1:EligibleProducts>
      <d2p1:EligibleSubcategories>
        <d2p1:jCouponSubcategory>
          <d2p1:SubCategoryId>sample string 1</d2p1:SubCategoryId>
          <d2p1:SubcategoryName>sample string 2</d2p1:SubcategoryName>
        </d2p1:jCouponSubcategory>
        <d2p1:jCouponSubcategory>
          <d2p1:SubCategoryId>sample string 1</d2p1:SubCategoryId>
          <d2p1:SubcategoryName>sample string 2</d2p1:SubcategoryName>
        </d2p1:jCouponSubcategory>
      </d2p1:EligibleSubcategories>
      <d2p1:ID>sample string 1</d2p1:ID>
      <d2p1:PrimaryImage>sample string 5</d2p1:PrimaryImage>
      <d2p1:TieredMessages>
        <d2p1:jCouponTieredMessage>
          <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
          <d2p1:BrandDisclaimer>sample string 5</d2p1:BrandDisclaimer>
          <d2p1:BrandImage>sample string 6</d2p1:BrandImage>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:OfferTierPriority>2</d2p1:OfferTierPriority>
          <d2p1:Title>sample string 3</d2p1:Title>
        </d2p1:jCouponTieredMessage>
        <d2p1:jCouponTieredMessage>
          <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
          <d2p1:BrandDisclaimer>sample string 5</d2p1:BrandDisclaimer>
          <d2p1:BrandImage>sample string 6</d2p1:BrandImage>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:OfferTierPriority>2</d2p1:OfferTierPriority>
          <d2p1:Title>sample string 3</d2p1:Title>
        </d2p1:jCouponTieredMessage>
      </d2p1:TieredMessages>
      <d2p1:Title>sample string 3</d2p1:Title>
    </d2p1:jCoupon>
    <d2p1:jCoupon>
      <d2p1:CampaignID>sample string 2</d2p1:CampaignID>
      <d2p1:Country>sample string 8</d2p1:Country>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Disclaimer>sample string 6</d2p1:Disclaimer>
      <d2p1:DynamicDisclaimer>sample string 7</d2p1:DynamicDisclaimer>
      <d2p1:EligibleBrands>
        <d2p1:jCouponBrand>
          <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
          <d2p1:BrandName>sample string 2</d2p1:BrandName>
        </d2p1:jCouponBrand>
        <d2p1:jCouponBrand>
          <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
          <d2p1:BrandName>sample string 2</d2p1:BrandName>
        </d2p1:jCouponBrand>
      </d2p1:EligibleBrands>
      <d2p1:EligibleCategories>
        <d2p1:jCouponCategory>
          <d2p1:CategoryId>sample string 1</d2p1:CategoryId>
          <d2p1:CategoryName>sample string 2</d2p1:CategoryName>
        </d2p1:jCouponCategory>
        <d2p1:jCouponCategory>
          <d2p1:CategoryId>sample string 1</d2p1:CategoryId>
          <d2p1:CategoryName>sample string 2</d2p1:CategoryName>
        </d2p1:jCouponCategory>
      </d2p1:EligibleCategories>
      <d2p1:EligibleProducts>
        <d2p1:jCouponProduct>
          <d2p1:ProductId>sample string 1</d2p1:ProductId>
          <d2p1:ProductName>sample string 2</d2p1:ProductName>
        </d2p1:jCouponProduct>
        <d2p1:jCouponProduct>
          <d2p1:ProductId>sample string 1</d2p1:ProductId>
          <d2p1:ProductName>sample string 2</d2p1:ProductName>
        </d2p1:jCouponProduct>
      </d2p1:EligibleProducts>
      <d2p1:EligibleSubcategories>
        <d2p1:jCouponSubcategory>
          <d2p1:SubCategoryId>sample string 1</d2p1:SubCategoryId>
          <d2p1:SubcategoryName>sample string 2</d2p1:SubcategoryName>
        </d2p1:jCouponSubcategory>
        <d2p1:jCouponSubcategory>
          <d2p1:SubCategoryId>sample string 1</d2p1:SubCategoryId>
          <d2p1:SubcategoryName>sample string 2</d2p1:SubcategoryName>
        </d2p1:jCouponSubcategory>
      </d2p1:EligibleSubcategories>
      <d2p1:ID>sample string 1</d2p1:ID>
      <d2p1:PrimaryImage>sample string 5</d2p1:PrimaryImage>
      <d2p1:TieredMessages>
        <d2p1:jCouponTieredMessage>
          <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
          <d2p1:BrandDisclaimer>sample string 5</d2p1:BrandDisclaimer>
          <d2p1:BrandImage>sample string 6</d2p1:BrandImage>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:OfferTierPriority>2</d2p1:OfferTierPriority>
          <d2p1:Title>sample string 3</d2p1:Title>
        </d2p1:jCouponTieredMessage>
        <d2p1:jCouponTieredMessage>
          <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
          <d2p1:BrandDisclaimer>sample string 5</d2p1:BrandDisclaimer>
          <d2p1:BrandImage>sample string 6</d2p1:BrandImage>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:OfferTierPriority>2</d2p1:OfferTierPriority>
          <d2p1:Title>sample string 3</d2p1:Title>
        </d2p1:jCouponTieredMessage>
      </d2p1:TieredMessages>
      <d2p1:Title>sample string 3</d2p1:Title>
    </d2p1:jCoupon>
  </Coupons>
</ResponseCouponList>