Geofences
Tenant Var Code
OK
A string that uniquely identifies the geofence
A string with geofence name
A whole number containing fence width in meters. Required for Polyline geofence
Minimum zoom level when geofence is shown
Maximum zoom level when geofence is shown
A floating point value for radius of circle geofence in meters. Required for Circular geofence
Type of geofence object. Valid values are: "circle", "polygon", "polyline"
Timestamp (UTC) indicating version of record being returned
Makes geofence applicable to sub-tenants
GET /V2/{tenantVarCode}/geofences HTTP/1.1
Accept: */*
OK
[
{
"GeofenceId": "text",
"Name": "text",
"FenceWidth": 1,
"MinZoom": 1,
"MaxZoom": 1,
"CircleRadius": 1,
"CircleCentre": {
"Lat": 1,
"Lon": 1
},
"PolygonPositions": [
[
{
"Lat": 1,
"Lon": 1
}
]
],
"PolylinePositions": [
{
"Lat": 1,
"Lon": 1
}
],
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"GeofenceType": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"AppliesToSubtenants": true
}
]Tenant code
A string that uniquely identifies the geofence
A string with geofence name
A whole number containing fence width in meters. Required for Polyline geofence
Minimum zoom level when geofence is shown
Maximum zoom level when geofence is shown
A floating point value for radius of circle geofence in meters. Required for Circular geofence
Type of geofence object. Valid values are: "circle", "polygon", "polyline"
Timestamp (UTC) indicating version of record being returned
Makes geofence applicable to sub-tenants
OK
No content
POST /V2/{tenantVarCode}/geofences HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 341
{
"GeofenceId": "text",
"Name": "text",
"FenceWidth": 1,
"MinZoom": 1,
"MaxZoom": 1,
"CircleRadius": 1,
"CircleCentre": {
"Lat": 1,
"Lon": 1
},
"PolygonPositions": [
[
{
"Lat": 1,
"Lon": 1
}
]
],
"PolylinePositions": [
{
"Lat": 1,
"Lon": 1
}
],
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"GeofenceType": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"AppliesToSubtenants": true
}OK
No content
Tenant Var Code
Geofence Id
OK
A string that uniquely identifies the geofence
A string with geofence name
A whole number containing fence width in meters. Required for Polyline geofence
Minimum zoom level when geofence is shown
Maximum zoom level when geofence is shown
A floating point value for radius of circle geofence in meters. Required for Circular geofence
Type of geofence object. Valid values are: "circle", "polygon", "polyline"
Timestamp (UTC) indicating version of record being returned
Makes geofence applicable to sub-tenants
GET /V2/{tenantVarCode}/geofences/{geofenceId} HTTP/1.1
Accept: */*
OK
{
"GeofenceId": "text",
"Name": "text",
"FenceWidth": 1,
"MinZoom": 1,
"MaxZoom": 1,
"CircleRadius": 1,
"CircleCentre": {
"Lat": 1,
"Lon": 1
},
"PolygonPositions": [
[
{
"Lat": 1,
"Lon": 1
}
]
],
"PolylinePositions": [
{
"Lat": 1,
"Lon": 1
}
],
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"GeofenceType": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"AppliesToSubtenants": true
}Tenant code
Geofence Id
A string that uniquely identifies the geofence
A string with geofence name
A whole number containing fence width in meters. Required for Polyline geofence
Minimum zoom level when geofence is shown
Maximum zoom level when geofence is shown
A floating point value for radius of circle geofence in meters. Required for Circular geofence
Type of geofence object. Valid values are: "circle", "polygon", "polyline"
Timestamp (UTC) indicating version of record being returned
Makes geofence applicable to sub-tenants
OK
No content
PUT /V2/{tenantVarCode}/geofences/{geofenceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 341
{
"GeofenceId": "text",
"Name": "text",
"FenceWidth": 1,
"MinZoom": 1,
"MaxZoom": 1,
"CircleRadius": 1,
"CircleCentre": {
"Lat": 1,
"Lon": 1
},
"PolygonPositions": [
[
{
"Lat": 1,
"Lon": 1
}
]
],
"PolylinePositions": [
{
"Lat": 1,
"Lon": 1
}
],
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"GeofenceType": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"AppliesToSubtenants": true
}OK
No content
Last updated