Создaние планов

Создание планов

Планы нужны для визуализации расположения камер. Можно загружать любое изображение, выбрать среди доступных камер и нанести их на изображение, где они стоят в реальности и в какую сторону направлены.

JSON

{
    "image": "image binary data",
    "name": "моя карта",
    "cameras": [
        {
            "camera_id": 12,
            "x": 0.2,
            "y": 0.3,
            "angle": 50,
            "radius": 50.546,
            "segment_angle": 80.332
        }
    ],
    "latitude": 25.645345244619257,
    "longitude": -37.295444497828434
}

POST /api/v1/maps

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

binary image, Изображение плана. Возможные форматы - jpeg,bmp,png

string name, Название плана, которое должно быть уникально для в рамках текущего пользователя

int group_id, Идентификатор группы в которую необходимо добавить Карту

array cameras, Массив камер с координатами x и y на изображении с углом поворота angle, а так же radius (радиус обзора) и segment_angle (угол поворота) - эти данные нужны для отрисовки камер на изображении.

double latitude, Координата широты нахождения плана

double longitude, Координата долготы нахождения плана

200 OK

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

JSON

{
    "id": 14,
    "name": "тест",
    "created_at": "2022-04-22 14:51:54",
    "updated_at": "2022-04-22 14:51:54",
    "url": "https://vms.local/storage/path.jpg",
    "group_id": 1,
    "latitude": 25.645345244619257,
    "longitude": -37.295444497828434,
    "cameras": [
        {
            "x": 29,
            "y": 82,
            "angle": 61,
            "radius": 50.5463836852,
            "segment_angle": 80.3322,
            "camera": {
                "id": 92650,
                "group_id": 52039,
                "status": "active",
                "type": "mediaserver_v2",
                "start_at": "2022-03-23 14:51:54",
                "created_at": "2020-11-27 16:40:23",
                "billing_id": null,
                "pretty_name": "камера 2",
                "pretty_text": "Область обл., Районный р-н, г. Город, ул. Улица 1",
                "short_address": "г. Город, ул. Улица 1",
                "full_address": "Область обл., Районный р-н, г. Город, ул. Улица 1",
                "lat": null,
                "lng": null,
                "azimuth": null,
                "streams": [
                    {
                        "id": 204868,
                        "type": "high",
                        "camera_id": 92650,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false
                    },
                    {
                        "id": 204871,
                        "type": "low",
                        "camera_id": 92650,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false
                    }
                ],
                "services": {
                    "ptz": false,
                    "motion_detect": false
                },
                "has_sound": false,
                "archive_recording_timetable": {
                    "days": [
                        {
                            "to": "13:39:25",
                            "from": "13:38:25",
                            "type": "monday"
                        }
                    ]
                },
                "archive_ranges": [
                    {
                        "end": 1650627922,
                        "from": 1649312173,
                        "duration": 1315749
                    }
                ],
                "is_archive_recording": true,
                "is_bridge": false,
                "is_favorite": false,
                "is_owner": true,
                "can_change_archive_timetable": true,
                "archive_recording_type": "timetable",
                "user_status": "active",
                "name": "камера 2"
            }
        }
    ]
}

401 Unauthorized

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

422 Unprocessable Entity

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

JSON

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

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/v1/maps' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "image": "binary",
    "name": "string",
    "group_id": 0,
    "cameras": [],
    "latitude": 0,
    "longitude": 0
}'

PHP

$data = array (
  'image' => 'binary',
  'name' => 'string',
  'group_id' => 0,
  'cameras' => 
  array (
  ),
  'latitude' => 0.0,
  'longitude' => 0.0,
);
$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/maps', false, $context);