API GPS Tracking Software. White Label

Geofence

GET /get_geofences

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Responses application/json

200 400 401 500

Schema
Example
expand all

object
items	object	optional
object
geofences	array[object] Validation {geofence}	optional
id	integer	optional
type	string Validation Allowed Values: polygon, circle	optional
user_id	integer	optional
group_id	null integer	optional
active	integer	optional
name	string	optional
center	object Validation {LatLng}	optional
lat	number	optional
lng	number	optional
radius	null number	optional
coordinates	string array[object] Validation {LatLng}	optional
lat	number	optional
lng	number	optional
polygon_color	string	optional
created_at	string	optional
updated_at	string	optional
status	integer Validation {success}	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

POST /add_geofence

"polygon" first and last coordinate must be the same as it closes Polygone.

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Request Body multipart/form-data

schema
Example
expand all

object
name	string Validation {geofencePost}	required
polygon_color	string Validation {geofencePost}	required
polygon	array[object] Validation {LatLng}	required
lat	number	optional
lng	number	optional
group_id	integer Validation {geofencePost}	optional
type	string Validation {geofencePost} Allowed Values: polygon, circle	required
center	object Validation {LatLng}	optional
lat	number	optional
lng	number	optional
radius	number Validation {geofencePost}	optional

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

{
  "status": 1
}

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

POST /edit_geofence

"polygon" first and last coordinate must be the same as it closes Polygone.

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Request Body multipart/form-data

schema
Example
expand all

object
id	integer Validation {ObjectID}	required
name	string Validation {geofencePost}	required
polygon_color	string Validation {geofencePost}	required
polygon	array[object] Validation {LatLng}	required
lat	number	optional
lng	number	optional
group_id	integer Validation {geofencePost}	optional
type	string Validation {geofencePost} Allowed Values: polygon, circle	required
center	object Validation {LatLng}	optional
lat	number	optional
lng	number	optional
radius	number Validation {geofencePost}	optional

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

{
  "status": 1
}

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

GET /destroy_geofence

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required
geofence_id	integer	required

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

GET /change_active_geofence

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Request Body

schema
Example
expand all

object
id	integer array[integer]	optional
active	boolean	optional

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status		optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

MODEL geofence

schema
Example
expand all

object
id	integer	optional
type	string Validation Allowed Values: polygon, circle	optional
user_id	integer	optional
group_id	null integer	optional
active	integer	optional
name	string	optional
center	object Validation {LatLng}	optional
lat	number	optional
lat	number	optional
radius	null number	optional
coordinates	string array[object] Validation {LatLng}	optional
lat	number	optional
lng	number	optional
polygon_color	string	optional
created_at	string	optional
updated_at	string	optional

MODEL geofencePost

schema
Example
expand all

object
name	string	required
polygon_color	string	required
polygon	array[object] Validation {LatLng}	required
lat	number	optional
lng	number	optional
group_id	integer	optional
type	string Validation Allowed Values: polygon, circle	required
center	object Validation {LatLng}	optional
lat	number	optional
lng	number	optional
radius	number	optional

{
  "type": "polygon",
  "name": "Geofence name",
  "polygon_color": "#d000df",
  "polygon": [
    {
      "lat": 54.9287200680115,
      "lng": 23.8787841796875
    },
    {
      "lat": 54.95001975516275,
      "lng": 23.93268585205078
    },
    {
      "lat": 54.91550070170091,
      "lng": 23.94092559814453
    },
    {
      "lat": 54.901882187385006,
      "lng": 23.89251708984375
    }
  ],
  "group_id": 2
}

	Previous
	Custom event

Next
Route

Platform

Applications

Resources

Company

This website uses cookies.
See our Privacy Policy to learn more.

Welcome

Authentication

Device

Sensor

Service

Event

History

Alert

Custom event

Geofence

Route

Report

Map icon

Driver

Command

GPRS Template

SMS Template

Task

Setup

Platform

Applications

Resources

Company