⌂ > ⎘ Открытый REST API

/specialarchiveevents : Список специальных архивных событий🔗

GET /specialarchiveevents : Получение списка специальных архивных событий🔗

Совет

Данный запрос устарел. Вместо него рекомендуется использовать эндпойнт:

POST /archive_events

Подробнее см. /archive_events : Данные о событиях в архиве.

Предупреждение

Доступно в Macroscop версии 2.1 и выше.

Доступно во всех типах лицензий.

Важно

Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.

Примечание

Доступно получение ответа в формате JSON.

Ещё одним способом получения событий из архива является порционная выгрузка данных в виде списка событий, зафиксированных системой за заданное время. Для этого применяется запрос к ресурсу specialarchiveevents.

Примечание

При чтении полученного ответа необходимо учитывать, что информация передаётся с использованием механизма Newline delimited JSON streaming. Разделение объектов в этом механизме осуществляется переводом следующего объекта на новую строку вместо использования символьных разделителей.

Примечание

Для данного типа запроса действует ограничение на максимальное количество событий, возвращаемых сервером единоразово – 1000 записей. Для получения последующих событий необходимо начинать поиск от времени последнего полученного события.

Примеры запросов🔗

Пример запроса данных в формате JSON:

GET http://localhost:8080/specialarchiveevents?login=root&password=&starttime=19.10.2022+10:50:00&endtime=19.10.2022+11:00:00&eventid=b0536c2f-2f09-4969-bf1a-9fb847b87d21&responsetype=json

Дополнительные параметры запроса🔗

Параметр

Значение по умолчанию

Описание

starttime

—

Дата и время начала интервала поиска событий. Указывается по часовому поясу UTC в формате DD-MM-YYYY hh:mm:ss. Обязательный параметр

endtime

—

Дата и время конца интервала поиска событий. Указывается по часовому поясу UTC в формате DD-MM-YYYY hh:mm:ss. Обязательный параметр

eventid

—

Уникальный идентификатор типа события. Может быть получен при выполнении запроса Получение списка зарегистрированных событий. Обязательный параметр

channelid

—

Уникальный идентификатор канала. Может быть получен при выполнении запроса Получение конфигурации системы. Опциональный параметр

responsetype

xml

Формат представления возвращаемых данных. Если не указан в запросе, используется значение по умолчанию. Опциональный параметр. Допустимые значения: xml, json

Пример ответа на запрос🔗

Пример ответа на запрос в формате JSON:

{
    "EventId" : "b0536c2f-2f09-4969-bf1a-9fb847b87d21",
    "Timestamp" : "19.10.2022 10:59:56",
    "BinaryTimestamp" : "5249703758396001539",
    "ZonedTimestamp" : "19.10.2022 10:59:56.861 +05:00",
    "EventDescription" : "Событие трекинга",
    "IsAlarmEvent" : "True",
    "ChannelId" : "e0391a80-c921-4ffc-9a69-107fcf28e34e",
    "ChannelName" : "Камера 3",
    "Comment" : "Движение в зоне",
    "EventType" : "Alarm",
    "InitiatorName" : "ExternalEvent",
    "alertType" : ["MovingInZone"],
    "AlertTime" : "638017739968613635",
    "TrajectoryId" : "57f88149-9976-4953-9b4c-3921c689b82d",
    "Left" : "0,0032153846710991974",
    "Top" : "0,5185692308091415",
    "Width" : "0,05787692314846298",
    "Height" : "0,13713846175798144"
}