Network Structure API
Get the Network Hierarchy
Get the Carrier Network as a hierarchical tree structure.
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
}
'import requests
url = "https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy"
payload = {
"scope": "main",
"sort_by_association": True
}
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({scope: 'main', sort_by_association: true})
};
fetch('https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scope' => 'main',
'sort_by_association' => true
]),
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy"
payload := strings.NewReader("{\n \"scope\": \"main\",\n \"sort_by_association\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"main\",\n \"sort_by_association\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"main\",\n \"sort_by_association\": true\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Headers
Carrier ID
Body
application/json
Request message for retrieving the carrier network hierarchy.
Response
A successful response.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
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
}
'import requests
url = "https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy"
payload = {
"scope": "main",
"sort_by_association": True
}
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({scope: 'main', sort_by_association: true})
};
fetch('https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scope' => 'main',
'sort_by_association' => true
]),
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy"
payload := strings.NewReader("{\n \"scope\": \"main\",\n \"sort_by_association\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"main\",\n \"sort_by_association\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k-h1.arms.cedarai.com/t/v1/network-hierarchy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"main\",\n \"sort_by_association\": true\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}