Skip to main content
Skip table of contents

Обновление раскладки

PUT/api/v1/layouts/{layout}

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

json

JSON
{
    "name": "new name",
    "layout_template": "Grid51",
    "grid": [
        {
            "camera_id": 12,
            "stream_id": 15
        },
        null,
        {
            "camera_id": 15,
            "stream_id": 19
        }
    ]
}

layoutoptional

int

Идентификатор раскладки, которую нужно обновить

namerequired

string

Название раскладки, оно должно быть уникальным для пользователя

layout_templaterequired

string

Уникальный идентификатор шаблона раскладки. Список можно найти в Основные конфигурации

gridrequired

string

Массив объектов для каждой ячейки раскладки, если оставить ячейку пустой, то нужно вместо объект прислать null

Response

200

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

JSON
{
    "id": 219,
    "name": "1",
    "layout_template_id": 1,
    "layout_template": "Grid11",
    "user_id": 5,
    "grid": [
        {
            "id": 751,
            "group_id": 101,
            "status": "active",
            "type": "media_server_v2",
            "start_at": "2022-03-03 17:50:52",
            "created_at": "2022-01-27 19:46:27",
            "billing_id": null,
            "pretty_name": "Камера",
            "pretty_text": "Камеры",
            "short_address": "Камеры",
            "full_address": "Камеры",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "streams": [
                {
                    "id": 744,
                    "type": "high",
                    "camera_id": 751,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "has_sound": false,
                    "layout_priority": "reserve",
                    "width": 2048,
                    "height": 1536
                },
                {
                    "id": 745,
                    "type": "low",
                    "camera_id": 751,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "has_sound": false,
                    "layout_priority": "main",
                    "width": 2048,
                    "height": 1536
                }
            ],
            "services": {
                "ptz": false,
                "motion_detect": false
            },
            "has_sound": false,
            "is_archive_recording": true,
            "is_bridge": false,
            "is_favorite": false,
            "user_status": "active",
            "name": "Камера"
        }
    ],
    "created_at": "2021-10-04 13:57:56",
    "updated_at": "2021-10-04 13:57:56"
}
404

Если расладка не принадлежит пользователю или не существует

401

Токен авторизации не передан или не валидный, см. Получение токена

422

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

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

Пример

JSON
curl -k --location --request PUT 'https://vms.local/api/v1/layouts/{layout}' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id' \
--header 'Content-Type: application/json \
--data-raw '{
    "name": "new name",
    "layout_template": "Grid51",
    "grid": [
        {
            "camera_id": 12,
            "stream_id": 15
        },
        null,
        {
            "camera_id": 15,
            "stream_id": 19
        }
    ]
}'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.