Page Comparison

...

Configuration Article | CA-20220907-TP-28

VDG Sense | API | Functions | Events

Image Modified

View file

name	CA-20220907-TP-28.pdf

Table of Contents

Note: This function requires an API license.

...

The parameters deviceid and serverid can be used to get events from a specific device (from a specific server).

Request

Code Block
command=getEvents&startid=[id]&starttime=[timestamp]&endtime=[timestamp]&types=[string]&limit=[number]&deviceid=[uid]&serverid=[uid]

parameter	type	remarks
startid	[id]	events with an id > startid are returned.
starttime	[timestamp]	events with a (local) timestamp >= startdate are returned.
endtime	[timestamp]	events with a (local) timestamp <= enddate are returned.
types	[string]	comma separated list of types the event must match, i.e. Alarm,SceneR.
limit	[number]	determines the limit of the resulting event count.
deviceid	[UID]	filters events from a specific device.
serverid	[UID]	filters events from a specific server.
ValueContains	[string]	Only returns events if the value of the event contains the text in this parameter
ValueEquals	[string]	Only returns events if the value of the event equals the text in this parameters
CarRLicensePlateFound only
parameter	type	remarks
licenseplate	[string]	events with the specified license plate are returned (Case sensitive)
licenseplatedistance	[number]	the number of characters that should match with the entered licenseplate. ( 0 = all chars should match; 1 = one char can differ, 2 = two chars can differ etc.)

#91;/table#93;

lt;result errorcode=quot;0">

lt;events

Response

Code Block

<events count=quot;&#91;number&#93;" lasteventid="&#91;UID&#93;">

lt;

eventgt;lt;eventidgt;<

result errorcode=quot;0">

<event>
<eventid></eventid>

lt;eventtypegt;<


<eventtype></eventtype>

lt;eventdescriptiongt;<


<eventdescription></eventdescription>

lt;eventvaluegt;<


<eventvalue></eventvalue>

lt;eventtimegt;<


<eventtime></eventtime>

lt;serveridgt;<


<serverid></serverid>

lt;serverdescriptiongt;<


<serverdescription></serverdescription>

lt;deviceidgt;<


<deviceid></deviceid>

lt;devicedescriptiongt;<


<devicedescription></devicedescription>

lt;


</

eventgt;

event>
...
lt;/eventsgt;
lt;/resultgt;

[table class="code-table table table-bordered" colwidth="15%	25%	60%"]
node	value	remarks
/result
@errorcode	[number]	See error codes below
/result/events
@count	[number]	The number of events.
lastEventId	[UID]	id of the last event.
/result/events/event
eventid		id of event.
eventype		type of event. (Available in API version < 2.7.1)
eventdescription		description of event.
eventvalue		value of event.
eventtime		Time stamp of event in UTC time.
serverid		Id of server where the event occurred.
serverdescription		Description of the server
deviceid		Id of device which triggered the event.
devicedescription		Description of the device

#91;/table#93;

#91;table class="code-table table table-bordered" colwidth="15%

25%

60%"#93;

error code	description	remarks
0	Ok	Ok, no error
-2	No device	No device found for the supplied camareaid/deviceid
-4	Invalid timestamp	Invalid datetime format. See Timestamp.

Example

Retrieve the last evenid..

To get the latest event id ommit the startid or give it a zero or negative value.
Command url:

Code Block

Code Block
command=getEvents&startid=0

Result:

Code Block

Code Block
<result errorcode="0"> <events count="0" lasteventid="39993299"> </events> </result>

Versions Compared

Old Version 3

New Version 4

Key

Request

Response

Example