Список меток

Список меток, доступных пользователю. Типы доступных меток могут отличаться в зависимости от клиента. Список доступных меток для клиента можно посмотреть в Основные конфигурации

GET/api/v1/marks

Headers
Authorization		Bearer token
Accept		application/json
X-Client		ios-cctv\|android-cctv\|thick-legal\|web
X-UUID		unique device id

Body
per_page^required	int	Количество элементов в одной странице пагинации. По умолчанию 25 штук
page^required	int	Номер страницы пагинации
date^required	string	Шаблон для фильтрации по определенной метке даты. Это поле обязательно, когда есть поле timezone
timezone^required	string	Часовой пояс для шаблон фильтрации по дате. Пример - Europe/Paris. Это поле обязательно, когда есть поле date
from^required	date	Дата, с которой будут отображаться метки
to^required	date	Дата, до которой будут отображаться метки
types^required	array	Только типы из массива types будут в респонсе. Список доступных типов можно найти в Основные конфигурации
cameras^required	array	Только метки камер из массива cameras (массив id камер) будут в респонсе. Максимум 100 элементов
excluded_cameras^required	array	Только метки камер, не входящих в массив excluded_cameras (массив id камер) будут в респонсе. Максимум 100 элементов
sort^required	string	Поле, по которому нужно отсортировать метки
dir^required	string	В каком направлении нужно отсортировать.

Response
200		Успешный ответ
JSON { "data": [ { "id": 2, "type": "mark", "type_pretty": "Пользовательская", "title": "MARK", "can_delete": true, "from": "2023-04-18T14:14:49.000000Z", "to": "2023-04-18T18:14:53.000000Z", "camera_id": 28, "created_at": "2023-04-18T15:14:59.000000Z", "updated_at": null, "camera": { "id": 28, "group_id": 7, "status": "active", "type": "media_server_v2", "start_at": null, "created_at": "2023-04-17T15:16:16.000000Z", "billing_id": null, "pretty_name": "Камера 1", "pretty_text": "Камеры", "short_address": "Камеры", "full_address": "Камеры", "lat": null, "lng": null, "azimuth": null, "streams": [ { "id": 49, "type": "high", "camera_id": 28, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null } ], "has_sound": false, "is_archive_recording": false, "archive_recording_type": "fulltime", "can_change_archive_timetable": false, "is_bridge": false, "is_favorite": false, "user_status": "active", "name": "test camera 2" }, "preview_url": "https://preview_url/screenshot.mp4?token=sometoken" }, { "id": 1, "type": "mark", "type_pretty": "Пользовательский", "title": "MARK", "can_delete": true, "from": "2023-04-18T15:14:01.000000Z", "to": "2023-04-18T16:14:04.000000Z", "camera_id": 27, "created_at": "2023-04-18T15:14:08.000000Z", "updated_at": null, "camera": { "id": 27, "group_id": 7, "status": "active", "type": "media_server_v2", "start_at": null, "created_at": "2023-04-17T15:16:16.000000Z", "billing_id": null, "pretty_name": "Камера 2", "pretty_text": "Камеры", "short_address": "Камеры", "full_address": "Камеры", "lat": null, "lng": null, "azimuth": null, "streams": [ { "id": 48, "type": "high", "camera_id": 27, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null } ], "has_sound": false, "is_archive_recording": false, "archive_recording_type": "fulltime", "can_change_archive_timetable": false, "is_bridge": false, "is_favorite": false, "user_status": "active", "name": "test camera 1" }, "preview_url": "https://preview_url/screenshot.mp4?token=sometoken" } ], "links": { "first": "https://vms.local/api/v3/marks?per_page=25&page=1", "last": "https://vms.local/api/v3/marks?per_page=25&page=255", "prev": null, "next": "https://vms.local/api/v3/marks?per_page=25&page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "url": null, "label": "pagination.previous", "active": false }, { "url": "https://vms.local/api/v3/marks?per_page=25&page=1", "label": "1", "active": true }, { "url": null, "label": "pagination.next", "active": false } ], "path": "https://vms.local/api/v3/marks", "per_page": 25, "to": 2, "total": 2 } }
401		Токен авторизации не передан или не валидный
403		Если запросили тип метки, который недоступен текущему пользователю
422		Возвращает JSON объект с ошибкой, см. Валидация
JSON `{ "message": "Тут не будет информативного сообщения", "errors": { "any_key": [ "Тут будет описана причина ошибки" ] } }`

Пример

JSON

curl -k --location --request GET 'https://vms.local/api/v1/marks?per_page=int&page=int&date=string&timezone=string&from=date&to=date&types=array&cameras=array&excluded_cameras=array&sort=string&dir=string' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'