Hierarchy Service
getHierarchyDetailsV2
Retrieve the details of a specific hierarchy.
get/hierarchy/v2/getHierarchyDetails
Query parameters
hierarchyTypestring required
Hierarchy type to retrieve.
levelNumberstring
Hierarchy level to retrieve.
parentLogicalNamestring
Hierarchy parent to retrieve.
includeNullboolean
Specify 'true' to output null data elements.
Headers
authenticationtokenstring required
Secure token for API authentication.
passwordstring
Password for the Crunchtime Application User.
sitenamestring required
Crunchtime site identifier. (test or production)
useridstring
User ID for the Crunchtime Application User.
X-B3-TraceIdstring
Optional trace identifier for troubleshooting.
Response
Success
Example response
{
"hierarchyType": "000000",
"levels": [
{
"levelDescription": "Regions",
"levelName": "Reg",
"levelNumber": 2
}
],
"locationCode": "RTest Hierarchy 1",
"locations": [
{
"levelDescription": "Regions",
"levelName": "Regions",
"levelNumber": 2,
"locationCode": "300004",
"logicalName": "Northeast",
"parentLogicalName": "Corporate"
}
]
}