GET api/catalogs/{catalogName}/categories

Returns all categories in the catalog.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
catalogName

Catalog name.

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ProductCategory
NameDescriptionTypeAdditional information
Id

ID of the group item in PDB.

integer

None.

Code

Internal group name or code.

string

None.

Name

Public friendly name of the group.

string

None.

UrlSegment

URL-friendly group name equivalent.

string

None.

Language

Group language.

string

None.

SortOrder

Sort order of this group in listings.

integer

None.

ParentCode

Code of parent group

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "urlSegment": "sample string 4",
    "language": "sample string 5",
    "sortOrder": 6,
    "parentCode": "sample string 7"
  },
  {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "urlSegment": "sample string 4",
    "language": "sample string 5",
    "sortOrder": 6,
    "parentCode": "sample string 7"
  }
]

application/xml, text/xml

Sample:
<ArrayOfProductCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PDB.Api.Models">
  <ProductCategory>
    <Code>sample string 2</Code>
    <Id>1</Id>
    <Language>sample string 5</Language>
    <Name>sample string 3</Name>
    <ParentCode>sample string 7</ParentCode>
    <SortOrder>6</SortOrder>
    <UrlSegment>sample string 4</UrlSegment>
  </ProductCategory>
  <ProductCategory>
    <Code>sample string 2</Code>
    <Id>1</Id>
    <Language>sample string 5</Language>
    <Name>sample string 3</Name>
    <ParentCode>sample string 7</ParentCode>
    <SortOrder>6</SortOrder>
    <UrlSegment>sample string 4</UrlSegment>
  </ProductCategory>
</ArrayOfProductCategory>