Skip to main content
POST
/
t
/
v1
/
network-hierarchy
Get the Network Hierarchy
curl --request POST \
  --url https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "scope": "main",
  "sort_by_association": true
}
'
{
  "hierarchy": {
    "roots": [
      {
        "children": [
          {
            "children": [
              {
                "children": [
                  {
                    "children": [],
                    "region": {
                      "attributes": {
                        "is_virtual": "Yes"
                      },
                      "groupingId": "1234",
                      "groupingType": "track",
                      "legacyGroupingId": "123",
                      "name": "Track 1",
                      "sortOrder": 0
                    }
                  }
                ],
                "region": {
                  "attributes": {},
                  "groupingId": "789",
                  "groupingType": "station",
                  "legacyGroupingId": "789",
                  "name": "Station 1",
                  "sortOrder": 10
                }
              }
            ],
            "region": {
              "attributes": {},
              "groupingId": "456",
              "groupingType": "area",
              "legacyGroupingId": "456",
              "name": "Area 1",
              "sortOrder": 10
            }
          }
        ],
        "region": {
          "attributes": {},
          "groupingId": "12345",
          "groupingType": "road",
          "legacyGroupingId": "123",
          "name": "ABC",
          "sortOrder": 0
        }
      }
    ],
    "scope": "main"
  }
}

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID

Body

application/json

Request message for retrieving the carrier network hierarchy.

Request message for retrieving the carrier network hierarchy.

scope
string
sortByAssociation
boolean

Response

A successful response.

hierarchy
object