Create Geofence

Create a Geofence

SecuritybearerAuth

Request

Request Body schema: application/json

name required	string or null Name for Geofence.
groupIdentifier	string or null Optional Group Id to provide that Geofence will be created under.
includeSubGroups	boolean Flag for Geofence to include all assets/vehicles in sub groups.
isInside required	boolean Flag to indicate whether geofence faces inside or outside.
isActive	boolean Flag to indicate whether to create the Geofence in the active or inactive state.
required	object
	Array of objects

Responses

200

400

Bad Request

401

Unauthorized.

403

Forbidden

404

Not Found

500

Internal Server Error.

post/v1/geofences

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"name": "San Diego",
"groupIdentifier": "5100FFFF-60B6-D7CD-3FA2-22CA712B0000",
"includeSubGroups": "false",
"isInside": "false",
"isActive": "true",
"geofenceGeography": {"radius": 5,
"shapeType": 3,
"points": [{"latitude": 0,
"longitude": 0
}
]
},
"assets": [{"assetId": "5100FFFF-60B6-D7CD-3FA2-22CA712B0000",
"assetType": "vehicle"
}
]
}

Response samples

application/json

{"geofenceId": "3F136C14-79C8-4BAA-B9DE-ADA9C0C68EBC",
"name": "San Diego 92120",
"rootGroupId": "2BB2D9B4-C801-E111-81CE-E61F13277AAB",
"groupId": "2BB2D9B4-C801-E111-81CE-E61F13277AAB",
"groupName": "Root Group",
"groupPath": "2BB2D9B4-C801-E111-81CE-E61F13277AAB\\\\2CB2D9B4-C801-E111-81CE-E61F13277AAB",
"includeSubGroups": true,
"isInside": true,
"geofenceGeography": {"radius": 25,
"shapeType": 3,
"points": [{"latitude": 0,
"longitude": 0
}
]
},
"color": "#800080",
"effectiveDaysOfWeek": "1,3,5",
"createdDate": "2024-06-28T15:31:42.8955131Z",
"assetGroupId": "2CB2D9B4-C801-E111-81CE-E61F13277AAB",
"assetIncludeSubGroups": false,
"assets": [{"assetId": "5100FFFF-60B6-D7CD-3FA2-22CA712B0000",
"assetType": "vehicle"
}
],
"effectiveStartTime": "15:00:00",
"effectiveEndTime": "05:59:00",
"effectiveTimezoneOffset": "-7:00"
}