Дерево планoв

Дерево планов

Если кол-во элементов дерева планов больше чем указано в env переменной TREE_MAP_SINGLE_REQUEST_MAX_GROUPS_COUNT, то дерево будет строится по следующему принципу:

Запрос возвращает список групп 1 уровня вложенности. Для того, чтобы получить группы след. уровня вложенности нужно указать group_id родительской группы. С помощью параметра has_items можно понять, содержит ли группа планы. Параметр has_items = true означает, что данная группа содержит планы. С помощью параметра has_groups можно понять, содержит ли группа вложенные группы. Параметр has_groups = true означает, что данная группа содержит вложенные группы.

Если же элементов дерева планов меньше чем в env переменной TREE_MAP_SINGLE_REQUEST_MAX_GROUPS_COUNT, то все дерево будет возвращаться за 1 запрос.

Для получения списка планов из группы необходимо использовать запрос на список планов с указанием параметра group_id VMS Client/Карты/Планы/Список планов

Для того чтобы убрать ветку из дерева, необходимо передать exclude_group_id, в этом случае данная группа и все её дочерние, не будут участвовать в формировании дерева. Для поиска только по группам использовать параметр search_group=имя_группы вместо параметра search

GET /api/v1/maps/tree

Параметры метода

integer group_id, Id родительской группы

string search, Поиск по адресу и имени плана

string search_group, Поиск по адресу и имени группы

integer exclude_group_id, Id группы, которую необходимо исключить

200 OK

Успешный ответ

JSON

[
    {
        "id": 1,
        "name": "test1",
        "has_items": false,
        "has_groups": true,
        "children": [
            {
                "id": 3,
                "name": "test3",
                "has_items": true,
                "has_groups": false,
                "children": []
            }
        ]
    },
    {
        "id": 2,
        "name": "test2",
        "has_items": false,
        "has_groups": false,
        "children": []
    }
]

401 Unauthorized

Токен авторизации не передан или не валидный

422 Unprocessable Entity

Возвращает JSON объект с ошибкой.

JSON

{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/v1/maps/tree' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "group_id": "integer",
    "search": "string",
    "search_group": "string",
    "exclude_group_id": "integer"
}'

PHP

$data = array (
  'group_id' => 'integer',
  'search' => 'string',
  'search_group' => 'string',
  'exclude_group_id' => 'integer',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/maps/tree', false, $context);