Skip to main content

Geofence definition

bookmarkedboolean

Whether the object is bookmarked.

coordinatesarray[]

Coordinates obtained from the geometry

Possible values: >= 2, <= 2

creation_typestring

How the geofence has been created;

  • M manual;
  • A autogenerated internally;
  • F imported from file

Possible values: [A, F, M]

densitynumber<float>

Total trips per square kilometer

descriptionstring

An arbitrary description of the geofence.

geometry object

Geometry definition in GEOJson form

type stringrequired

Geometry definition in GEOJson form

Possible values: []

bboxnumber[]

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n, where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

keyinteger
namestring

User-friendly geofence name.

projectstring

URI of a project that this geofence belong to

statusstring

Enables or disables the geofence, where A stands for Active and I for Inactive.

Possible values: [A, I]

tagsstring[]

Geofence tags

tripsnumber | nullnullable

Total trips executed within the geofence

created_atstring<date-time>

Creation timestamp of an object

id object

Identifier of the object

anyOf
integer

Can be integer

modified_atstring<date-time>

Last modification timestampo of the object

resource_uristring<uri-reference>

URI of the object instance

Geofence definition
{
"bookmarked": true,
"coordinates": [
0
],
"creation_type": "A",
"density": 0,
"description": "string",
"geometry": {
"type": "Feature",
"bbox": [
0
]
},
"key": 0,
"name": "string",
"project": "string",
"status": "A",
"tags": [
"string"
],
"trips": 0,
"created_at": "2024-07-29T15:51:28.071Z",
"id": 0,
"modified_at": "2024-07-29T15:51:28.071Z",
"resource_uri": "string"
}