Geofence
A zone the platform watches: a polygon or a circle, the employees it applies to, the hours it is active, and which crossings raise an event.
Stored in the GEOFENCE layer.
Fields
| Field | Required | What it is |
|---|---|---|
geofence_name | Yes | Name of the zone |
geofence_type | Yes | Where the zone was created from |
geofence_description | Free-text description | |
geofence_polygons | Yes | GeoJSON Polygon only. Entered directly, or generated from a centre point plus a radius |
geofence_geometry | The base geometry - the centre point for a circular zone | |
geofence_radius | Radius in metres, greater than 0. Circular zones only | |
geofence_trigger_type | Yes | Which crossings raise an event: IN, OUT, or both |
geofence_time_start | Yes | Start of the daily window the zone applies in |
geofence_time_end | Yes | End of that window. Must be after the start |
geofence_cron_expression | Schedule, if the zone should not apply every day | |
geofence_vehicle_query | The employees the zone applies to. Each username must exist in the tenant | |
geofence_is_enable | Yes | Whether the zone is active. Defaults to true |
geofence_workplace_type | Home or office, when the zone came from a workplace | |
geofence_id | Assigned by the platform |
Used by
Not used by any published API.
