Обновление кейсов подсчета людей

Обновление кейса Аналитики

Обновление кейса аналитики с типом "Подсчет людей в области".

JSON

{
    "title": "Подсчет людей в области",
    "type": "person-counting",
    "cameras": [
        {
            "id": 10,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 20,
                    "is_enabled": true
                }
            ],
            "meta": {
                "figures": [
                    {
                        "name": "Figure 1",
                        "coords": [
                            {
                                "x": 0.153125,
                                "y": 0.31666666666666665
                            },
                            {
                                "x": 0.3421875,
                                "y": 0.7361111111111112
                            },
                            {
                                "x": 0.86875,
                                "y": 0.6472222222222223
                            },
                            {
                                "x": 0.78125,
                                "y": 0.125
                            }
                        ]
                    }
                ],
                "reaction_after_value": 3
            }
        },
        {
            "id": 7,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 20,
                    "is_enabled": true
                }
            ],
            "meta": {
                "figures": [
                    {
                        "name": "Figure 1",
                        "coords": [
                            {
                                "x": 0.153125,
                                "y": 0.31666666666666665
                            },
                            {
                                "x": 0.3421875,
                                "y": 0.7361111111111112
                            },
                            {
                                "x": 0.86875,
                                "y": 0.6472222222222223
                            },
                            {
                                "x": 0.78125,
                                "y": 0.125
                            }
                        ]
                    }
                ],
                "reaction_after_value": 3
            }
        }
    ]
}

PUT /api/v1/analytic-case/{case}

Параметры метода

int case, Уникальный идентификатор кейса аналитики, который нужно обновить

string title, Название кейса аналитики, который нужно обновить

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

object array

bool

cameras.

REQUIRED

, .force Тип удаления. true - полное удаление кейса, false - кейс пометиться как удаленный и события по нему остануться, но не будут приходить новые события

bool

cameras.

REQUIRED

, .force Тип удаления. true - полное удаление кейса, false - кейс пометиться как удаленный и события по нему остануться, но не будут приходить новые события

200 OK

Возвращает кейс аналитики

JSON

{
    "id": 42,
    "title": "Подсчет людей в области",
    "type": "person-counting",
    "type_pretty": "Подсчет людей в области",
    "status": "active",
    "cameras": [
        {
            "id": 10,
            "group_id": 2,
            "status": "active",
            "type": "media_server_v2",
            "start_at": "",
            "created_at": "2022-12-16 10:25:55",
            "billing_id": null,
            "pretty_name": "manual ретрансфер Забор (ворота вид сверху)",
            "pretty_text": "Тестовые камеры, камеры c ручным заведением",
            "short_address": "Тестовые камеры, камеры c ручным заведением",
            "full_address": "Тестовые камеры, камеры c ручным заведением",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "streams": [
                {
                    "id": 19,
                    "type": "high",
                    "camera_id": 10,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "has_sound": false,
                    "width": null,
                    "height": null
                },
                {
                    "id": 20,
                    "type": "low",
                    "camera_id": 10,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "has_sound": false,
                    "width": null,
                    "height": null
                }
            ],
            "has_sound": false,
            "archive_ranges": [],
            "archive_recording_timetable": null,
            "is_archive_recording": false,
            "archive_recording_type": "fulltime",
            "can_change_archive_timetable": false,
            "scripts": [
                {
                    "id": 20,
                    "is_enabled": true,
                    "title": "Установить метку",
                    "schedule": [],
                    "timetable": {
                        "days": [
                            {
                                "to": "23:59:00+05:00",
                                "from": "00:00:00+05:00",
                                "type": "same_every_day",
                                "breaks": []
                            }
                        ],
                        "intervals": []
                    },
                    "status": "active",
                    "created_at": "2022-12-21 12:41:39",
                    "updated_at": "2022-12-21 12:41:39",
                    "users": [
                        {
                            "id": 5,
                            "login": "170500",
                            "name": "170500",
                            "parent_id": null,
                            "created_at": "2022-12-06 20:20:58",
                            "updated_at": "2022-12-21 10:53:45",
                            "access_token_id": null,
                            "can_update_password": true
                        }
                    ],
                    "event": {
                        "id": 3,
                        "name": "person-counting",
                        "description": "Подсчет людей в области",
                        "color": "#FF7CF2",
                        "analytic_type": "person-counting"
                    },
                    "extra": null
                }
            ],
            "meta": {
                "figures": [
                    {
                        "name": "Figure 1",
                        "coords": [
                            {
                                "x": 0.153125,
                                "y": 0.31666666666666665
                            },
                            {
                                "x": 0.3421875,
                                "y": 0.7361111111111112
                            },
                            {
                                "x": 0.86875,
                                "y": 0.6472222222222223
                            },
                            {
                                "x": 0.78125,
                                "y": 0.125
                            }
                        ]
                    }
                ],
                "reaction_after_value": 3
            },
            "analytic_case_camera_status": "inactive",
            "analytic_case_camera_status_pretty": "Камера неактивна",
            "analytic_case_camera_user_status": "failed_to_create",
            "analytic_case_camera_user_status_pretty": "Ошибка создания",
            "analytic_notification": {
                "title": "Error reading video stream",
                "expired_at": "2024-02-15T09:22:15.192128Z"
            },
            "analytic_case_camera_uuid": "cca769c0-ea88-4e7d-88c7-6d5beb66de97",
            "event": null,
            "is_bridge": false,
            "is_favorite": false,
            "user_status": "active",
            "name": "manual ретрансфер Забор (ворота вид сверху)"
        },
        {
            "id": 7,
            "group_id": 2,
            "status": "inactive",
            "type": "media_server_v2",
            "start_at": "",
            "created_at": "2022-12-16 10:25:54",
            "billing_id": null,
            "pretty_name": "manual Аналитика 5",
            "pretty_text": "Тестовые камеры, камеры c ручным заведением",
            "short_address": "Тестовые камеры, камеры c ручным заведением",
            "full_address": "Тестовые камеры, камеры c ручным заведением",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "streams": [
                {
                    "id": 13,
                    "type": "high",
                    "camera_id": 7,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "has_sound": false,
                    "width": null,
                    "height": null
                },
                {
                    "id": 14,
                    "type": "low",
                    "camera_id": 7,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "has_sound": false,
                    "width": null,
                    "height": null
                }
            ],
            "has_sound": false,
            "archive_ranges": [],
            "archive_recording_timetable": null,
            "is_archive_recording": false,
            "archive_recording_type": "fulltime",
            "can_change_archive_timetable": false,
            "scripts": [
                {
                    "id": 20,
                    "is_enabled": true,
                    "title": "Установить метку",
                    "schedule": [],
                    "timetable": {
                        "days": [
                            {
                                "to": "23:59:00+05:00",
                                "from": "00:00:00+05:00",
                                "type": "same_every_day",
                                "breaks": []
                            }
                        ],
                        "intervals": []
                    },
                    "status": "active",
                    "created_at": "2022-12-21 12:41:39",
                    "updated_at": "2022-12-21 12:41:39",
                    "users": [
                        {
                            "id": 5,
                            "login": "170500",
                            "name": "170500",
                            "parent_id": null,
                            "created_at": "2022-12-06 20:20:58",
                            "updated_at": "2022-12-21 10:53:45",
                            "access_token_id": null,
                            "can_update_password": true
                        }
                    ],
                    "event": {
                        "id": 3,
                        "name": "person-counting",
                        "description": "Подсчет людей в области",
                        "color": "#FF7CF2",
                        "analytic_type": "person-counting"
                    },
                    "extra": null
                }
            ],
            "meta": {
                "figures": [
                    {
                        "name": "Figure 1",
                        "coords": [
                            {
                                "x": 0.153125,
                                "y": 0.31666666666666665
                            },
                            {
                                "x": 0.3421875,
                                "y": 0.7361111111111112
                            },
                            {
                                "x": 0.86875,
                                "y": 0.6472222222222223
                            },
                            {
                                "x": 0.78125,
                                "y": 0.125
                            }
                        ]
                    }
                ],
                "reaction_after_value": 3
            },
            "analytic_case_camera_status": "active",
            "analytic_case_camera_status_pretty": "Камера активна",
            "analytic_case_camera_user_status": null,
            "analytic_case_camera_user_status_pretty": null,
            "analytic_notification": null,
            "analytic_case_camera_uuid": "cca769c0-ea88-4e7d-88c7-6d5beb66de97",
            "event": null,
            "is_bridge": false,
            "is_favorite": false,
            "user_status": "active",
            "name": "manual Аналитика 5"
        }
    ],
    "created_at": "2022-12-21 12:41:54",
    "updated_at": "2022-12-21 12:41:54",
    "color": "#F027DC",
    "available_events": [],
    "is_fails_exists": true,
    "errors": [
        "Ошибка создания камеры manual ретрансфер Забор (ворота вид сверху)."
    ]
}

401 Unauthorized

Токен авторизации не передан или не валидный

402 Payment Required

Превышен лимит лицензий для выбранного кейса аналитики

422 Unprocessable Entity

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

JSON

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

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/v1/analytic-case/{case}' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "case": 0,
    "title": "string",
    "cameras": {
        "": true
    },
    "cameras.": "void"
}'

PHP

$data = array (
  'case' => 0,
  'title' => 'string',
  'cameras' => 
  array (
    '' => true,
  ),
  'cameras.' => 'void',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'PUT',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/analytic-case/{case}', false, $context);