Breadcrumbs

Получение дерева. VMS Billing API

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

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




GET/api/v1/billing/tree

Headers

Accept

application/json

Body

typerequired

string

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

idrequired

int

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

external_idrequired

string|int

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

Response




200

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

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

Возвращает JSON объект с ошибкой, см. Валидация

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

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/billing/tree' \
--header 'Accept:application/json'