ForecastedEvent

A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon.

EventId

The forecasted event identifier.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

EventType

The event type, forecasting three states for which a device can be in relative to a geofence:

ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE: If a device is inside of a geofence, and the device is not moving.

Type: String

Valid Values: ENTER | EXIT | IDLE

Required: Yes

GeofenceId

The geofence identifier pertaining to the forecasted event.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\p{L}\p{N}]+

Required: Yes

IsDeviceInGeofence

Indicates if the device is located within the geofence.

Type: Boolean

Required: Yes

NearestDistance

The closest distance from the device's position to the geofence.

Type: Double

Valid Range: Minimum value of 0.

Required: Yes

ForecastedBreachTime

The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Type: Timestamp

Required: No

GeofenceProperties

The geofence properties.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 3 items.

Key Length Constraints: Minimum length of 1. Maximum length of 20.

Value Length Constraints: Minimum length of 1. Maximum length of 40.

Required: No

ForecastedEvent

Contents

See Also