Получение событий

Метод выводит список событий, зарегистрированных по выбранному детектору

Пример запроса:

<url_smartroad>/api/<version>/events?login=<login>&password=<password>&sensor_id=<sensor_id>

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

Параметр	Возможные варианты параметров	Возможные варианты значений	Примечание	Чувствительность к регистру
startDate / endDate	startDate / endDate	14.03.2025 13:00 / 14.03.2025 14:00 Допускается передавать время с точностью до секунд, минут или часов	Параметры идут только парой. Обязательно передавать начало и конец промежутка.	✘
from / to	from / to	2025-03-14T13:00:00 / 2025-03-14T14:00:00 2025-03-14 13:00:00 / 2025-03-14 14:00:00 Допускается передавать время с точностью до секунд, минут или часов	Параметры идут только парой. Обязательно передавать начало и конец промежутка.	✘
timeZone	timeZone	по умолчанию: Europe/Moscow UTC Chile/Continental America/Indiana/Knox	В качестве значения допускается аббревиатура или полное название часового пояса. Допускается передавать только одно значение.	✘
project_id	project_id	00112233-4455-6677-8899-aabbccddeeff	Допускается передавать только одно значение.	✘
sensorId	sensorId sensorID sensor_id	00112233-4455-6677-8899-aabbccddeeff	Допускается передавать несколько значений. Значения разделяются запятой, без пробелов.	✘
sensorName	sensorName name	example	Допускается передавать несколько значений. При добавлении в запрос нескольких детекторов, важно чтобы все перечисленные детекторы были из одного проекта, иначе запрос вернет ответ 400 Bad Request.	✘
interval	interval	по умолчанию: 300 60	Параметр interval – глубина временной выборки в секундах относительно момента запроса. Например, при значении 3600 API возвращает данные за предшествующий час. Параметры начала и конца временного промежутка имеют приоритет над параметром interval. Значение по умолчанию используется в случае, если параметр не был указан в запросе. Значение передается в секундах. Допускается передавать только одно значение.	✘

Схема данных ответа

При поступлении корректного запроса Система формирует ответное сообщение в формате JSON.

Пример ответа:

{
    "time_zone": "Europe/Moscow",
    "message_id": "66ce4647-60fc-1dac-183c-a323807dad78",
    "message_data": [
        {
            "data": [
                {
                    "row": 1,
                    "val": "39.96",
                    "code": 456,
                    "lane": 0,
                    "type": 1,
                    "unit": "LOW_SPEED",
                    "zone": 0,
                    "level": 0,
                    "obj_id": 125,
                    "heading": 180.13,
                    "point_x": 129.6,
                    "point_y": -10.2,
                    "end_time": "2025-04-10T16:43:58.238224+03:00",
                    "direction": -1,
                    "events_id": "43475187-e613-4b14-b813-a561a57faad4",
                    "obj_class": 2,
                    "obj_speed": 39.96,
                    "sensor_id": "3a9d31ae-4d9e-469e-99af-a2dca1a333d8",
                    "close_type": 0,
                    "obj_length": 8.9,
                    "start_time": "2025-04-10T16:43:45.845556+03:00",
                    "description": [
                        {
                            "lang": "ru",
                            "name": "Тормоз"
                        },
                        {
                            "lang": "en",
                            "name": "Break"
                        },
                        {
                            "lang": "es",
                            "name": "Freno"
                        }
                    ],
                    "projects_id": "777d9dea-05a8-4a34-92bb-f7c6f1726882",
                    "measure_line": null
                }
            ],
            "name": "144.A4.DT1",
            "connected": "true",
            "sensor_id": "3a9d31ae-4d9e-469e-99af-a2dca1a333d8",
            "lane_direction": [
                1,
                1,
                1,
                0,
                0,
                0
            ]
        }
    ],
    "protocol_version": "1.0"
}

Схема данных Json ответа запроса events

Параметр ответа	Тип данных ответа	Описание параметра
time_zone	строка	Часовой пояс, указанный в профиле пользователя
message_id	строка (формат: uuid)	Уникальный идентификатор сообщения
message_data	массив	Тело сообщения
protocol_version	строка	Версия API
data	массив	Список данных статистики по полосам за выбранный промежуток времени
name	строка	Название детектора
connected	строка	Статус подключения детектора
direction	строка	Направление детектора
sensor_id	строка	Уникальный идентификатор детектора
lane_direction	массив целых чисел	Список направления полос движения
row	целое число	Номер строки из списка событий выбранного детектора, с сортировкой по параметру start_time
val	число	Значение параметра события.
code	целое число	Код события.
lane	целое число	Номер полосы
type	целое число	Тип события.
unit	строка	Единица измерения.
zone	целое число	Индекс зоны, проходя через которую, объект становится PVR.
level	целое число	Категория события.
obj_id	целое число	Идентификатор объекта. Детекторы ведут объекты, назначая им номера с момента определения объекта в области видимости, и до выхода из нее. Пул номеров циклично ротируется.
heading	число	Направление движения (угол движения к детектору в градусах)
point_x	число	Расстояние в метрах по оси X
point_y	число	Расстояние в метрах по оси Y
end_time	строка (формат: date-time)	Время окончания события
direction	целое число	Направление движения по полосе
events_id	строка (формат: uuid)	Уникальный идентификатор события
obj_class	целое число	Номер класса объекта, по заданной пользователем классификации.
obj_speed	число	Скорость объекта в км/ч.
sensor_id	строка (формат: uuid)	Уникальный идентификатор детектора
close_type	целое число, null	Тип закрытия
obj_length	число	Длина объекта в метрах. Значение используется для определения класса объекта
start_time	строка (формат: date-time)	Время начала события
description	массив	Название события на русском, английском и испанском языках
lang	строка	Язык
name	строка	Название события
projects_id	строка (формат: uuid)	Уникальный идентификатор проекта
measure_line	целое число, null	Всегда принимает значение null

Описание параметров ответа events

Параметр ответа	Расчет параметров/значение по умолчанию
val	Для событий логического характера – 1, для измеримых событий – соответствующее числовое значение. Например, для превышения скорости, – первое измеренное числовое значение, удовлетворяющее правилу события.
code	Коды событий задаются пользователем при создании событий. Изменение кода события в Системе не влияет на события, записанные до момента изменения
type	1 – Speed events (События скорости), 2 – Traffic events (События трафика), 9 – Others events (Другие события). Соответствует настройкам правила события в Системе
unit	KMH – Километры в час, MPS – Метры в секунду, PEDESTRIAN – Обнаружен пешеход, PLACE – Объект в области определения, STOP – Остановка ТС, WWD – Неверное направление
zone	Создаются в разделе «Управление дорогами»
level	0 – Information event (Информация), 1 – Warning event (Предупреждение), 2 – Critical event (Критическое событие). Соответствует настройкам правила события в Системе
obj_class	Нумерация классов начинается с «0». Если детектор не смог определить класс ТС, то устанавливается значение «-1»
close_type	0 – Автоматическое, 1 – Ручное, NULL – Не закрыто