Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Location

Get location tree

Get location hierarchical tree.

get/locations/tree

Query parameters

parentIdinteger

The parent location ID, return root locations if parent is null

expandChildrenboolean

Whether to return the child locations recursively, default is true. Set it to false to improve performance when there are a lot of child locations.

Response

OK

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

org_idinteger

The organization identifier, valid when enabling HIQ feature

parent_idinteger

The parent location ID

namestring required

The location name

unique_namestring required

The unique location name

typestring required

The location type

addressstring

The address for the location