GET /locations/{id}/children

List all Location's children

This endpoint allows you to get lower level locations of a specific Location.

The query parameters described below are to be used with the JQL.

Operation ID: getLocationChildren

lock This endpoint requires a Bearer token in the Authorization header.

Path Parameters

Name	Type	Description
`id` required path	string	The Location ID

Query Parameters

Name	Type	Description
`code` query	string	Filter results by given property value
`full_code` query	string	Filter results by given property value
`is_real` query	boolean	Filter results by given property value
`local_id` query	string	Filter results by given property value
`root_parent_id` query	string	Filter results by given property value
`with_assets_count` query	boolean	Include cumulative assets count for each location (includes all descendant locations)

Responses

data array<union>

id string required read-only

ID of the Location

type string required read-only

Model type

location

attributes object required

entity_id integer

name string required

Location name

full_name string required read-only

Names of the location's parents concatenated by hyphen with location name.

code string required

Location code.

full_code string required read-only

Codes of the location's parents concatenated by dot with location code.

original_full_code string | null read-only

Location original full code.

observation string | null required

Additional information

date_updated string | null required read-only

Example: 2021-07-21 18:38:00

parent_id integer

ID of the location parent.

root_parent_id integer read-only

ID of the location root parent (of `type` equals to `building`).

area number | null

Location area

glass_area number | null

Location glass area

volume number | null

Location volume

orientation string | null

Solar orientation (North, South, West, East)

is_from_network boolean read-only

If Location is from network

local_uuid string (uuid) read-only

Location UUID

assets_count integer | null read-only

Cumulative count of assets (equipment) in this location and all its descendants. Only present when `with_assets_count=true` query parameter is provided.

associations array<string>

List of ways the operator is associated with this building. Possible values are `DIRECT` (via a direct local-operator assignment), `TEAM` (via a team the operator belongs to), and `CLIENT` (via a client the operator is assigned to).

relationships object

building object

data object

type string read-only

building

id string read-only

files object

data array<object>

type string read-only

file

id string read-only

operators object

data array<object>

type string read-only

operator

id string read-only

localOrientation object

data array<object>

type string read-only

localOrientation

id string read-only

id string required read-only

ID of the Location

type string required read-only

Model type

location-folder

attributes object required

entity_id integer

name string required

Folder name

full_name string required read-only

Names of the location's parents concatenated by hyphen with location name.

code string required

Folder code.

full_code string required read-only

Codes of the Folder's parents concatenated by dot with Folder code.

original_full_code string | null read-only

Location original full code.

observation string | null required

Additional information

date_updated string (date-time) | null required read-only

Example: 2020-12-03T12:45:00.000Z

parent_id integer

ID of the Folder parent.

root_parent_id integer read-only

ID of the Folder root parent (of `type` equals to `building`).

is_from_network boolean read-only

If Folder is from network

assets_count integer | null read-only

Cumulative count of assets in this folder (including all nested locations). Only returned when `with_assets_count=true` query parameter is provided.

Example: 5

relationships object

building object

data object

type string read-only

building

id string read-only

included array<union>

List of relationships to be included

id string required read-only

ID of the Location

type string required read-only

Model type

location

attributes object required

entity_id integer

name string required

Location name

full_name string required read-only

Names of the location's parents concatenated by hyphen with location name.

code string required

Location code.

full_code string required read-only

Codes of the location's parents concatenated by dot with location code.

original_full_code string | null read-only

Location original full code.

observation string | null required

Additional information

date_updated string | null required read-only

Example: 2021-07-21 18:38:00

parent_id integer

ID of the location parent.

root_parent_id integer read-only

ID of the location root parent (of `type` equals to `building`).

area number | null

Location area

glass_area number | null

Location glass area

volume number | null

Location volume

orientation string | null

Solar orientation (North, South, West, East)

is_from_network boolean read-only

If Location is from network

local_uuid string (uuid) read-only

Location UUID

assets_count integer | null read-only

Cumulative count of assets (equipment) in this location and all its descendants. Only present when `with_assets_count=true` query parameter is provided.

associations array<string>

relationships object

building object

data object

type string read-only

building

id string read-only

files object

data array<object>

type string read-only

file

id string read-only

operators object

data array<object>

type string read-only

operator

id string read-only

localOrientation object

data array<object>

type string read-only

localOrientation

id string read-only

meta object

Meta model structure details

pagination object

total integer required

Total items.

Example: 1

count integer required

Total items returned for the current page.

Example: 1

per_page integer required

Maximum number of records per page.

Example: 1

current_page integer required

Number of the current page.

total_pages integer required

Number of the total pages.

links object

Requests that return multiple items include a `links` attribute, with links related to request's context.

self string required read-only

Current response link.

Example: /path?page=1

first string required read-only

Link to the first page result.

Example: /path?page=1

last string required read-only

Link to the previous page result.

Example: /path?page=1

next string read-only

Link to the next page result.

Example: /path?page=1

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info string

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

404

message string

Example: Resource not found

more_info string | null

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

Path Parameters

Pagination

check location

GET https://api.sandbox.infraspeak.com/v3/locations/{id}/children

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/locations/{id}/children' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/locations/{id}/children', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->get('https://api.sandbox.infraspeak.com/v3/locations/{id}/children');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/locations/{id}/children',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "string",
        "type": "location",
        "attributes": {
            "entity_id": 0,
            "name": "string",
            "full_name": "string",
            "code": "string",
            "full_code": "string",
            "original_full_code": "string",
            "observation": "string",
            "date_updated": "2021-07-21 18:38:00",
            "parent_id": 0,
            "root_parent_id": 0,
            "area": 0,
            "glass_area": 0,
            "volume": 0,
            "orientation": "string",
            "is_from_network": true,
            "local_uuid": "string",
            "assets_count": 0,
            "associations": []
        },
        "relationships": {
            "building": {
                "data": {
                    "type": "building",
                    "id": "string"
                }
            },
            "files": {
                "data": {
                    "type": "file",
                    "id": "string"
                }
            },
            "operators": {
                "data": {
                    "type": "operator",
                    "id": "string"
                }
            },
            "localOrientation": {
                "data": {
                    "type": "localOrientation",
                    "id": "string"
                }
            }
        }
    },
    "included": {
        "id": "string",
        "type": "location",
        "attributes": {
            "entity_id": 0,
            "name": "string",
            "full_name": "string",
            "code": "string",
            "full_code": "string",
            "original_full_code": "string",
            "observation": "string",
            "date_updated": "2021-07-21 18:38:00",
            "parent_id": 0,
            "root_parent_id": 0,
            "area": 0,
            "glass_area": 0,
            "volume": 0,
            "orientation": "string",
            "is_from_network": true,
            "local_uuid": "string",
            "assets_count": 0,
            "associations": []
        },
        "relationships": {
            "building": {
                "data": {
                    "type": "building",
                    "id": "string"
                }
            },
            "files": {
                "data": {
                    "type": "file",
                    "id": "string"
                }
            },
            "operators": {
                "data": {
                    "type": "operator",
                    "id": "string"
                }
            },
            "localOrientation": {
                "data": {
                    "type": "localOrientation",
                    "id": "string"
                }
            }
        }
    },
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 1,
            "current_page": 0,
            "total_pages": 0
        }
    },
    "links": {
        "self": "/path?page=1",
        "first": "/path?page=1",
        "last": "/path?page=1",
        "next": "/path?page=1"
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

404 Resource Not Found. Requests to resources that don't exist or are malformed.

{
    "status": "error",
    "error": {
        "http_code": 404,
        "message": "Resource not found",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}