Skip to main content
Skip table of contents

Обновление группы. VMS Client API

PUT/api/v1/groups/{group}

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",
    "items": [
        1,
        2,
        3
    ]
}

groupoptional

int

Идентификатор группы, которую нужно обновить

namerequired

string

Название группы

itemsrequired

array

Масcив id камер, которые нужно оставить в группе (новые будут добавлены, те, которые не прислали, будут удалены из группы)

Response

200

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

JSON
{
    "id": 44,
    "name": "test1",
    "items": [
        {
            "id": 751,
            "group_id": 101,
            "status": "active",
            "type": "media_server_v2",
            "start_at": "2022-03-22 13:47:37",
            "created_at": "2022-01-27 19:46:27",
            "billing_id": null,
            "pretty_name": "Камера 1",
            "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,
                    "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,
                    "width": 2048,
                    "height": 1536
                }
            ],
            "has_sound": false,
            "archive_ranges": [
                {
                    "end": 1648340879,
                    "from": 1647945613,
                    "duration": 395266
                },
                {
                    "end": 1649146798,
                    "from": 1648429544,
                    "duration": 717254
                },
                {
                    "end": 1649159638,
                    "from": 1649158213,
                    "duration": 1425
                },
                {
                    "end": 1649221070,
                    "from": 1649159719,
                    "duration": 61351
                },
                {
                    "end": 1649240719,
                    "from": 1649222038,
                    "duration": 18681
                }
            ],
            "is_archive_recording": true,
            "is_bridge": false,
            "is_favorite": false,
            "user_status": "active",
            "name": "Камера 1"
        }
    ],
    "items_count": 1
}
404

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

401

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

422

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

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

Пример

JSON
curl -k --location --request PUT 'https://vms.local/api/v1/groups/{group}' \
--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",
    "items": [
        1,
        2,
        3
    ]
}'
JavaScript errors detected

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

If this problem persists, please contact our support.