GET api/filters/categories

V2 - This method retrieves the available categories for the specified vendorkey.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of categoryFilters

Collection of CategoryDetails
NameDescriptionTypeAdditional information
ID

The internal ID for this category.

integer

Required

Name

The name for this category.

string

Required

Description

The description for this category.

string

Required

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3"
  },
  {
    "ID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3"
  }
]

text/javascript

Sample:
[{"ID":1,"Name":"sample string 2","Description":"sample string 3"},{"ID":1,"Name":"sample string 2","Description":"sample string 3"}]

application/xml, text/xml

Sample:
<ArrayOfCategoryDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
  <CategoryDetails>
    <Description>sample string 3</Description>
    <ID>1</ID>
    <Name>sample string 2</Name>
  </CategoryDetails>
  <CategoryDetails>
    <Description>sample string 3</Description>
    <ID>1</ID>
    <Name>sample string 2</Name>
  </CategoryDetails>
</ArrayOfCategoryDetails>