Devices Events: GetDeviceEventsConfigGets new device details and/or configuration Events

See Also

Usage Notes

Device Events use the same XML format as the Device node, however only differential nodes and attributes are returned.

Events are broken down into multiple categories; general, configuration, inventory, man-down, and messaging. For a full list of event types, see the APISystemEventsList method.

The GetDeviceEvents method returns all position, wiring, and virtual event details, as well as a list of all system events including those of those types. Position events occur when a new GPS reading is received, Wiring events occur when the state of a wire changes based on the device's behaviour profile, and virtual events occur as a result of the system interpreting values.

The list of all types is returned as the Events child. It's important to inspect the events types list for additional types, then to query for only those additional event. The methods to retrieve the details of from the other event types are GetDeviceEventsConfig, GetDeviceEventsInventory, GetDeviceEventsManDown, and GetDeviceEventsMessage.

Virtual events are things like synchronization (changing name, icon, fleet, etc), changing mode, changing motion type, having an Out-Of-Date position, or lingering within a zone or close to a location for too long.

Example of Returned Data

<GetDeviceEventsConfig Success="?" Message="">
<Device ID="#">
<Events>
<SystemType ID="#" EventID="#" GMTEvent="yyyy-MM-dd HH:mm:ss.fff" />
<SystemType ID="#" EventID="#" GMTEvent="yyyy-MM-dd HH:mm:ss.fff" />
<!-- etc -->
</Events>
<Details DeviceTypeID="#" Model="" Identifier="" Firmware="" IPAddress="#.#.#.#" PhoneNumber="#" CarrierID="#" InstanceID="#" />
<Configuration DestinationID="#" OdometerEnabled="?" EngineHoursEnabled="?" StoppedEnabled="#" StoppedInterval="#" MovingEnabled="?" MovingInterval="#" SnFEnabled="?" MemorySize="#" SleepEnabled="?" SleepDelay="#" SleepWireNumber="#" ShutDownDelay="#">
<DI Number="#" Enabled="?" />
<DI Number="#" Enabled="?" />
<!-- etc -->
<AI Number="#" Enabled="?" Low="#" High="#" />
<AI Number="#" Enabled="?" Low="#" High="#" />
<!-- etc -->
</Configuration>
<TrackMode Enabled="?" Interval="#" Days="???????" StartTime="HH:mm:ss.fff" EndTime="HH:mm:ss.fff" TimezoneID="#" OffsetMinutes="#" Count="#" />
</Device>
<Device ID="#">
<Events>
<SystemType ID="#" EventID="#" GMTEvent="yyyy-MM-dd HH:mm:ss.fff" />
<SystemType ID="#" EventID="#" GMTEvent="yyyy-MM-dd HH:mm:ss.fff" />
<!-- etc -->
</Events>
<Details DeviceTypeID="#" Model="" Identifier="" Firmware="" IPAddress="#.#.#.#" PhoneNumber="#" CarrierID="#" InstanceID="#" />
<Configuration DestinationID="#" OdometerEnabled="?" EngineHoursEnabled="?" StoppedEnabled="#" StoppedInterval="#" MovingEnabled="?" MovingInterval="#" SnFEnabled="?" MemorySize="#" SleepEnabled="?" SleepDelay="#" SleepWireNumber="#" ShutDownDelay="#">
<DI Number="#" Enabled="?" />
<DI Number="#" Enabled="?" />
<!-- etc -->
<AI Number="#" Enabled="?" Low="#" High="#" />
<AI Number="#" Enabled="?" Low="#" High="#" />
<!-- etc -->
</Configuration>
<TrackMode Enabled="?" Interval="#" Days="???????" StartTime="HH:mm:ss.fff" EndTime="HH:mm:ss.fff" TimezoneID="#" OffsetMinutes="#" Count="#" />
</Device>
<!-- etc -->
</GetDeviceEventsConfig>

Test Method