*getEventTypes
- Tom Polman
Configuration Article | CA-20220907-TP-27 VDG Sense | API | Functions | Events  |  |
Note: This function requires an API license.
Obtains a list of all supported event types. The lists consists of name, description and level pairs. The name can be used in getEvents.
The usability level is only to get a global indication of how often the event will occur. A value of zero will indicate a normal, most common, event. A higher number indicates a less occurring event, which possibly only occurs in special circumstances.
Request
command=getEventTypes |
Response
<result errorcode="0">
<eventtypes count="[number]">
<eventtype>
<name>[string]</name>
<description>[string]</description>
<level>[number]</level>
</eventtype>
...
</eventtypes>
</result> |
node | value | remarks |
|---|---|---|
/result | ||
@errorcode | [number] | See error codes here |
/result/eventtypes | ||
@count | [number] | The number of event types. |
/result/eventtypes/eventtype | ||
name | [string] | The name, as used in getEvents. |
description | [string] | A system defined description of the event type.. |
level | [number] | A usability level number, 0 = normal, 1 = system and user, 2 = other |
Changelog
1.10.2 – added