API GPS Tracking Software. White Label | TeraTrack
This website uses cookies.
See our Privacy Policy to learn more.
Introduction
Welcome
Authentication
Device
Sensor
Service
Event
History
Alert
Custom event
Geofence
Route
Report
Map icon
Driver
Command
GPRS Template
SMS Template
Task
Setup

No resources found
Alert
GET /get_protocols
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
Responses application/json
object
object optional
id integer optional
value object optional
type integer optional
items array[object] optional
id string optional
value string optional
1 object optional
id integer optional
value object optional
type integer optional
items array[object] optional
status integer optional
{
  "0": {
    "id": 0,
    "value": {
      "type": 1,
      "items": [
        {
          "id": "osmand",
          "value": "osmand"
        }
      ]
    }
  },
  "1": {
    "id": 1,
    "value": {
      "type": 2,
      "items": []
    }
  },
  "status": 1
}
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
GET /get_alerts
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
Responses application/json
object
status integer optional
items object optional
alerts array[object] Validation {alert}
optional
id integer optional
user_id integer optional
active integer optional
name string optional
type string optional
created_at string optional
updated_at string optional
devices array[integer] optional
drivers array[integer] optional
geofences array[integer] optional
events_custom array[integer] optional
zone integer optional
zones array[object] optional
schedule boolean optional
schedules array[object] optional
id string optional
title string optional
items array[object] optional
id string optional
title string optional
active boolean optional
notifications object optional
sound object optional
active boolean optional
push object optional
active boolean optional
input string optional
sms object optional
active boolean optional
input string optional
webhook object optional
active boolean optional
input string optional
command null object optional
active integer boolean optional
type string optional
key null integer string boolean optional
{
  "status": 1,
  "items": {
    "alerts": [
      {
        "id": 1,
        "user_id": 2,
        "active": 1,
        "name": "Test event",
        "email": "",
        "mobile_phone": "",
        "overspeed_speed": "110",
        "overspeed_distance": "1",
        "ac_alarm": "0",
        "created_at": "2016-04-29 17:34:07",
        "updated_at": "2016-04-29 19:06:23",
        "devices": [
          3
        ],
        "drivers": [],
        "geofences": [
          {
            "id": "1",
            "zone": "1"
          },
          {
            "id": "1",
            "zone": "2"
          }
        ],
        "events_custom": []
      }
    ]
  }
}
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
GET /add_alert_data
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
Responses application/json
object
devices array[object] optional
id integer optional
value string optional
geofences array[object] optional
id integer optional
value string optional
alert_zones array[object] optional
id integer optional
value string optional
types array[object] optional
type string optional
title string optional
attributes array[object] optional
name string optional
type string Validation Allowed Values: integer, string, text, select, multiselect
optional
title string optional
default string array[integer] optional
options null array[object] optional
id integer string optional
value string optional
notifications array[object] optional
name string optional
active integer boolean optional
title string optional
input null string optional
description null string optional
schedules array[object] optional
id string Validation Allowed Values: monday, tuesday, wednesday, thursday, friday, saturday, sunday
optional
title string optional
items array[object] optional
id string optional
title string optional
active integer boolean optional
{
  "devices": [
    {
      "id": 3,
      "value": "Device name"
    }
  ],
  "geofences": [
    {
      "id": 1,
      "value": "Test geo"
    }
  ],
  "drivers": [
    {
      "id": 1,
      "value": "Drive first"
    },
    {
      "id": 2,
      "value": "Second drive name"
    }
  ],
  "alert_zones": [
    {
      "id": 1,
      "value": "Zone in"
    },
    {
      "id": 2,
      "value": "Zone out"
    }
  ],
  "alert_fuel_type": [
    {
      "id": 1,
      "value": "L"
    },
    {
      "id": 2,
      "value": "Gal"
    }
  ],
  "alert_distance": [
    {
      "id": 1,
      "value": "km"
    },
    {
      "id": 2,
      "value": "mi"
    }
  ],
  "event_types": [
    {
      "id": 1,
      "value": "Custom events"
    },
    {
      "id": 2,
      "value": "System events"
    }
  ],
  "event_protocols": [
    {
      "id": "-",
      "value": "- Protocol -"
    }
  ],
  "status": 1
}
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
POST /add_alert
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
Request Body multipart/form-data
object Validation {alertPost}
name string required
type string required
devices array[integer] required
zone integer Validation Allowed Values: 0, 1, 2
optional
zones array[integer] optional
schedule boolean optional
schedules array[object] optional
monday array[string] optional
tuesday array[string] optional
wednesday array[string] optional
thursday array[string] optional
friday array[string] optional
saturday array[string] optional
sunday array[string] optional
notifications object optional
sound object optional
active boolean optional
push object optional
active boolean optional
email object optional
active boolean optional
input string optional
sms object optional
active boolean optional
input string optional
webhook object optional
active boolean optional
input string optional
command object optional
active boolean optional
type string optional

															
Responses application/json
object Validation {success}
status integer optional

																	
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
GET /edit_alert_data
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
alert_id integer required
Responses application/json

																	
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
POST /edit_alert
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
Request Body multipart/form-data
object
id integer Validation {ObjectID}
required
name string Validation {alertPost}
required
type string Validation {alertPost}
required
devices array[integer] Validation {alertPost}
required
zone integer Validation {alertPost}
Allowed Values: 0, 1, 2
optional
zones array[integer] Validation {alertPost}
optional
schedule boolean Validation {alertPost}
optional
schedules array[object] Validation {alertPost}
optional
monday array[string] optional
tuesday array[string] optional
wednesday array[string] optional
thursday array[string] optional
friday array[string] optional
saturday array[string] optional
sunday array[string] optional
notifications object optional
sound object Validation {alertPost}
optional
active boolean optional
push object Validation {alertPost}
optional
active boolean optional
email object Validation {alertPost}
optional
active boolean optional
input string optional
sms object Validation {alertPost}
optional
active boolean optional
input string optional
webhook object Validation {alertPost}
optional
active boolean optional
input string optional
command object optional
active boolean Validation {alertPost}
optional
type string Validation {alertPost}
optional

															
Responses application/json
object Validation {success}
status integer optional

																	
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
GET /destroy_alert
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
alert_id integer required
Responses application/json
object Validation {success}
status integer optional

																	
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
GET /change_active_alert
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
Responses application/json

																	
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
GET /get_custom_events_by_device
Definition
Authentication
none(open)
API Key
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
Request Body
object
devices array[integer] optional

															
Responses
array[object]
key string optional
name string optional
items array[object] optional
id integer optional
value string optional

																	
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
GET /set_alert_devices
Definition
Query String
lang string Validation default: en required
user_api_hash string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS required
alert_id integer required
Request Body
object
devices array[integer] required

															
Responses
object
status integer optional

																	
object
status integer optional
errors object optional
{
  "status": 0,
  "errors": {}
}
object
status integer optional
error string optional
{
  "status": 0,
  "error": "No language selected."
}

																	
MODEL alertPost
You also need to submit the attributes of the selected type.
object
name string required
type string required
devices array[integer] required
zone integer Validation Allowed Values: 0, 1, 2
optional
array[integer] optional
schedule boolean optional
schedules array[object] optional
monday array[string] optional
tuesday array[string] optional
wednesday array[string] optional
thursday array[string] optional
friday array[string] optional
saturday array[string] optional
sunday array[string] optional
notifications object optional
sound object optional
active boolean optional
push object optional
active boolean optional
email object optional
active boolean optional
input string optional
sms object optional
active boolean optional
input string optional
webhook object optional
active boolean optional
input string optional
command object optional
active boolean optional
type string optional

															
MODEL alert
object
id integer optional
user_id integer optional
active integer optional
name string optional
type string optional
created_at string optional
updated_at string optional
devices array[integer] optional
drivers array[integer] optional
geofences array[integer] optional
events_custom array[integer] optional
zone integer optional
zones array[object] optional
schedule boolean optional
schedules array[object] optional
id string optional
title string optional
items array[object] optional
id string optional
title string optional
active boolean optional
notifications object optional
sound object optional
active boolean optional
push object optional
active boolean optional
email object optional
active boolean optional
input string optional
sms object optional
active boolean optional
input string optional
webhook object optional
active boolean optional
input string optional
command null object optional
active integer boolean optional
type string optional
key null integer string boolean optional