POST api/Syndication/GetCategoryFilterList

A list of filters for the specified category. Used by "GetProductFilter". Authorization required.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CategorySubcategoryId	Can be either a category or a subcategory	string	None.
SiteKey		string	None.

Request Formats

application/json, text/json

Sample:

{
  "CategorySubcategoryId": "sample string 1",
  "SiteKey": "sample string 2"
}

application/xml, text/xml

Sample:

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

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

Response Information

Resource Description

ResponseCategoryFilterList

Name	Type	Additional information
Filters	Collection of jFilterColumn	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Filters": [
    {
      "Options": [
        {
          "FilterOptionID": "sample string 1",
          "Title": "sample string 2",
          "Value": "sample string 3",
          "FilterOptionName": "sample string 4",
          "DisplayText": "sample string 5",
          "Sort": 6,
          "FilterOptionSelectorCSS": "sample string 7"
        },
        {
          "FilterOptionID": "sample string 1",
          "Title": "sample string 2",
          "Value": "sample string 3",
          "FilterOptionName": "sample string 4",
          "DisplayText": "sample string 5",
          "Sort": 6,
          "FilterOptionSelectorCSS": "sample string 7"
        }
      ],
      "ColumnID": "sample string 1",
      "ColumnName": "sample string 2",
      "ColumnValue": "sample string 3",
      "DisplayText": "sample string 4",
      "Sort": 5
    },
    {
      "Options": [
        {
          "FilterOptionID": "sample string 1",
          "Title": "sample string 2",
          "Value": "sample string 3",
          "FilterOptionName": "sample string 4",
          "DisplayText": "sample string 5",
          "Sort": 6,
          "FilterOptionSelectorCSS": "sample string 7"
        },
        {
          "FilterOptionID": "sample string 1",
          "Title": "sample string 2",
          "Value": "sample string 3",
          "FilterOptionName": "sample string 4",
          "DisplayText": "sample string 5",
          "Sort": 6,
          "FilterOptionSelectorCSS": "sample string 7"
        }
      ],
      "ColumnID": "sample string 1",
      "ColumnName": "sample string 2",
      "ColumnValue": "sample string 3",
      "DisplayText": "sample string 4",
      "Sort": 5
    }
  ],
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseCategoryFilterList 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>
  <Filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Catalog">
    <d2p1:jFilterColumn>
      <d2p1:ColumnID>sample string 1</d2p1:ColumnID>
      <d2p1:ColumnName>sample string 2</d2p1:ColumnName>
      <d2p1:ColumnValue>sample string 3</d2p1:ColumnValue>
      <d2p1:DisplayText>sample string 4</d2p1:DisplayText>
      <d2p1:Options>
        <d2p1:jFilterOption>
          <d2p1:DisplayText>sample string 5</d2p1:DisplayText>
          <d2p1:FilterOptionID>sample string 1</d2p1:FilterOptionID>
          <d2p1:FilterOptionName>sample string 4</d2p1:FilterOptionName>
          <d2p1:FilterOptionSelectorCSS>sample string 7</d2p1:FilterOptionSelectorCSS>
          <d2p1:Sort>6</d2p1:Sort>
          <d2p1:Title>sample string 2</d2p1:Title>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:jFilterOption>
        <d2p1:jFilterOption>
          <d2p1:DisplayText>sample string 5</d2p1:DisplayText>
          <d2p1:FilterOptionID>sample string 1</d2p1:FilterOptionID>
          <d2p1:FilterOptionName>sample string 4</d2p1:FilterOptionName>
          <d2p1:FilterOptionSelectorCSS>sample string 7</d2p1:FilterOptionSelectorCSS>
          <d2p1:Sort>6</d2p1:Sort>
          <d2p1:Title>sample string 2</d2p1:Title>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:jFilterOption>
      </d2p1:Options>
      <d2p1:Sort>5</d2p1:Sort>
    </d2p1:jFilterColumn>
    <d2p1:jFilterColumn>
      <d2p1:ColumnID>sample string 1</d2p1:ColumnID>
      <d2p1:ColumnName>sample string 2</d2p1:ColumnName>
      <d2p1:ColumnValue>sample string 3</d2p1:ColumnValue>
      <d2p1:DisplayText>sample string 4</d2p1:DisplayText>
      <d2p1:Options>
        <d2p1:jFilterOption>
          <d2p1:DisplayText>sample string 5</d2p1:DisplayText>
          <d2p1:FilterOptionID>sample string 1</d2p1:FilterOptionID>
          <d2p1:FilterOptionName>sample string 4</d2p1:FilterOptionName>
          <d2p1:FilterOptionSelectorCSS>sample string 7</d2p1:FilterOptionSelectorCSS>
          <d2p1:Sort>6</d2p1:Sort>
          <d2p1:Title>sample string 2</d2p1:Title>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:jFilterOption>
        <d2p1:jFilterOption>
          <d2p1:DisplayText>sample string 5</d2p1:DisplayText>
          <d2p1:FilterOptionID>sample string 1</d2p1:FilterOptionID>
          <d2p1:FilterOptionName>sample string 4</d2p1:FilterOptionName>
          <d2p1:FilterOptionSelectorCSS>sample string 7</d2p1:FilterOptionSelectorCSS>
          <d2p1:Sort>6</d2p1:Sort>
          <d2p1:Title>sample string 2</d2p1:Title>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:jFilterOption>
      </d2p1:Options>
      <d2p1:Sort>5</d2p1:Sort>
    </d2p1:jFilterColumn>
  </Filters>
</ResponseCategoryFilterList>