GET api/ProductGroups/GetAll

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsProductGroup
NameDescriptionTypeAdditional information
ID

Unique ID per grouping level - so there can be two IDs of 5 - one in Grouping Level 1 and another in 2.

integer

Required

GroupingLevel

The nest-level within the hierarchy. Groups contains an array of Departments underneath.

EskimoClassLibraries.clsProductGroup+GroupingLevelEnum

Required

InternalDescription

string

Required

String length: inclusive between 0 and 50

WebTitle

string

String length: inclusive between 0 and 50

WebDescription

string

String length: inclusive between 0 and 4000

ParentID

Only applicable where the GroupingLevel = Department. This links to the ID of the Group above.

integer

None.

OrderBy

The order in which the groups appear when displayed in lists

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "GroupingLevel": 1,
    "InternalDescription": "sample string 2",
    "WebTitle": "sample string 3",
    "WebDescription": "sample string 4",
    "ParentID": 1,
    "OrderBy": 5
  },
  {
    "ID": 1,
    "GroupingLevel": 1,
    "InternalDescription": "sample string 2",
    "WebTitle": "sample string 3",
    "WebDescription": "sample string 4",
    "ParentID": 1,
    "OrderBy": 5
  }
]

application/xml, text/xml

Sample:
<ArrayOfclsProductGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsProductGroup>
    <GroupingLevel>GroupLevel</GroupingLevel>
    <ID>1</ID>
    <InternalDescription>sample string 2</InternalDescription>
    <OrderBy>5</OrderBy>
    <ParentID>1</ParentID>
    <WebDescription>sample string 4</WebDescription>
    <WebTitle>sample string 3</WebTitle>
  </clsProductGroup>
  <clsProductGroup>
    <GroupingLevel>GroupLevel</GroupingLevel>
    <ID>1</ID>
    <InternalDescription>sample string 2</InternalDescription>
    <OrderBy>5</OrderBy>
    <ParentID>1</ParentID>
    <WebDescription>sample string 4</WebDescription>
    <WebTitle>sample string 3</WebTitle>
  </clsProductGroup>
</ArrayOfclsProductGroup>