Общие соглашения

Web-cервер возвращает результаты вызова методов в формате JSON.

Авторизация

Для выполнения запросов необходима авторизация. Поддерживаются 2 типа авторизации: Basic и Bearer.

При авторизации Basic данные пользователя необходимо добавлять во все HTTP запросы в следующем виде:

http://[имя_пользователя]:[пароль]@[IP-адрес]:[порт]/[префикс]

При авторизации Bearer используется токен, полученный от web-сервера (см. Bearer авторизация).

POST-запросы должны содержать тело в формате JSON.

Формат времени в запросах

Во всех запросах время задается в формате YYYYMMDDTHHMMSS в часовом поясе UTC+0.

В ряде запросов задается временной интервал, например:

GET http://IP-адрес:порт/префикс/archive/contents/intervals/{VIDEOSOURCEID}/{ENDTIME}/{BEGINTIME} 

В таких запросах возвращаются данные начиная с момента времени BEGINTIME и заканчивая моментом времени ENDTIME.

В случае, если BEGINTIME не указан, подразумевается значение, соответствующее бесконечному будущему. Если при этом ENDTIME также не указан, подразумевается его значение, соответствующее бесконечному прошлому. Вместо BEGINTIME и ENDTIME могут быть использованы слова "past" или "future", означающие бесконечное прошлое и бесконечное будущее соответственно.

Порядок выдачи интервалов соответствует отношению между заданными BEGINTIME и ENDTIME (по возрастанию, если BEGINTIME<ENDTIME, и по убыванию, если ENDTIME<BEGINTIME). При этом начало и конец интервала всегда выдаются в естественном порядке, т.е. значение времени начала интервала будет меньше либо равно времени конца интервала).

Лимит запросов

Существует ограничение на количество активных запросов и запросов, находящихся в очереди.

При переполнении очереди запросов будет возвращена ошибка с кодом 503 - Search query rejected. Too many requests.