Общий формат запроса:

GET http://IP-адрес:порт/web2/secure/events/

Параметры запроса:

ПараметрОписание
from Самая старая дата промежутка поиска сообщений. Пример: 2012-12-27T15%3A19%3A16.000%2B03%3A00
to Самая последняя дата промежутка поиска сообщений. Пример: 2012-12-27T15%3A19%3A16.000%2B03%3A00
count Максимальное количество сообщений в ответе в диапазоне [1, 200]. По умолчанию 20. Сервер может вернуть чуть больше, если сообщений в базе данных осталось мало.
objectId

Класс объекта и Id объекта, который указывается через двоеточие. Примеры: CAM:1, GRAY:5, PEOPLE_COUNTER:1 и т.д. События можно получать с нескольких объектов, указав их через запятую. Пример: objectId=CAM:1,PEOPLE_COUNTER:1 − вернутся события по камере 1 и по счётчику 1.

Если в параметре не задан Id объекта, то возвращаются события всех объектов заданного класса. Пример: objectId=CAM − вернутся события по всем камерам.

action

Тип события. Если параметр задан, то в ответе будут события только заданного типа.

Примеры: 

  • REC − начало записи
  • REC_STOP − остановка записи
  • ARM − постановка камеры на охрану
  • DISARM − снятие камеры с охраны
  • disconnected − потеря связи с камерой

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

GET http://127.0.0.1:8085/web2/secure/events?from=2021-05-26T14%3A30%3A30.000%2B03%3A00&to=2021-05-26T15%3A40%3A30.000%2B03%3A00&count=5&objectId=MACRO:7

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

XML:

<events>
	<event>
		<description>Action executed</description>
		<id>{3AED63A0-19BE-EB11-9020-B42E99FDB342}</id>
		<objectId>MACRO:7</objectId>
		<addInfo>event1</addInfo>
 		<params0>User 1</params0>   
		<params1>1</params1>
		<params2/>
		<params3/>
		<ts>2021-05-26T14:58:05+03:00</ts>
		<type>Empty</type>
	</event>
	<event>
		<description>Action executed</description>
		<id>{26840B9A-19BE-EB11-9020-B42E99FDB342}</id>
		<objectId>MACRO:7</objectId>
 		<addInfo>event2</addInfo> 
	   	params0>User 1</params0>
		<params1>1</params1>
		<params2/>
		<params3/>
		<ts>2021-05-26T14:58:04+03:00</ts>
		<type>Empty</type>
	</event>
</events>

JSON:

[
    {
        "id": "{3AED63A0-19BE-EB11-9020-B42E99FDB342}",
        "objectId": "MACRO:7",
        "ts": "2021-05-26T14:58:05.000+03:00",
        "description": "Action executed",
		"addInfo": "event1",
        "type": "Empty",
        "params2": "",
        "params3": "",
        "params1": "1",
        "params0": "User 1"
    },
    {
        "id": "{26840B9A-19BE-EB11-9020-B42E99FDB342}",
        "objectId": "MACRO:7",
        "ts": "2021-05-26T14:58:04.000+03:00",
        "description": "Action executed",          		
		"addInfo": "event2", 
		"type": "Empty",
        "params2": "",
        "params3": "",
        "params1": "1",
        "params0": "User 1"
    }
]

Коды возврата:

200 - OK
400 - неверный параметр (формат даты, например)
500 - ошибка
503 - ошибка соединения с ядром
504 - таймаут (ядро не вернуло данные в течение 2000 миллисекунд)

  • No labels