View Source

General request format:

GET http://IP-address:port/web2/secure/events/

Request parameters:

Parameter	Description
from	The oldest date of message search period. Example: 2012-12-27T15%3A19%3A16.000%2B03%3A00
to	The latest date of message search period. Example: 2012-12-27T15%3A19%3A16.000%2B03%3A00
count	Maximum number of messages in reply in the range [1, 200]. Default is 20. Server can return more messages if there are few messages in the database
objectId	Object id. Examples: CAM:1, GRAY:5 etc. If the parameter is not specified, events are returning for all objects
action	Event type. If the parameter is specified, then the response will contain only events of the specified type. Examples: REC − start recording REC_STOP − stop recording ARM − arming the camera DISARM − disarming the camera disconnected − loss of connection with the camera

Request example:

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

Response example:

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"
    }
]

Return codes:

200 − OK
400 − invalid parameter (e.g. date format)
500 − error
503 − error of core connection
504 − time-out (core failed to return data within 2000 milliseconds)