POST api/Syndication/GetDealerCategories

Gets all the categories for a dealer that has brands they are authorized to sell. Authorization required.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SiteKey		string	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteKey": "sample string 1"
}

application/xml, text/xml

Sample:

<RequestCategoryList 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>
</RequestCategoryList>

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 'RequestCategoryList'.

Response Information

Resource Description

ResponseCategoryList

Name	Type	Additional information
Categories	Collection of jCategory	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Categories": [
    {
      "SubCategories": [
        {
          "SubCategoryID": "sample string 1",
          "SubCategoryName": "sample string 2",
          "ImageUrl": "sample string 3",
          "Sort": 4
        },
        {
          "SubCategoryID": "sample string 1",
          "SubCategoryName": "sample string 2",
          "ImageUrl": "sample string 3",
          "Sort": 4
        }
      ],
      "CategoryID": "sample string 1",
      "CategoryName": "sample string 2",
      "ImageUrl": "sample string 3",
      "Sort": 4
    },
    {
      "SubCategories": [
        {
          "SubCategoryID": "sample string 1",
          "SubCategoryName": "sample string 2",
          "ImageUrl": "sample string 3",
          "Sort": 4
        },
        {
          "SubCategoryID": "sample string 1",
          "SubCategoryName": "sample string 2",
          "ImageUrl": "sample string 3",
          "Sort": 4
        }
      ],
      "CategoryID": "sample string 1",
      "CategoryName": "sample string 2",
      "ImageUrl": "sample string 3",
      "Sort": 4
    }
  ],
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseCategoryList 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>
  <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Catalog">
    <d2p1:jCategory>
      <d2p1:CategoryID>sample string 1</d2p1:CategoryID>
      <d2p1:CategoryName>sample string 2</d2p1:CategoryName>
      <d2p1:ImageUrl>sample string 3</d2p1:ImageUrl>
      <d2p1:Sort>4</d2p1:Sort>
      <d2p1:SubCategories>
        <d2p1:jSubCategory>
          <d2p1:ImageUrl>sample string 3</d2p1:ImageUrl>
          <d2p1:Sort>4</d2p1:Sort>
          <d2p1:SubCategoryID>sample string 1</d2p1:SubCategoryID>
          <d2p1:SubCategoryName>sample string 2</d2p1:SubCategoryName>
        </d2p1:jSubCategory>
        <d2p1:jSubCategory>
          <d2p1:ImageUrl>sample string 3</d2p1:ImageUrl>
          <d2p1:Sort>4</d2p1:Sort>
          <d2p1:SubCategoryID>sample string 1</d2p1:SubCategoryID>
          <d2p1:SubCategoryName>sample string 2</d2p1:SubCategoryName>
        </d2p1:jSubCategory>
      </d2p1:SubCategories>
    </d2p1:jCategory>
    <d2p1:jCategory>
      <d2p1:CategoryID>sample string 1</d2p1:CategoryID>
      <d2p1:CategoryName>sample string 2</d2p1:CategoryName>
      <d2p1:ImageUrl>sample string 3</d2p1:ImageUrl>
      <d2p1:Sort>4</d2p1:Sort>
      <d2p1:SubCategories>
        <d2p1:jSubCategory>
          <d2p1:ImageUrl>sample string 3</d2p1:ImageUrl>
          <d2p1:Sort>4</d2p1:Sort>
          <d2p1:SubCategoryID>sample string 1</d2p1:SubCategoryID>
          <d2p1:SubCategoryName>sample string 2</d2p1:SubCategoryName>
        </d2p1:jSubCategory>
        <d2p1:jSubCategory>
          <d2p1:ImageUrl>sample string 3</d2p1:ImageUrl>
          <d2p1:Sort>4</d2p1:Sort>
          <d2p1:SubCategoryID>sample string 1</d2p1:SubCategoryID>
          <d2p1:SubCategoryName>sample string 2</d2p1:SubCategoryName>
        </d2p1:jSubCategory>
      </d2p1:SubCategories>
    </d2p1:jCategory>
  </Categories>
</ResponseCategoryList>