Получить дерево объектов

Метод и параметры

GET /api/v1/billing/tree

При запросе дерева – по умолчанию возвращаются корневые элементы. Для получения подэлементов необходимо передать идентификатор элемента, чьи подэлементы необходимо получить.

Идентификатором может служить id или external_id.

string type, Тип дерева, который нужно получить

int id, Идентификатор элемента дерева, подэлементы которого нужно получить

string|int external_id, Собственный ключ элемента дерева, подэлементы которого нужно получить

200 OK

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

JSON

[
    {
        "id": 14,
        "name": "Name of item 1",
        "external_id": "unique_key_1",
        "has_items": true
    },
    {
        "id": 15,
        "name": "Name of item 2",
        "external_id": "unique_key_2",
        "has_items": false
    },
    {
        "id": 16,
        "name": "Name of item 3",
        "external_id": null,
        "has_items": false
    }
]

422 Unprocessable Entity

Возвращает JSON объект с ошибкой. Детально в разделе Общая информация→Валидация.

JSON

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

cURL

Bash

curl -k --request GET \
	--url 'https://your-domain/api/v1/billing/tree' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "type": "string",
    "id": 0,
    "external_id": "string|int"
}'

PHP

$data = array (
  'type' => 'string',
  'id' => 0,
  'external_id' => 'string|int',
);
$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/billing/tree', false, $context);