CREATE Geofence API

The create Geofence API is responsible for creating geofences for project, users or groups.

Create Geofence API

POST https://api.roam.ai/v1/api/geofence/

Headers

Name	Type	Description
Api-key	string	Auth-key E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5f

Request Body

Name	Type	Description
group_ids	array	Enables geofence for the list of users. If group_ids and user_ids are empty then geofence is enabled for all users of the project. E.g.- ["group1","group2"]
user_ids	array	Enables geofence for the list of users. If group_ids and user_ids are empty then geofence is enabled for all users of the project. E.g.-["user1","user2"]
coordinates	array	Mandatory for creating the geofence. E.g.- [ -72.28122, 42.926042 ]
metadata	object	An optional set of custom key-value pairs for the geofence.
geometry_type	string	Defines the type of geometry. E.g.- circle
geometry_radius	integer	Defines the radius of circular geofence in meters. Range 50m to 1000m. (Required only for geometry_type circle. Field value ignored if sent when geometry_type is a polygon.) E.g.- 50m to 1000m max
color_code	string	Defines the color of Geofence and how it is displayed on the dashboard. Type: Hex Code for CSS colors. Note: Pass the code without '#'. E.g.- ffffff
tag	string	Tag the Geofences for future reference and filtering. E.g.- hotel
description	string	Optional description for the geofence. E.g.- This is just a 5 star cool hotel where you can stay.
is_enabled	array	Array with first index depicting whether the geofence is enabled or disabled, second index depicting the start_time and last index depicting the end_time between which the geofence should be active. E.g.- [true,"2021-06-10T20:45:44", "2021-06-15T22:45:33"]

201

{
    "status": true,
    "msg": "Geofence created successfully.",
    "code": 201,
    "data": {
        "geofence_id": "5f73326ce5fc231ba4b253eb",
        "geometry_radius": 177,
        "geometry_center": {
            "type": "Point",
            "coordinates": [
                -72.28122,
                42.926042
            ]
        },
    "is_enabled": [true, "2021-06-10T18:45:00", "2021-06-10T19:29:00"],
    "user_ids": ["6bda16edea01848b3b419163"],
    "group_ids": ["5cda16edea00845b3b419173"],
    "created_at": "2020-09-29T13:11:08.702",
    "updated_at": "2020-09-29T13:11:08.702"
    }
}

Sample Request

curl --location --request POST 'https://api.roam.ai/v1/api/geofence/' \
--header 'Api-Key: e566c098cc6b441a9c3453b6fcf76e88' \
--header 'Content-Type: application/json' \
--data-raw '{
	"coordinates": [ -72.28122, 42.926042 ] ,
	"geometry_radius": 177,
	"description": "Roam Amsterdam HQ",
	"tag": "Office",
	"metadata": {},
  "user_ids": ["6bda16edea01848b3b419163"],
  "group_ids": ["5cda16edea00845b3b419173"],
	"is_enabled": [true, "2021-06-10T18:45:00", "2021-06-10T19:29:00"]
}'