GET categories

Retrieves the categories available for filtering/searching products.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The categories.

Collection of Category

Name	Description	Type	Additional information
CategoryId	Gets or sets the unique idenfitier for this category.	integer	None.
ParentId	Gets or sets the unique identifier of the parent to this category.	integer	None.
BrandId	Gets or sets the unique identifier for the brand.	integer	None.
Name	Gets or sets the display name of the category.	string	None.
Description	Gets or sets the description.	string	None.
IsRoot	Gets or sets a value indicating whether this category is the root.	boolean	None.
IsLeaf	Gets or sets a value indicating whether this category is a leaf.	boolean	None.
DisplayCategory	Gets or sets a value indicating whether this category is displayable.	boolean	None.
DefaultDisplayCategory	Gets or sets a value indicating whether this category is the default display category.	boolean	None.
IsColorwayCategory	Gets or setes a value indicating whether this category is a colorway category.	boolean	None.
Children	Gets or sets the list holding the child categories.	Collection of Category	None.
SortOrder	Gets or sets the sort order of the category.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "categoryId": 1,
    "parentId": 2,
    "brandId": 3,
    "name": "sample string 4",
    "description": "sample string 5",
    "isRoot": true,
    "isLeaf": true,
    "displayCategory": true,
    "defaultDisplayCategory": true,
    "isColorwayCategory": true,
    "children": [],
    "sortOrder": 11
  },
  {
    "categoryId": 1,
    "parentId": 2,
    "brandId": 3,
    "name": "sample string 4",
    "description": "sample string 5",
    "isRoot": true,
    "isLeaf": true,
    "displayCategory": true,
    "defaultDisplayCategory": true,
    "isColorwayCategory": true,
    "children": [],
    "sortOrder": 11
  }
]

application/xml, text/xml

Sample:

<ArrayOfCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tricycle.Studio.Api.Catalog.Models">
  <Category z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
    <BrandId>3</BrandId>
    <CategoryId>1</CategoryId>
    <Children>
      <Category z:Ref="i1" />
      <Category z:Ref="i1" />
    </Children>
    <DefaultDisplayCategory>true</DefaultDisplayCategory>
    <Description>sample string 5</Description>
    <DisplayCategory>true</DisplayCategory>
    <IsColorwayCategory>true</IsColorwayCategory>
    <IsLeaf>true</IsLeaf>
    <IsRoot>true</IsRoot>
    <Name>sample string 4</Name>
    <ParentId>2</ParentId>
    <SortOrder>11</SortOrder>
  </Category>
  <Category z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />
</ArrayOfCategory>

text/html

Sample:

Sample not available.