Create a new Geofence (Polygon)

Log in to see full request history

Purpose: Use this API to create a new Geofence.

📘

NOTE

You must provide information such as name, location co-ordinates (latitude and longitude), as well status information in the request body. Refer to the Body Parameters section for more info.

Sample Request Body

{ "name":"alpha", "category":"Fuel Station", "status":"active", "description": "notes of geofence", "location_points":[ { "lat":33.667893, "lon":73.062074 }, { "lat":33.665052, "lon":73.067689 }, { "lat":33.662428, "lon":73.061814 }, { "lat":33.666374, "lon":73.058196 }, { "lat":33.667893, "lon":73.062074 } ] }

Response Parameters

id

  • Type: Integer
  • Description: The unique identifier for the geofence.

name

  • Type: String
  • Description: The name of the geofence.

category

  • Type: String
  • Description: The category of the geofence, e.g., "Fuel Station".

status

  • Type: String
  • Description: The status of the geofence, e.g., "active".

address

  • Type: String
  • Description: The physical address associated with the geofence.

description

  • Type: String
  • Description: Denotes a brief note or a description with respect to the Geofence.

location_points

  • Type: Array of Objects
  • Description: A list of geographical points that define the boundaries of the geofence.

lat

  • Type: Float
  • Description: The latitude of a location point in the geofence.

lon

  • Type: Float
  • Description: The longitude of a location point in the geofence.

Body Params
string
required

Specify the name of the geofence that you are creating.

string
required

Specify the category for which you are creating the Geofence. Allowed values are: 'Uncategorized', 'Fuel Station', 'Job Site', 'Maintenance Facility', 'Receiver / Consignee', 'Restricted Location', 'Shipper', 'Terminal / Yard', 'Truck Stop / Rest Area', 'Weigh Station / Scale', 'Shipper / Receiver'

array of strings

Specify the latitude and the longitude of the Geofence. You must provide multiple latitudes and longitudes to form a polygon.

location_points
string
Defaults to active

Specify the status of the Geofence that you are creating. Allowed values are active or deactivated.

string

Provide a short description for the Geofence.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json