Api Home > ArticleCategory > Get

GET api/V3/ArticleCategory/Get?categoryId={categoryId} Returns breadcrumb heirarchy for article category

Request Information

URI Parameters

NameDescriptionTypeAdditional information
categoryId

GUID Id of the category at the end of the heirarchy

globally unique identifier

Required

Body Parameters

None.

Response Information

List of DisplayEnumeration objects

Resource Description

Collection of DisplayEnumeration
NameDescriptionTypeAdditional information
HierarchyLevel

integer

None.

HierarchyPath

string

None.

Id

globally unique identifier

None.

Name

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "902f7143-aae8-43c9-99c1-b6bf1dd865af",
    "Name": "sample string 1",
    "HierarchyLevel": 1,
    "HierarchyPath": "sample string 2"
  },
  {
    "Id": "902f7143-aae8-43c9-99c1-b6bf1dd865af",
    "Name": "sample string 1",
    "HierarchyLevel": 1,
    "HierarchyPath": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDisplayEnumeration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
  <DisplayEnumeration>
    <HierarchyLevel>1</HierarchyLevel>
    <HierarchyPath>sample string 2</HierarchyPath>
    <Id>902f7143-aae8-43c9-99c1-b6bf1dd865af</Id>
    <Name>sample string 1</Name>
  </DisplayEnumeration>
  <DisplayEnumeration>
    <HierarchyLevel>1</HierarchyLevel>
    <HierarchyPath>sample string 2</HierarchyPath>
    <Id>902f7143-aae8-43c9-99c1-b6bf1dd865af</Id>
    <Name>sample string 1</Name>
  </DisplayEnumeration>
</ArrayOfDisplayEnumeration>