Список системных событий

Список системных событий, которые может просматривать пользователь

GET /api/v1/events

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

int per_page, Кол-во элементов в одной странице пагинации. По умолчанию 25 элементов

int page, Номер страницы пагинации

string date, Шаблон для фильтрации по определенной метке даты. Это поле обязательно, когда есть поле timezone

string timezone, Часовой пояс для шаблона фильтрации по дате. Пример - Europe/Paris. Это поле обязательно, когда есть поле date

date from, Дата, с которой будут отображаться события

date to, Дата, до которой будут отображаться события

string type, Массив типов, список доступных можно найти

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

string sort, Поле, по которому нужно отсортировать метки

string dir, В каком направлении нужно отсортировать.

string group, Фильтрация по группе событий. Возможные значения - systems, cameras, externals, bridges

string move_to, UUID события для перенаправления на страницу пагинации на которой находится данное событие

200 OK

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

JSON

{
    "data": [
        {
            "id": null,
            "type": "stream_high_active",
            "type_pretty": "Стрим высокого качества активен",
            "data": [],
            "color": "#00A670",
            "camera": {
                "id": 756,
                "group_id": 101,
                "status": "active",
                "type": "media_server_v2",
                "start_at": "2022-05-23 17:09:57",
                "created_at": "2022-01-27 19:52:55",
                "billing_id": null,
                "pretty_name": "Забор (контейнеры)",
                "pretty_text": "Исходные камеры, Уличные камеры",
                "short_address": "Исходные камеры, Уличные камеры",
                "full_address": "Исходные камеры, Уличные камеры",
                "lat": null,
                "lng": null,
                "azimuth": null,
                "streams": [
                    {
                        "id": 754,
                        "type": "high",
                        "camera_id": 756,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 1920,
                        "height": 1080
                    },
                    {
                        "id": 755,
                        "type": "low",
                        "camera_id": 756,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 640,
                        "height": 480
                    }
                ],
                "has_sound": false,
                "is_archive_recording": true,
                "is_bridge": false,
                "is_favorite": false,
                "user_status": "active",
                "name": "Забор (контейнеры)"
            },
            "camera_id": 756,
            "user": null,
            "user_id": null,
            "created_at": "2022-06-07 05:20:05",
            "analytic_case": null
        },
        {
            "id": null,
            "type": "stream_high_inactive",
            "type_pretty": "Стрим высокого качества неактивен",
            "data": [],
            "color": "#F30000",
            "camera": {
                "id": 756,
                "group_id": 101,
                "status": "active",
                "type": "media_server_v2",
                "start_at": "2022-05-23 17:09:57",
                "created_at": "2022-01-27 19:52:55",
                "billing_id": null,
                "pretty_name": "Забор (контейнеры)",
                "pretty_text": "Исходные камеры, Уличные камеры",
                "short_address": "Исходные камеры, Уличные камеры",
                "full_address": "Исходные камеры, Уличные камеры",
                "lat": null,
                "lng": null,
                "azimuth": null,
                "streams": [
                    {
                        "id": 754,
                        "type": "high",
                        "camera_id": 756,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 1920,
                        "height": 1080
                    },
                    {
                        "id": 755,
                        "type": "low",
                        "camera_id": 756,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 640,
                        "height": 480
                    }
                ],
                "services": {
                    "ptz": false,
                    "motion_detect": false
                },
                "has_sound": false,
                "is_archive_recording": true,
                "is_bridge": false,
                "is_favorite": false,
                "user_status": "active",
                "name": "Забор (контейнеры)"
            },
            "camera_id": 756,
            "user": null,
            "user_id": null,
            "created_at": "2022-06-07 05:19:05",
            "analytic_case": null
        }
    ],
    "links": {
        "first": "https://vms.local/api/v3/events?per_page=25&page=1",
        "last": "https://vms.local/api/v3/events?per_page=25&page=111",
        "prev": null,
        "next": "https://vms.local/api/v3/events?per_page=25&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 111,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=10",
                "label": "10",
                "active": false
            },
            {
                "url": null,
                "label": "...",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=110",
                "label": "110",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=111",
                "label": "111",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/events?per_page=25&page=2",
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v3/events",
        "per_page": 25,
        "to": 25,
        "total": 2762
    }
}

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/events' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "date": "string",
    "timezone": "string",
    "from": "date",
    "to": "date",
    "type": "string",
    "cameras": [],
    "sort": "string",
    "dir": "string",
    "group": "string",
    "move_to": "string"
}'

PHP

$data = array (
  'per_page' => 0,
  'page' => 0,
  'date' => 'string',
  'timezone' => 'string',
  'from' => 'date',
  'to' => 'date',
  'type' => 'string',
  'cameras' => 
  array (
  ),
  'sort' => 'string',
  'dir' => 'string',
  'group' => 'string',
  'move_to' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/events', false, $context);