Создание приватной папки

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

POST /api/v1/billing/tree/folders/private

Приватные папки можно создавать только для дерева камер.

Они нужны для разграничения доступа к камерам в рамках одного элемента дерева.

Создавать папки можно только в конечном элементе дерева.

Ключ для папки должен быть уникален в рамках одного конечного элемента дерева.

JSON

{
    "key": "random_key",
    "external_id": "external_id_of_tree_element",
    "id": null,
    "is_editable": false,
    "log_extra": {
        "some": "information"
    }
}

Параметры

string key REQUIRED, Ключ для папки, который можно будет прислать вместо id при создании камеры, если нужно добавить камеру в папку

string|int external_id REQUIRED, Ключ для элемента дерева (является обязательным если нет id)

int id REQUIRED, ID элемента дерева (является обязательным если нет external_id)

string|array log_extra, Дополнительная информация получаемая из внешней системы

boolean is_editable, Параметр отвечающий за возможность редактирования и удаления папки (не обязательный параметр, если не указан, то по умолчанию будет false)

201 Created

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

JSON

{
    "id": 15,
    "key": "random_key"
}

422 Unprocessable Entity

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

JSON

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

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/v1/billing/tree/folders/private' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "key": "string",
    "external_id": "string|int",
    "id": 0,
    "log_extra": "string|array",
    "is_editable": "boolean"
}'

PHP

$data = array (
  'key' => 'string',
  'external_id' => 'string|int',
  'id' => 0,
  'log_extra' => 'string|array',
  'is_editable' => 'boolean',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/billing/tree/folders/private', false, $context);