Headers
Carrier ID
Body
application/json
Request message for retrieving the carrier network hierarchy.
Response
A successful response.
Get the Carrier Network as a hierarchical tree structure.
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 '{}'{
"hierarchy": {
"scope": "main",
"roots": [
{
"region": {
"groupingId": "12345",
"groupingType": "road",
"name": "ABC",
"sortOrder": 0,
"attributes": {},
"legacyGroupingId": "123"
},
"children": [
{
"region": {
"groupingId": "456",
"groupingType": "area",
"name": "Area 1",
"sortOrder": 10,
"attributes": {},
"legacyGroupingId": "456"
},
"children": [
{
"region": {
"groupingId": "789",
"groupingType": "station",
"name": "Station 1",
"sortOrder": 10,
"attributes": {},
"legacyGroupingId": "789"
},
"children": [
{
"region": {
"groupingId": "1234",
"groupingType": "track",
"name": "Track 1",
"sortOrder": 0,
"attributes": {
"is_virtual": "Yes"
},
"legacyGroupingId": "123"
},
"children": []
}
]
}
]
}
]
}
]
}
}Carrier ID
Request message for retrieving the carrier network hierarchy.
A successful response.
Show child attributes
Was this page helpful?
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 '{}'{
"hierarchy": {
"scope": "main",
"roots": [
{
"region": {
"groupingId": "12345",
"groupingType": "road",
"name": "ABC",
"sortOrder": 0,
"attributes": {},
"legacyGroupingId": "123"
},
"children": [
{
"region": {
"groupingId": "456",
"groupingType": "area",
"name": "Area 1",
"sortOrder": 10,
"attributes": {},
"legacyGroupingId": "456"
},
"children": [
{
"region": {
"groupingId": "789",
"groupingType": "station",
"name": "Station 1",
"sortOrder": 10,
"attributes": {},
"legacyGroupingId": "789"
},
"children": [
{
"region": {
"groupingId": "1234",
"groupingType": "track",
"name": "Track 1",
"sortOrder": 0,
"attributes": {
"is_virtual": "Yes"
},
"legacyGroupingId": "123"
},
"children": []
}
]
}
]
}
]
}
]
}
}