GET api/Categories/All

Retrieves a class collection of all categories, both top-level and child.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsCategory

Name	Description	Type	Additional information
Eskimo_Category_ID		string	None.
ParentID	The Eskimo ID of the parent Category. Returns (null) if a top-level category.	string	None.
ShortDescription		string	None.
LongDescription		string	None.
OrderByValue	An integer value which can be used to specify the order the categories are displayed in	integer	None.
Web_ID	This is the Primary Key that the website is using for this category. Call the UpdateCartIDs method to set these values	string	None.
Product_Count	The number of products linked to this category	integer	None.
Channel_ID	The Sales Channel (Website) that the category is linked to. See api/Sales/Channels	integer	None.
URL_Path	A url category path.	string	None.
URL_Path_Component	A friendly-url representation of the category name	string	None.
Status	The current status of category	EskimoClassLibraries.clsCategory+CategoryStatusEnum	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Eskimo_Category_ID": "sample string 1",
    "ParentID": "sample string 2",
    "ShortDescription": "sample string 3",
    "LongDescription": "sample string 4",
    "OrderByValue": 5,
    "Web_ID": "sample string 6",
    "Product_Count": 7,
    "Channel_ID": 8,
    "URL_Path": "sample string 9",
    "URL_Path_Component": "sample string 10",
    "Status": 1
  },
  {
    "Eskimo_Category_ID": "sample string 1",
    "ParentID": "sample string 2",
    "ShortDescription": "sample string 3",
    "LongDescription": "sample string 4",
    "OrderByValue": 5,
    "Web_ID": "sample string 6",
    "Product_Count": 7,
    "Channel_ID": 8,
    "URL_Path": "sample string 9",
    "URL_Path_Component": "sample string 10",
    "Status": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsCategory>
    <Channel_ID>8</Channel_ID>
    <Eskimo_Category_ID>sample string 1</Eskimo_Category_ID>
    <LongDescription>sample string 4</LongDescription>
    <OrderByValue>5</OrderByValue>
    <ParentID>sample string 2</ParentID>
    <Product_Count>7</Product_Count>
    <ShortDescription>sample string 3</ShortDescription>
    <Status>Disabled</Status>
    <URL_Path>sample string 9</URL_Path>
    <URL_Path_Component>sample string 10</URL_Path_Component>
    <Web_ID>sample string 6</Web_ID>
  </clsCategory>
  <clsCategory>
    <Channel_ID>8</Channel_ID>
    <Eskimo_Category_ID>sample string 1</Eskimo_Category_ID>
    <LongDescription>sample string 4</LongDescription>
    <OrderByValue>5</OrderByValue>
    <ParentID>sample string 2</ParentID>
    <Product_Count>7</Product_Count>
    <ShortDescription>sample string 3</ShortDescription>
    <Status>Disabled</Status>
    <URL_Path>sample string 9</URL_Path>
    <URL_Path_Component>sample string 10</URL_Path_Component>
    <Web_ID>sample string 6</Web_ID>
  </clsCategory>
</ArrayOfclsCategory>