*Events (API References)
- Tom Polman
Configuration Article | CA-20220907-TP-78 VDG Sense | API | References  |  |
Below is a summary of the events types that can be given to the command getEvents. These event types are the values for the comma separated string list of the tag types. All events that match one of the supplied types are returned (if they also match the other filters). If the parameter types is omitted from the request, all events are returned.
Use getEventTypes to obtain the server’s actual supported event types list.
Version | Category | Remarks | Event types |
|---|---|---|---|
1.3.2 | Alarm | Alarm input events. | AlarmInput1, AlarmInput2, AlarmInput3, AlarmInput4, AlarmInputHigh, AlarmInputLow, CamAlarmInputHigh, CamAlarmInputLow |
1.3.2 | CarR | License plate found & match events. | CarRLicensePlateFound, CarRMatch |
1.3.1 | Connection | Connection loss and restore events. | ConnectionLost, Reconnect, ServerConnectionLost, VideoLost, VideoRestored |
1.3.2 | FaceR | Face found & match events. | FaceRFaceFound, FaceRMatch |
1.10.1 | Generic | The generic event | GenericEvent |
1.3.1 | Motion | Motion events | Motion |
1.3.1 | ObjectR | All ObjectR events | ObjectRRule1, ObjectRRule2, ObjectRRule3, ObjectRRule4, ObjectRRule5, ObservionEvent |
1.10.1 | Other | Uncategorized events | StateRequest, UserButtonClick, UserButtonDblClick |
1.3.2 | Pos | Point of sale events (gas stations) | POSNozzleOut, POSNozzleIn, POSFillingStarted, POSFillingEnded |
1.3.8 | SceneR | All SceneR events | SceneRAngleChange, SceneRSceneLoss, SceneRAngleChangeReference, SceneRSceneLossReference |
1.10.1 | System | System specific events | NoRecording, DivaNotClosedGracefully, SystemStateOk, SystemStateError, ReRecording, CameraBlocked, CameraNormal, SystemEvent, ClientConnectionLost, ClientConnectionRestored |
Event Result Fields
Below is a summary of the events fields as result of command getEvents.
Version | Name | Remarks |
|---|---|---|
1.3.1 | eventid | Unique event id. |
1.3.1 | eventtype | Number indicating the event type. |
1.3.2 | eventdescription | Description of the event. |
1.3.1 | eventvalue | Value of the event, like motion or alarm input. |
1.3.8 | eventtime | Time stamp of event. |
1.3.2 | serverid | Id of server where the event occurred. |
1.3.2 | serverdescription | Description of the server. |
1.3.1 | deviceid | Id of device which triggered the even. |
1.3.2 | devicedescription | Description of the device. |
Event Result Values
Below is a summary of possible values for the event result fields. The eventvalue column describes the values for the event. Multiple values are separated by a comma. If a comma is part of the value, that value will be a double quoted (“value”) value.
Double quotes in a quoted value will be doubled (“value with “”quotes””, great!”).
Version | eventtype | eventdescription | eventvalue |
|---|---|---|---|
1.3.0 | 0 | AlarmInput1 | n/a |
1.3.0 | 1 | AlarmInput2 | n/a |
1.3.0 | 2 | AlarmInput3 | n/a |
1.3.0 | 3 | AlarmInput4 | n/a |
1.3.0 | 4 | ConnectionLost | n/a |
1.3.0 | 5 | Motion | Percentage of motion 0% – 100% |
1.3.0 | 6 | ObjectRRule1 | Event text |
1.3.0 | 7 | ObjectRRule2 | Event text |
1.3.0 | 8 | ObjectRRule3 | Event text |
1.3.0 | 9 | ObjectRRule4 | Event text |
1.3.0 | 10 | ObjectRRule5 | Event text |
1.3.0 | 11 | SceneRCameraAngleChange | n/a |
1.3.0 | 12 | SceneRSceneLoss | n/a |
1.3.0 | 13 | SceneRCameraAngleChangeRef | n/a |
1.3.0 | 14 | SceneRSceneLossRef | n/a |
1.3.0 | 15 | FaceRMatch | Percentage of recognition 0% – 100% , Person name |
1.3.0 | 16 | Reconnect | n/a |
1.3.0 | 17 | FaceRFaceFound | Reliability of found face 0% – 100% |
1.3.0 | 18 | CarRLicensePlateFound | License plate, country, confidence (0 – 100%) |
1.3.0 | 19 | CarRMatch | Person name |
1.3.0 | 20 | reserved |
|
1.3.0 | 21 | USBAlarmInput | Alarm number |
1.3.0 | 22 | USBAlarmInputHigh | n/a |
1.3.0 | 23 | USBAlarmInputLow | n/a |
1.3.0 | 24 | reserved |
|
1.3.0 | 25 | reserved |
|
1.3.0 | 26 | reserved |
|
1.3.0 | 27 | reserved |
|
1.3.0 | 28 | reserved |
|
1.3.0 | 29 | reserved |
|
1.3.0 | 30 | reserved |
|
1.3.0 | 31 | reserved |
|
1.3.0 | 32 | POSNozzleOut | Pump number |
1.3.0 | 33 | POSNozzleIn | Pump number |
1.3.0 | 34 | POSFillingStarted | Pump number |
1.3.0 | 35 | reserved |
|
1.3.0 | 36 | reserved |
|
1.3.0 | 37 | reserved |
|
1.3.0 | 38 | reserved |
|
1.3.0 | 39 | reserved |
|
1.3.0 | 40 | reserved |
|
1.3.0 | 41 | reserved |
|
1.3.0 | 42 | DivaNotClosedGracefully | Timestamp |
1.3.0 | 43 | NoRecording | Timestamp of last recorded image |
1.4.1 | 44 | XMLKeepAlive | n/a |
1.4.1 | 45 | CameraBlocked | n/a |
1.4.1 | 46 | CameraNormal | n/a |
1.4.1 | 47 | StateRequest | n/a |
1.6.1 | 48 | ServerConnectionLost | n/a |
1.6.1 | 49 | AlarmInputHigh | n/a |
1.6.1 | 50 | AlarmInputLow | n/a |
1.6.1 | 51 | VideoLost | n/a |
1.6.1 | 52 | VideoRestored | n/a |
1.6.1 | 53 | SystemEvent | Error number |
1.6.1 | 54 | reserved |
|
1.6.1 | 55 | reserved |
|
1.6.1 | 56 | reserved |
|
1.6.1 | 57 | reserved |
|
1.6.1 | 58 | reserved |
|
1.6.1 | 59 | reserved |
|
1.6.1 | 60 | reserved |
|
1.6.1 | 61 | reserved |
|
1.6.1 | 62 | reserved |
|
1.8.1 | 63 | SystemStateOk | n/a |
1.8.1 | 64 | SystemStateError | n/a |
1.8.1 | 65 | reserved |
|
1.8.1 | 66 | reserved |
|
1.8.1 | 67 | ReRecording | n/a |
1.9.1 | 68 | CamAlarmInputHigh | Alarm number |
1.9.1 | 69 | CamAlarmInputLow | Alarm number |
1.10.1 | 70 | GenericEvent | n/a |
1.11.1 | 71 | ObservisionEvent | shape |
1.11.1 | 72 | reserved | n/a |
1.11.1 | 73 | reserved | n/a |
2.3.1 | 74 | SystemFailover | n/a |
2.3.1 | 75 | MacroExecute | n/a |
2.3.1 | 76 | UserLoggedInEvent | n/a |
2.3.1 | 77 | OperatorEvent | n/a |
2.3.1 | 78 | TraficonEvent | n/a |
2.3.1 | 79 | PluginRule | n/a |
2.6.1 | 80 | reserved | n/a |
2.6.1 | 81 | SiquraVCA | triggered shape name |
2.6.1 | 82 | SystemRestore | information about the restored system |
2.6.1 | 83 | ServerConnectionRestored |
|
2.6.1 | 84 | reserved | n/a |
2.6.1 | 85 | reserved | n/a |
2.7.1 | 86 | ClientConnectionLost |
|
2.7.1 | 87 | ClientConnectionRestored |
|