Tracking Software

Base URL: http://127.0.0.1/api
172
Endpoints
28
Tags
44
Schemas

Welcome

This is a place to put general notes and extra information, for internal use.

To get started designing/documenting this API, select a version on the left. # Title
No Description

Authentication

SchemeTypeDetails
user_api_hashapiKeyin: query, name: user_api_hash

Address

Address

GET http://127.0.0.1/api/address
Get geofence name or address from coordinate
operationId: get-address

Geofence name is returned if "Display geofence name instead of geo address" plugin is enabled and geofence which contains provided coordinate is found. Otherwise address that matches the coordinate is returned.

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
lat requirednumber

Latitude

lng requirednumber

Longitude

Responses

200
string
GET http://127.0.0.1/api/address/autocomplete
Get autocompleted addresses list
operationId: get-address-autocomplete

Get autocompleted addresses list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
q requiredstring

Phrase to be sought for in addresses

Responses

200
array[→ address]
GET http://127.0.0.1/api/address/reverse
Resolve address from coordinate
operationId: get-address-reverse

Resolve address from coordinate

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
lat requirednumber

Latitude

lng requirednumber

Longitude

Responses

200
FieldTypeDescription
status integer
location → address

Admin Companies

Admin Companies

GET http://127.0.0.1/api/admin/companies
Get companies list
operationId: get-admin-companies

Get companies list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
search_phrase string

Value to be detected in properties

property string

Value to search in 'property' field

limit integer

Items per page

sorting[sort_by] string

Column to sort by

sorting[sort] string

Sort direction

Responses

200
FieldTypeDescription
current_page integer
data array[any]
first_page_url string
from integer
last_page integer
last_page_url string
links array[any]
next_page_url string | null
path string
per_page integer
prev_page_url string | null
to integer
total integer
application/json
{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "name": "company",
      "vat_number": "",
      "registration_code": "",
      "address": "",
      "comment": "",
      "created_at": "2023-10-17 12:54:23",
      "updated_at": "2023-10-17 12:54:23",
      "user_id": null
    }
  ],
  "first_page_url": "/api/admin/companies?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "/api/admin/companies?page=1",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "/api/admin/companies?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "/api/admin/companies",
  "per_page": 50,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}
POST http://127.0.0.1/api/admin/companies
Create company
operationId: post-admin-companies

Create company

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
name string
vat_number string
registration_code string
address string
comment string

Responses

200
GET http://127.0.0.1/api/admin/companies/{id}
Get company
operationId: get-admin-companies-id

Get company

Request

Path Parameters

NameTypeDescription
id requiredstring

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
id integer
name string
var_number string
registration_code string
address string
comment string
created_at string
updated_at string
user_id integer
application/json
{
  "id": 2,
  "name": "test man",
  "vat_number": "",
  "registration_code": "",
  "address": "",
  "comment": "",
  "created_at": "2023-10-17 12:54:32",
  "updated_at": "2023-10-17 12:54:32",
  "user_id": 2
}
PUT http://127.0.0.1/api/admin/companies/{id}
Update company
operationId: put-admin-companies-id

Update company

Request

Path Parameters

NameTypeDescription
id requiredstring

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
name string
vat_number string
registration_code string
address string
comment string

Responses

200
DELETE http://127.0.0.1/api/admin/companies/{id}
Delete company
operationId: delete-admin-companies-id

Delete company

Request

Path Parameters

NameTypeDescription
id requiredstring

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200

Admin Devices

Admin Devices

GET http://127.0.0.1/api/admin/device/{device}
Get device
operationId: get-admin-device-device

Get device

Request

Path Parameters

NameTypeDescription
device requiredinteger

Device ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
data object
application/json
{
  "status": 1,
  "data": {
    "id": 3,
    "active": true,
    "name": "Demo 1",
    "imei": "100000001",
    "sim_number": "",
    "device_model": "",
    "plate_number": "",
    "vin": "",
    "registration_number": "",
    "object_owner": "",
    "additional_notes": "",
    "protocol": "homtecs",
    "expiration_date": null,
    "icon_colors": {
      "moving": "green",
      "stopped": "yellow",
      "offline": "red",
      "engine": "yellow"
    },
    "icon_id": 0,
    "timezone_id": null,
    "fuel_measurement_id": 1,
    "fuel_quantity": 0,
    "fuel_price": 0,
    "tail_length": 5,
    "tail_color": "#33cc33",
    "min_moving_speed": 6,
    "min_fuel_fillings": 10,
    "min_fuel_thefts": 10,
    "gprs_templates_only": 0,
    "detect_engine": "gps",
    "engine_hours": "gps",
    "engine_status": null,
    "stop_duration": "19min 59s",
    "stop_duration_sec": 1199,
    "total_distance": 5409.39,
    "moved_timestamp": 1702979729,
    "inaccuracy": null
  }
}
POST http://127.0.0.1/api/admin/device/{device}/expiration
Change device expiration date
operationId: post-admindevice-device-expiration

Change device expiration date

Request

Path Parameters

NameTypeDescription
device requiredstring

Device ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
expiration_date integer

Responses

200
POST http://127.0.0.1/api/admin/device/{device}/status
Change device 'active' status
operationId: post-admin-device-device-status

Change device 'active' status

Request

Path Parameters

NameTypeDescription
device requiredstring

ID or IMEI

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
active integer

Responses

200
POST http://127.0.0.1/api/admin/device/{device}/user
Assign user to device
operationId: post-device-device-user

Assign user to device

Request

Path Parameters

NameTypeDescription
device requiredstring

ID or IMEI

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
user_id integer
email string

Responses

200
DELETE http://127.0.0.1/api/admin/device/{device}/user
Revoke user from device
operationId: delete-device-device-user

Revoke user from device

Request

Path Parameters

NameTypeDescription
device requiredstring

ID or IMEI

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
GET http://127.0.0.1/api/admin/device/{device}/users
Get device users list
operationId: get-device-id-users

Get device users list

Request

Path Parameters

NameTypeDescription
device requiredstring

Device ID

Query Parameters

NameTypeDescription
limit integer

Items per page

Responses

200
FieldTypeDescription
status integer
data array[
FieldTypeDescription
id integer
email string
active integer
]
pagination → pagination_compact
application/json
{
  "status": 1,
  "data": [
    {
      "id": 7,
      "email": "test@compaany.com",
      "active": 1
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 30,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null
  }
}
GET http://127.0.0.1/api/admin/devices
Get devices list
operationId: get-admin-devices

Get devices list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
s string

Value to be detected in properties

property string

Value to search in 'property' field

includes array[]

Relations to include

limit integer

Items per page

Responses

200
FieldTypeDescription
status integer
data array[→ device_lookup]
pagination → pagination_compact
application/json
{
  "status": 1,
  "data": [
    {
      "id": 3,
      "active": true,
      "name": "Demo 1",
      "imei": "100000001",
      "sim_number": "",
      "device_model": "",
      "plate_number": "",
      "vin": "",
      "registration_number": "",
      "object_owner": "",
      "additional_notes": "",
      "protocol": "homtecs",
      "expiration_date": null
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 50,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null
  }
}

Admin User

Admin User

POST http://127.0.0.1/api/admin/client
Create client
operationId: post-client

Create client

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
active boolean
email string
phone_number string
manager_id integer
billing_plan_id integer
perms object
objects array[integer]
account_created boolean

Determines if send email notification that account is created

email_verification boolean

Determines if email verification is required

password_generate boolean

Determines if password is generated or typed in manually

password string
password_confirmation string

Value must be the same as 'password'

available_maps array[integer]
group_id integer

1 - Admin, 2 - User, 3 - Manager, 4 - Demo, 5 - Operator, 6 - Supervisor

enable_expiration_date boolean
expiration_date string | null
enable_devices_limit boolean
devices_limit integer

Responses

200
application/json
{
  "status": 1,
  "item": {
    "id": 1,
    "active": 1,
    "group_id": 1,
    "manager_id": null,
    "billing_plan_id": null,
    "map_id": 2,
    "devices_limit": null,
    "email": "admin@gpsserver.com",
    "phone_number": "",
    "subscription_expiration": "0000-00-00 00:00:00",
    "loged_at": "2023-12-19 07:39:38",
    "api_hash_expire": null,
    "available_maps": [
      "2"
    ],
    "sms_gateway_app_date": "0000-00-00 00:00:00",
    "sms_gateway_params": {
      "request_method": "get",
      "authentication": "0",
      "username": "",
      "password": "",
      "encoding": "0",
      "auth_id": "",
      "auth_token": "",
      "senders_phone": "",
      "custom_headers": ""
    },
    "ungrouped_open": {
      "geofence_group": 1,
      "device_group": 1,
      "poi_group": 1,
      "route_group": 1
    },
    "week_start_day": 1,
    "top_toolbar_open": 1,
    "map_controls": [],
    "created_at": null,
    "updated_at": "2023-12-19 07:39:38",
    "unit_of_altitude": "mt",
    "lang": "en",
    "unit_of_distance": "km",
    "unit_of_capacity": "lt",
    "duration_format": "standart",
    "timezone_id": 73,
    "sms_gateway": 0,
    "sms_gateway_url": "",
    "settings": {
      "listview": {
        "columns": [
          {
            "field": "name",
            "class": "device"
          },
          {
            "field": "status",
            "class": "device"
          },
          {
            "field": "time",
            "class": "device"
          },
          {
            "field": "position",
            "class": "device"
          }
        ],
        "groupby": "protocol"
      },
      "widgets": {
        "default": "1"
      },
      "dashboard": {
        "enabled": "0",
        "blocks": {
          "device_activity": {
            "enabled": "1"
          },
          "latest_events": {
            "enabled": "1"
          },
          "device_status_counts": {
            "enabled": "1"
          },
          "latest_tasks": {
            "enabled": "1"
          },
          "device_distance": {
            "enabled": "1"
          },
          "device_overview": {
            "enabled": "0"
          }
        }
      }
    },
    "login_periods": null,
    "email_verified_at": "2023-09-25 07:45:33",
    "client_id": 3,
    "company_id": null,
    "only_one_session": 0
  }
}
PUT http://127.0.0.1/api/admin/client
Update client
operationId: put-client

Update client

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
active boolean
email string
phone_number string
manager_id integer
billing_plan_id integer
perms object
objects array[integer]
account_created boolean

Determines if send email notification that account is created

email_verification boolean

Determines if email verification is required

password_generate boolean

Determines if password is generated or typed in manually

password string
password_confirmation string

Value must be the same as 'password'

available_maps array[integer]
group_id integer

1 - Admin, 2 - User, 3 - Manager, 4 - Demo, 5 - Operator, 6 - Supervisor

enable_expiration_date boolean
expiration_date string | null
enable_devices_limit boolean
devices_limit integer

Responses

200
POST http://127.0.0.1/api/admin/client/status
Update client 'active' status
operationId: post-admin-client-status

Update client 'active' status

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer

Required without email

email string

Required without id

status boolean

Responses

200
DELETE http://127.0.0.1/api/admin/client/{id}
Delete client
operationId: delete-admin-client-id

Delete client

Request

Path Parameters

NameTypeDescription
id requiredstring

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
GET http://127.0.0.1/api/admin/client/{id}/devices
Get user devices list
operationId: get-user-id-devices

Get user devices list

Request

Path Parameters

NameTypeDescription
id requiredstring

ID

Query Parameters

NameTypeDescription
limit integer

Items per page

Responses

200
FieldTypeDescription
status integer
data array[
FieldTypeDescription
id integer
name string
]
pagination → pagination_compact
application/json
{
  "status": 1,
  "data": [
    {
      "id": 1,
      "name": "Device 1"
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 30,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null
  }
}
GET http://127.0.0.1/api/admin/clients
Get clients list
operationId: get-admin-clients

Get clients list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
search_phrase string

Value to be detected in properties

filter array[]

Key-value array of properties and searched values

search_device string

Device IMEI

includes array[]

Relations to include. Available: client, permissions

limit integer

Items per page

sort_by string

Column to sort by

sort string

Sort direction

Responses

200
FieldTypeDescription
current_page integer
data array[any]
first_page_url string
from integer
last_page integer
last_page_url string
links array[any]
next_page_url string | null
path string
per_page integer
prev_page_url string | null
to integer
total integer
application/json
{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "active": 1,
      "group_id": 1,
      "manager_id": null,
      "billing_plan_id": null,
      "map_id": 2,
      "devices_limit": null,
      "email": "admin@gpsserver.com",
      "phone_number": "",
      "subscription_expiration": "0000-00-00 00:00:00",
      "loged_at": "2023-12-19 08:48:26",
      "api_hash_expire": null,
      "available_maps": [
        "2"
      ],
      "sms_gateway_app_date": "0000-00-00 00:00:00",
      "sms_gateway_params": {
        "request_method": "get",
        "authentication": "0",
        "username": "",
        "password": "",
        "encoding": "0",
        "auth_id": "",
        "auth_token": "",
        "senders_phone": "",
        "custom_headers": ""
      },
      "ungrouped_open": {
        "geofence_group": 1,
        "device_group": 1,
        "poi_group": 1,
        "route_group": 1
      },
      "week_start_day": 1,
      "top_toolbar_open": 1,
      "map_controls": [],
      "created_at": null,
      "updated_at": "2023-12-19 08:48:26",
      "unit_of_altitude": "mt",
      "lang": "en",
      "unit_of_distance": "km",
      "unit_of_capacity": "lt",
      "duration_format": "standart",
      "timezone_id": 73,
      "sms_gateway": 0,
      "sms_gateway_url": "",
      "settings": {
        "listview": {
          "columns": [
            {
              "field": "name",
              "class": "device"
            },
            {
              "field": "status",
              "class": "device"
            },
            {
              "field": "time",
              "class": "device"
            },
            {
              "field": "position",
              "class": "device"
            }
          ],
          "groupby": "protocol"
        },
        "widgets": {
          "default": "1"
        },
        "dashboard": {
          "enabled": "0",
          "blocks": {
            "device_activity": {
              "enabled": "1"
            },
            "latest_events": {
              "enabled": "1"
            },
            "device_status_counts": {
              "enabled": "1"
            },
            "latest_tasks": {
              "enabled": "1"
            },
            "device_distance": {
              "enabled": "1"
            },
            "device_overview": {
              "enabled": "0"
            }
          }
        }
      },
      "login_periods": null,
      "email_verified_at": "2023-09-25 07:45:33",
      "client_id": 3,
      "company_id": null,
      "only_one_session": 0,
      "subusers_count": 0,
      "devices_count": 5,
      "manager": null,
      "billing_plan": null
    }
  ],
  "first_page_url": "api/admin/clients?page=1",
  "from": 1,
  "last_page": 4,
  "last_page_url": "/api/admin/clients?page=4",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "/api/admin/clients?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "/api/admin/clients?page=2",
      "label": "2",
      "active": false
    },
    {
      "url": "/api/admin/clients?page=3",
      "label": "3",
      "active": false
    },
    {
      "url": "/api/admin/clients?page=4",
      "label": "4",
      "active": false
    },
    {
      "url": "/api/admin/clients?page=2",
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": "/api/admin/clients?page=2",
  "path": "/api/admin/clients",
  "per_page": 1,
  "prev_page_url": null,
  "to": 1,
  "total": 4
}
DELETE http://127.0.0.1/api/admin/clients
Delete clients
operationId: delete-admin-clients

Delete clients

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
ids array[integer]

Responses

200
GET http://127.0.0.1/api/admin/users/{id}/client
Get user's client
operationId: get-admin-users-id-client

Get user's client

Request

Path Parameters

NameTypeDescription
id requiredstring

User ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
data object
POST http://127.0.0.1/api/admin/users/{id}/client
Set user's client
operationId: post-admin-users-id-client

Set user's client

Request

Path Parameters

NameTypeDescription
id requiredstring

User ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
first_name string
last_name string
birth_date string
personal_code string
address string
comment string

Responses

200
FieldTypeDescription
data object

Alert

Alert

POST http://127.0.0.1/api/add_alert
operationId: POST_add_alert

Depending on type, also add attributes to the body. List of types and their attributes can be found at '/get_alerts_attributes'.

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
active integer
type string

Check types and their input at /get_alerts_attributes

name string
schedules object

List weekday time in 15 min intervals. Example monday and tuesday 03:00 - 04:00: {"monday":["03:00","03:15","03:30","03:45"],"tuesday":["03:00","03:15","03:30","03:45"]}

notifications object
command object

Check /get_alerts_commands. Command message is specified in data

data string

command message

zone integer

0 - none, 1 - inside geofences, 2 - outside geofences

zones array[integer]

Geofence IDs

devices requiredarray[integer]

Device IDs

drivers array[integer]

UserDriver IDs. For type: driver

events_custom array[integer]

EventCustom IDs. For type: custom

geofences array[integer]

Geofence IDs. For type: geofence_in, geofence_out, geofence_inout

pois array[integer]

POI IDs. For type: poi_stop_duration, poi_idle_duration

overspeed integer

For type: overspeed

stop_duration integer

For type: stop_duration, poi_stop_duration

idle_duration integer

For type: idle_duration, poi_idle_duration

ignition_duration integer

For type: ignition_duration

offline_duration integer

For type: offline_duration

move_duration integer

For type: move_duration

min_parking_duration integer

For type: move_duration

distance integer

For type: distance

distance_tolerance integer

For type: poi_stop_duration, poi_idle_duration

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_alert_data
operationId: GET_add_alert_data

Get data to create alert

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
devices array[
FieldTypeDescription
id integer
value string
]
geofences array[
FieldTypeDescription
id integer
value string
]
alert_zones array[
FieldTypeDescription
id integer
value string
]
types array[
FieldTypeDescription
type string
title string
attributes array[
FieldTypeDescription
name string
type string
title string
default string | array
options array | null
]
]
notifications array[
FieldTypeDescription
name string
active boolean | integer
title string
input string | null
description string | null
]
schedules array[
FieldTypeDescription
id string
title string
items array[
FieldTypeDescription
id string
title string
active boolean | integer
]
]
application/json
{
  "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
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/change_active_alert
operationId: GET_change_active_alert

Change active status for alerts

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer | array
active boolean | null

Responses

200

Success

400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
default
GET http://127.0.0.1/api/destroy_alert
operationId: GET_destroy_alert

Delete alert

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
alert_id requiredinteger

Alert ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/devices/{device_id}/alerts
Get device alerts
operationId: get-devices-device_id-alerts

Get device alerts

Request

Path Parameters

NameTypeDescription
device_id requiredinteger

Device ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
data array[
FieldTypeDescription
id integer
title string
active boolean
date_from string | null
date_to string | null
]
pagination → pagination_compact
application/json
{
  "data": [
    {
      "id": 1,
      "name": "overspeed",
      "active": true,
      "date_from": null,
      "date_to": null
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null
  }
}
POST http://127.0.0.1/api/devices/{device_id}/alerts/{alert_id}/time_period
Set when alerts are active from or/and to
operationId: post-devices-device_id-alerts-alert_id-time_period

Set when alerts are active from or/and to

Request

Path Parameters

NameTypeDescription
device_id requiredinteger

Device ID

alert_id requiredinteger

Alert ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
date_from string
date_to string

Responses

200
POST http://127.0.0.1/api/edit_alert
operationId: POST_edit_alert

Depending on type, also add attributes to the body. List of types and their attributes can be found at '/get_alerts_attributes'.

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer
active integer
type string

Check types and their input at /get_alerts_attributes

name string
schedules object

List weekday time in 15 min intervals. Example monday and tuesday 03:00 - 04:00: {"monday":["03:00","03:15","03:30","03:45"],"tuesday":["03:00","03:15","03:30","03:45"]}

notifications object
command object

Check /get_alerts_commands. Command message is specified in data

data string

command message

zone integer

0 - none, 1 - inside geofences, 2 - outside geofences

zones array[integer]

Geofence IDs

devices requiredarray[integer]

Device IDs

drivers array[integer]

UserDriver IDs. For type: driver

events_custom array[integer]

EventCustom IDs. For type: custom

geofences array[integer]

Geofence IDs. For type: geofence_in, geofence_out, geofence_inout

pois array[integer]

POI IDs. For type: poi_stop_duration, poi_idle_duration

overspeed integer

For type: overspeed

stop_duration integer

For type: stop_duration, poi_stop_duration

idle_duration integer

For type: idle_duration, poi_idle_duration

ignition_duration integer

For type: ignition_duration

offline_duration integer

For type: offline_duration

move_duration integer

For type: move_duration

min_parking_duration integer

For type: move_duration

distance integer

For type: distance

distance_tolerance integer

For type: poi_stop_duration, poi_idle_duration

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_alert_data
operationId: GET_edit_alert_data

Get data to edit alert

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
alert_id requiredinteger

Alert ID

Responses

200
FieldTypeDescription
item → alert
devices array[
FieldTypeDescription
id integer
value string
]
geofences array[
FieldTypeDescription
id integer
value string
]
alert_zones array[
FieldTypeDescription
id integer
value string
]
types array[
FieldTypeDescription
type string
title string
attributes array[
FieldTypeDescription
name string
type string
title string
default string | array
options array | null
]
]
notifications array[
FieldTypeDescription
name string
active boolean | integer
title string
input string | null
description string | null
]
schedules array[
FieldTypeDescription
id string
title string
items array[
FieldTypeDescription
id string
title string
active boolean | integer
]
]
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_alerts
operationId: GET_get_alerts

Get alerts

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
items object
application/json
{
  "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": [
          1,
          2
        ],
        "events_custom": []
      }
    ]
  }
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_alerts_attributes
Get alert types with input fields
operationId: get-get_alerts_attributes

Get alert types with input fields

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
types array[
FieldTypeDescription
name string
type string
title string
options array[
FieldTypeDescription
id string
title string
]
]
GET http://127.0.0.1/api/get_alerts_commands
Get alert commands
operationId: get-get_alerts_commands

Get alert commands

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
alert_id integer
devices array[integer]
selected_devices array[integer]

Responses

200
GET http://127.0.0.1/api/get_alerts_summary
Get alerts summary
operationId: get-get_alerts_summary

Get alerts summary

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
GET http://127.0.0.1/api/get_custom_events_by_device
operationId: GET_get_custom_events_by_device
🔒 Requires: user_api_hash

Get devices custom events

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
devices array[integer]

Responses

200
array[
FieldTypeDescription
key string
name string
items array[
FieldTypeDescription
id integer
value string
]
]
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_events_by_protocol
Get events by protocol
operationId: get-get_events_by_protocol

Get events by protocol

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
protocol requiredstring

Protocol

type requiredinteger

If type = 1, then user events are taken, otherwise - general

Responses

200
FieldTypeDescription
0 object
status integer
application/json
{
  "0": {
    "id": 0,
    "value": {
      "id": 2,
      "value": "test",
      "title": "test"
    },
    "title": {
      "id": 2,
      "value": "test",
      "title": "test"
    }
  },
  "status": 1
}
GET http://127.0.0.1/api/get_protocols
operationId: GET_get_protocols

Get device protocols

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
0 object
1 object
status integer
application/json
{
  "0": {
    "id": 0,
    "value": {
      "type": 1,
      "items": [
        {
          "id": "osmand",
          "value": "osmand"
        }
      ]
    }
  },
  "1": {
    "id": 1,
    "value": {
      "type": 2,
      "items": []
    }
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/set_alert_devices
operationId: GET_set_alert_devices

Set alert devices

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
alert_id requiredinteger

Alert ID

Request Body

NameTypeDescription
body
FieldTypeDescription
devices requiredarray[integer]

Responses

200
FieldTypeDescription
status integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Authentication

Authentication

POST http://127.0.0.1/api/login
operationId: POST_login

Following a good response save 'user_api_hash' and use it for others requests. It may change in the future if user change a password, when system will return error.

Request

Form Data

NameTypeDescription
email requiredstring

email

password requiredstring

password

as string

Other user's to login as, email

Responses

200
FieldTypeDescription
status requiredinteger
user_api_hash requiredstring
application/json
{
  "status": 1,
  "user_api_hash": "$2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS"
}
401
FieldTypeDescription
status integer
message string
application/json
{
  "status": 0,
  "message": "Wrong credentials."
}
GET http://127.0.0.1/api/password_reminder
Initiate password change
operationId: get-password_reminder

Retrieve code to email for password change

Request

Request Body

NameTypeDescription
body
FieldTypeDescription
email string

Responses

200
FieldTypeDescription
success integer
application/json
{
  "email": "test@test.com"
}
401
FieldTypeDescription
status integer
message string
application/json
{
  "status": 0,
  "message": "Wrong credentials."
}
POST http://127.0.0.1/api/password_reminder
Change password
operationId: post-password_reminder

Change password using provided code

Request

Request Body

NameTypeDescription
body
FieldTypeDescription
email string
code string
password string

Responses

200
FieldTypeDescription
success integer
application/json
{
  "email": "test@test.com"
}
401
FieldTypeDescription
status integer
message string
application/json
{
  "status": 0,
  "message": "Wrong credentials."
}
422
string
POST http://127.0.0.1/api/register
Register user
operationId: get-register

Register user

Request

Request Body

NameTypeDescription
body
FieldTypeDescription
email string

Responses

200
FieldTypeDescription
status integer
message string
application/json
{
  "email": "test@test.com"
}
401
FieldTypeDescription
status integer
message string
application/json
{
  "status": 0,
  "message": "Wrong credentials."
}

Call Action

Call Action

GET http://127.0.0.1/api/call_actions
Get call actions list
operationId: get-call_actions

Get call actions list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
data array[→ call_action]
pagination → pagination_compact
application/json
{
  "status": 1,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "device_id": 3,
      "event_id": 1,
      "alert_id": 1,
      "called_at": "2023-12-18 17:48:16",
      "response_type": "answer",
      "remarks": "remarks",
      "created_at": "2023-12-18 17:48:16",
      "updated_at": "2023-12-18 17:48:16"
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 30,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null
  }
}
DELETE http://127.0.0.1/api/call_actions/destory/{id}
Delete call action item
operationId: delete-call_actions-destory-id

Delete call action item

Request

Path Parameters

NameTypeDescription
id requiredstring

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
GET http://127.0.0.1/api/call_actions/event_types
Get call action event types
operationId: get-call_actions-event_types

Get call action event types

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
types array[
FieldTypeDescription
type string
title string
]
application/json
{
  "status": 1,
  "types": [
    {
      "type": "zone_in",
      "title": "Zone in"
    },
    {
      "type": "zone_out",
      "title": "Zone out"
    }
  ]
}
GET http://127.0.0.1/api/call_actions/response_types
Get call action response types
operationId: get-call_actions-response_types

Get call action response types

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
types array[
FieldTypeDescription
type string
title string
]
application/json
{
  "status": 1,
  "types": [
    {
      "type": "answer",
      "title": "Answer"
    },
    {
      "type": "no_answer",
      "title": "No answer"
    },
    {
      "type": "no_response",
      "title": "No response"
    }
  ]
}
POST http://127.0.0.1/api/call_actions/store
Create call action item
operationId: post-call_actions-store

Create call action item

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
device_id integer
event_id integer
alert_id integer
called_at string
response_type string

answer, no_answer, no_response

remarks string

Responses

200
application/json
{
  "id": 1,
  "user_id": 1,
  "device_id": 3,
  "event_id": 1,
  "alert_id": 1,
  "called_at": "2023-12-18 17:48:16",
  "response_type": "answer",
  "remarks": "remarks",
  "created_at": "2023-12-18 17:48:16",
  "updated_at": "2023-12-18 17:48:16"
}
PUT http://127.0.0.1/api/call_actions/update/{id}
Update call action item
operationId: put-call_actions-update-id

Update call action item

Request

Path Parameters

NameTypeDescription
id requiredstring

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
device_id integer
event_id integer
alert_id integer
called_at string
response_type string

answer, no_answer, no_response

remarks string

Responses

200
GET http://127.0.0.1/api/call_actions/{id}
Get call action item
operationId: get-call_actions-id

Get call action item

Request

Path Parameters

NameTypeDescription
id requiredstring

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
application/json
{
  "id": 1,
  "user_id": 1,
  "device_id": 3,
  "event_id": 1,
  "alert_id": 1,
  "called_at": "2023-12-18 17:48:16",
  "response_type": "answer",
  "remarks": "remarks",
  "created_at": "2023-12-18 17:48:16",
  "updated_at": "2023-12-18 17:48:16"
}

Command

Command

GET http://127.0.0.1/api/get_device_commands
operationId: GET_get_device_commands

Get commands sent to device

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

Responses

200
array[
FieldTypeDescription
type requiredstring
title requiredstring
connection string

gprs, sms

attributes array[
FieldTypeDescription
name requiredstring
html_name requiredstring
title requiredstring
type requiredstring

string, ingeter, text, select

options array[
FieldTypeDescription
id string | integer
title string
]
default requiredstring | integer | null
description requiredstring
validation requiredstring
required requiredboolean
]
]
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/send_command_data
operationId: GET_send_command_data

Get data to create GPRS/SMS command

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
devices_sms array[object]
devices_gprs array[
FieldTypeDescription
id integer
value string
]
sms_templates array[
FieldTypeDescription
id string
title string
message null | string
]
gprs_templates array[
FieldTypeDescription
id string
title string
message null | string
]
commands array[
FieldTypeDescription
id string
value string
]
units array[
FieldTypeDescription
id string
value string
]
number_index array[
FieldTypeDescription
id integer
value string
]
actions array[
FieldTypeDescription
id integer
value string
]
devices_protocols object
commands_all object
status integer
application/json
{
  "devices_sms": [],
  "devices_gprs": [
    {
      "id": 3,
      "value": "Device name"
    }
  ],
  "sms_templates": [
    {
      "id": "0",
      "title": "No template",
      "message": null
    },
    {
      "id": "1",
      "title": "Template title",
      "message": "Template message"
    }
  ],
  "gprs_templates": [
    {
      "id": "0",
      "title": "No template",
      "message": null
    },
    {
      "id": "1",
      "title": "Template title",
      "message": "Template message"
    }
  ],
  "commands": [
    {
      "id": "engineStop",
      "value": "Engine stop"
    },
    {
      "id": "engineResume",
      "value": "Engine resume"
    },
    {
      "id": "alarmArm",
      "value": "Alarm arm"
    },
    {
      "id": "alarmDisarm",
      "value": "Alarm disarm"
    },
    {
      "id": "positionSingle",
      "value": "Position single"
    },
    {
      "id": "positionPeriodic",
      "value": "Periodic reporting"
    },
    {
      "id": "positionStop",
      "value": "Stop reporting"
    },
    {
      "id": "movementAlarm",
      "value": "Movement alarm"
    },
    {
      "id": "setTimezone",
      "value": "Set timezone"
    },
    {
      "id": "rebootDevice",
      "value": "Reboot device"
    },
    {
      "id": "sendSms",
      "value": "Send sms"
    },
    {
      "id": "custom",
      "value": "Custom command"
    }
  ],
  "units": [
    {
      "id": "second",
      "value": "Second"
    },
    {
      "id": "minute",
      "value": "Minute"
    },
    {
      "id": "hour",
      "value": "Hour"
    }
  ],
  "number_index": [
    {
      "id": 1,
      "value": "First"
    },
    {
      "id": 2,
      "value": "Second"
    },
    {
      "id": 3,
      "value": "Third"
    },
    {
      "id": 0,
      "value": "Three SOS numbers at the same time"
    }
  ],
  "actions": [
    {
      "id": 1,
      "value": "On"
    },
    {
      "id": 0,
      "value": "Off"
    }
  ],
  "devices_protocols": {
    "3": "osmand"
  },
  "commands_all": {
    "default": {
      "engineStop": "Engine stop",
      "engineResume": "Engine resume",
      "alarmArm": "Alarm arm",
      "alarmDisarm": "Alarm disarm",
      "positionSingle": "Position single",
      "positionPeriodic": "Periodic reporting",
      "positionStop": "Stop reporting",
      "movementAlarm": "Movement alarm",
      "setTimezone": "Set timezone",
      "rebootDevice": "Reboot device",
      "sendSms": "Send sms",
      "custom": "Custom command"
    },
    "watch": {
      "sosNumber": "SOS number setting",
      "alarmSos": "SOS message alarm",
      "alarmBattery": "Low battery alarm",
      "alarmRemove": "Alarm of taking watch",
      "rebootDevice": "Restart",
      "silenceTime": "Time interval setting of silence time",
      "alarmClock": "Alarm clock setting order",
      "setPhonebook": "Phone book setting order"
    },
    "pt502": {
      "engineStop": "Engine stop",
      "engineResume": "Engine resume"
    }
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/send_gprs_command
operationId: POST_send_gprs_command

Create GPRS command

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Form Data

NameTypeDescription
device_id integer

Device ID

type string

type

message string

message

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/send_sms_command
operationId: POST_send_sms_command

Create SMS command

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Form Data

NameTypeDescription
message requiredstring

message

devices requiredarray[integer]

devices

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/sent_commands
Get Sent Commands
operationId: get-sent_commands

Get sent commands

Request

Query Parameters

NameTypeDescription
sorting[sort_by] string

Sort by column

default: created_at
sorting[sort] string

Sort direction

default: DESC
includes array[]

Relations to include. Available: user, device

connection string

Find items with exact connection values

search string

Value to search in items properties

lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
data array[
FieldTypeDescription
id integer
user_id integer
imei string
connection string
command_title string
parameters any
response string | null
status boolean
created_at string

Adjusted to user timezone

updated_at string

Adjusted to user timezone

device object
user object
]
pagination → pagination_compact
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Custom event

Custom event

POST http://127.0.0.1/api/add_custom_event
operationId: POST_add_custom_event

Create custom event

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_custom_event_data
operationId: GET_add_custom_event_data

Get data to create custom event

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
protocols array[
FieldTypeDescription
id string
value string
]
types array[
FieldTypeDescription
id string
value string
]
status integer
application/json
{
  "protocols": [
    {
      "id": "adm",
      "value": "adm"
    },
    {
      "id": "apel",
      "value": "apel"
    },
    {
      "id": "aplicom",
      "value": "aplicom"
    },
    {
      "id": "appello",
      "value": "appello"
    }
  ],
  "types": [
    {
      "id": "1",
      "value": "Equals to (=)"
    },
    {
      "id": "2",
      "value": "Greater than (>)"
    },
    {
      "id": "3",
      "value": "Less than (<)"
    }
  ],
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_custom_event
operationId: GET_destroy_custom_event

Delete custom event

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
custom_event_id requiredinteger

Custom event ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_custom_event
operationId: POST_edit_custom_event

Edit custom event

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body any

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_custom_event_data
operationId: GET_edit_custom_event_data

Get data to edit custom event

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
custom_event_id requiredinteger

Custom event ID

Responses

200
FieldTypeDescription
item object
protocols array[
FieldTypeDescription
id string
value string
]
types array[
FieldTypeDescription
id string
value string
]
status integer
application/json
{
  "item": {
    "id": 1,
    "user_id": 2,
    "protocol": "osmand",
    "conditions": [
      {
        "tag": "speed",
        "type": "2",
        "tag_value": "110"
      }
    ],
    "message": "Message",
    "always": 1
  },
  "protocols": [
    {
      "id": "adm",
      "value": "adm"
    },
    {
      "id": "apel",
      "value": "apel"
    },
    {
      "id": "aplicom",
      "value": "aplicom"
    },
    {
      "id": "appello",
      "value": "appello"
    },
    {
      "id": "aquila",
      "value": "aquila"
    },
    {
      "id": "ardi01",
      "value": "ardi01"
    }
  ],
  "types": [
    {
      "id": "1",
      "value": "Equals to (=)"
    },
    {
      "id": "2",
      "value": "Greater than (>)"
    },
    {
      "id": "3",
      "value": "Less than (<)"
    }
  ],
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_custom_events
operationId: GET_get_custom_events

Get custom events

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
items object
status integer
application/json
{
  "items": {
    "events": {
      "total": 1,
      "per_page": 10,
      "current_page": 1,
      "last_page": 1,
      "next_page_url": null,
      "prev_page_url": null,
      "from": 1,
      "to": 1,
      "data": [
        {
          "id": "1",
          "user_id": "2",
          "protocol": "osmand",
          "conditions": [
            {
              "tag": "speed",
              "type": "2",
              "tag_value": "110"
            }
          ],
          "message": "Message",
          "always": "1",
          "tags": [
            {
              "event_custom_id": "1",
              "tag": "speed"
            }
          ]
        }
      ],
      "url": "/api/get_custom_events"
    }
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Device

Device

POST http://127.0.0.1/api/add_device
operationId: GET_add_device

Create device

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
name requiredstring
imei requiredstring
icon_id requiredinteger
fuel_measurement_id requiredinteger
tail_length requirednumber
min_moving_speed requirednumber
min_fuel_fillings requirednumber
min_fuel_thefts requirednumber
fuel_quantity number
fuel_price number
group_id integer
device_icons_type string
timezone_id integer
icon_moving string
icon_stopped string
icon_offline string
icon_engine string
sim_number string
vin string
device_model string
plate_number string
registration_number string
object_owner string
additional_notes string

Responses

200
FieldTypeDescription
status integer
id integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_device_data
operationId: GET_add_device_data

Data to create device

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
device_groups array[
FieldTypeDescription
id integer
value string
]
sensor_groups array[
FieldTypeDescription
id integer
value string
]
device_fuel_measurements array[
FieldTypeDescription
id string
title string
fuel_title string
distance_title string
lang string
created_at string
updated_at string
]
device_icons array[
FieldTypeDescription
id string
order string
width string
height string
path string
]
users array[→ user]
timezones array[
FieldTypeDescription
id integer
value string
]
expiration_date_select object
status integer
application/json
{
  "device_groups": [
    {
      "id": 0,
      "value": "Ungrouped"
    }
  ],
  "sensor_groups": [
    {
      "id": 0,
      "value": "None"
    },
    {
      "id": 1,
      "value": "Senson group"
    }
  ],
  "device_fuel_measurements": [
    {
      "id": "1",
      "title": "l/100km",
      "fuel_title": "liter",
      "distance_title": "Kilometers",
      "lang": "en",
      "created_at": "2016-04-19 16:31:00",
      "updated_at": "2016-04-19 16:31:00"
    },
    {
      "id": "2",
      "title": "MPG",
      "fuel_title": "gallon",
      "distance_title": "Miles",
      "lang": "en",
      "created_at": "2016-04-19 16:31:00",
      "updated_at": "2016-04-19 16:31:00"
    }
  ],
  "device_icons": [
    {
      "id": "4",
      "order": "4",
      "width": "43.00",
      "height": "57.00",
      "path": "frontend/images/device_icons/4.png"
    },
    {
      "id": "1",
      "order": "3",
      "width": "43.00",
      "height": "57.00",
      "path": "frontend/images/device_icons/1.png"
    },
    {
      "id": "2",
      "order": "3",
      "width": "43.00",
      "height": "57.00",
      "path": "frontend/images/device_icons/2.png"
    },
    {
      "id": "3",
      "order": "3",
      "width": "43.00",
      "height": "57.00",
      "path": "frontend/images/device_icons/3.png"
    }
  ],
  "users": [],
  "timezones": [
    {
      "id": 0,
      "value": "Default"
    },
    {
      "id": 1,
      "value": "-14:00"
    },
    {
      "id": 2,
      "value": "-13:45"
    },
    {
      "id": 3,
      "value": "-13:30"
    },
    {
      "id": 4,
      "value": "-13:15"
    },
    {
      "id": 5,
      "value": "-13:00"
    },
    {
      "id": 6,
      "value": "-12:45"
    },
    {
      "id": 7,
      "value": "-12:30"
    },
    {
      "id": 8,
      "value": "-12:15"
    },
    {
      "id": 9,
      "value": "-12:00"
    },
    {
      "id": 10,
      "value": "-11:45"
    }
  ],
  "expiration_date_select": {
    "1": "Expiration date",
    "0000-00-00": "Unlimited"
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/change_active_device
operationId: GET_change_active_device

Change active status for devices

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer | array
active boolean

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_device
operationId: GET_destroy_device

Delete device

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/devices_groups
Get device groups list
operationId: get-devices_groups

Get device groups list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
search_phrase string

Value to be detected in properties

filter array[]

Key-value array of properties and searched values

limit integer

Items per page

sorting[sort_by] string

Column to sort by

sorting[sort] string

Sort direction

Responses

200
FieldTypeDescription
0 object
pagination → pagination_compact
application/json
{
  "0": {
    "id": 1,
    "user_id": 1,
    "title": "group",
    "open": true
  },
  "pagination": {
    "total": 2,
    "per_page": 1,
    "current_page": 1,
    "last_page": 2,
    "next_page_url": "/api/devices_groups?page=2",
    "prev_page_url": null
  }
}
POST http://127.0.0.1/api/devices_groups/store
Create device group
operationId: post-devices_groups-store

Create device group

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
title string
open boolean
devices array[integer]

Responses

200
FieldTypeDescription
status integer
id integer
application/json
{
  "status": 1,
  "id": 5
}
PUT http://127.0.0.1/api/devices_groups/update/{id}
Update device group
operationId: put-devices_groups-update-id

Update device group

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
title string
open boolean
devices array[integer]

Responses

200
FieldTypeDescription
status integer
id integer
application/json
{
  "status": 1,
  "id": 5
}
POST http://127.0.0.1/api/edit_device
operationId: GET_edit_device

Edit device

Request

Query Parameters

NameTypeDescription
device_id requiredinteger

Device ID

lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
name requiredstring
imei requiredstring
icon_id requiredinteger
fuel_measurement_id requiredinteger
tail_length requirednumber
min_moving_speed requirednumber
min_fuel_fillings requirednumber
min_fuel_thefts requirednumber
fuel_quantity number
fuel_price number
group_id integer
device_icons_type string
timezone_id integer
icon_moving string
icon_stopped string
icon_offline string
icon_engine string
sim_number string
vin string
device_model string
plate_number string
registration_number string
object_owner string
additional_notes string

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_device_data
operationId: GET_edit_device_data

Data to edit device

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

Responses

200
FieldTypeDescription
device_groups array[
FieldTypeDescription
id integer
value string
]
sensor_groups array[
FieldTypeDescription
id integer
value string
]
device_fuel_measurements array[
FieldTypeDescription
id string
title string
fuel_title string
distance_title string
lang string
created_at string
updated_at string
]
device_icons array[
FieldTypeDescription
id string
order string
width string
height string
path string
]
users array[→ user]
timezones array[
FieldTypeDescription
id integer
value string
]
expiration_date_select object
engine_hours array[
FieldTypeDescription
id string
value string
]
detect_engine array[
FieldTypeDescription
id string
value string
]
sensors any
services any
item → device
status integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_devices
operationId: GET_get_devices

Get devices

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
s string

Value to search in items properties

limit integer

Specifies amount of items per page

default: 100
page integer

Specifies which page should be retrieved

default: 1
id string

Find items with exact id value

imei string

Find items with exact imei value

sim_number string

Find items with exact sim_number value

msisdn string

Find items with exact msisdn value

vin string

Find items with exact vin value

plate_number string

Find items with exact plate_number value

registration_number string

Find items with exact registration_number value

object_owner string

Find items with exact object_owner value

device_model string

Find items with exact device_model value

group_id string

Find items with exact group_id value

status array[string]

Find items with exact status values

online string

Find items which status is online for the last specified amount of mintues

offline string

Find items which status is offline for the last specified amount of mintues

Responses

200
array[
FieldTypeDescription
title string
items array[
FieldTypeDescription
id integer
name string
online string
alarm string
time string
timestamp integer
acktimestamp integer
speed integer
lat number
lng number
course string
power string
altitude integer
address string
protocol string
driver string
sensors array[
FieldTypeDescription
name string
value string
show_in_popup string
]
services array[
FieldTypeDescription
name string
value string
expiring boolean
]
tail array[
FieldTypeDescription
lat string
lng string
]
distance_unit_hour string
sim_expiration_date string
device_data object
unit_of_distance string
unit_of_altitude string
unit_of_capacity string
stop_duration string
moved_timestamp integer
engine_status boolean | null
icon_type string
icon_color string
icon_colors object
]
]
application/json
[
  {
    "title": "Ungrouped",
    "items": [
      {
        "id": 3,
        "name": "Device name",
        "online": "offline",
        "alarm": "",
        "time": "2016-04-29 21:01:26",
        "timestamp": 1461956486,
        "acktimestamp": 0,
        "speed": 0,
        "lat": 55.922996,
        "lng": 23.3466906,
        "course": "0",
        "power": "-",
        "altitude": 175,
        "address": "-",
        "protocol": "osmand",
        "driver": "Drive first",
        "sensors": [
          {
            "name": "Sensor test",
            "value": "- nn",
            "show_in_popup": "0"
          },
          {
            "name": "test acc",
            "value": "- nn",
            "show_in_popup": "1"
          }
        ],
        "services": [
          {
            "name": "Test service",
            "value": "Engine hours Left (1000 )"
          }
        ],
        "tail": [
          {
            "lat": "55.91986482",
            "lng": "23.3255625"
          },
          {
            "lat": "55.91590619",
            "lng": "23.33778733"
          },
          {
            "lat": "55.91928624",
            "lng": "23.34572509"
          },
          {
            "lat": "55.92336524",
            "lng": "23.34666575"
          },
          {
            "lat": "55.92297793",
            "lng": "23.34665713"
          }
        ],
        "distance_unit_hour": "kph",
        "sim_expiration_date": "0000-00-00",
        "device_data": {
          "id": "3",
          "user_id": null,
          "traccar_device_id": "3",
          "icon_id": "8",
          "active": "1",
          "deleted": "0",
          "name": "Device name",
          "imei": "789832",
          "fuel_measurement_id": "1",
          "fuel_quantity": "0.00",
          "fuel_price": "0.00",
          "fuel_per_km": "0.00",
          "sim_number": "",
          "device_model": "",
          "plate_number": "",
          "vin": "",
          "registration_number": "",
          "object_owner": "",
          "expiration_date": "0000-00-00",
          "sim_expiration_date": "0000-00-00",
          "tail_color": "#33cc33",
          "tail_length": "5",
          "engine_hours": "gps",
          "detect_engine": "gps",
          "min_moving_speed": "6",
          "min_fuel_fillings": "10",
          "min_fuel_thefts": "10",
          "snap_to_road": "0",
          "created_at": "2016-04-25 16:21:19",
          "updated_at": "2016-06-26 15:52:46",
          "pivot": {
            "user_id": "2",
            "device_id": "3",
            "group_id": null,
            "current_driver_id": "1",
            "active": "1",
            "timezone_id": null
          },
          "group_id": null,
          "current_driver_id": "1"
        }
      }
    ]
  }
]
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_devices_latest
operationId: GET_get_devices_latest

Return only devices whose information has changed, all the response returns "time", the time needed to transmit the next request.

Request

Query Parameters

NameTypeDescription
time string

Filter items that were updated since provided UNIX timestamp

default: 5 seconds ago
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
filters[id] integer

Find items with exact id value

filters[imei] string

Find items with exact imei value

filters[sim_number] string

Find items with exact sim_number value

filters[msisdn] string

Find items with exact msisdn value

filters[vin] string

Find items with exact vin value

filters[plate_number] string

Find items with exact plate_number value

filters[registration_number] string

Find items with exact registration_number value

filters[object_owner] string

Find items with exact object_owner value

filters[device_model] string

Find items with exact device_model value

filters[group_id] integer

Find items with exact group_id value

filters[status] array[string]

Find items with exact status values

filters[online] string

Find items which status is online for the last specified amount of mintues

filters[offline] string

Find items which status is offline for the last specified amount of mintues

Responses

200
FieldTypeDescription
items array[
FieldTypeDescription
id integer
name string
online string
alarm string
time string
timestamp integer
acktimestamp integer
speed integer
lat number
lng number
course string
power string
altitude integer
address string
protocol string
driver string
sensors string
services string
tail string
distance_unit_hour string
device_data object
unit_of_distance string
unit_of_altitude string
unit_of_capacity string
stop_duration string
moved_timestamp integer
engine_status boolean | null
icon_type string
icon_color string
icon_colors object
detect_engine string
engine_hours string
total_distance string
parameters array[string | array]
]
events array[any]
time integer
version string
application/json
{
  "items": [
    {
      "id": 3,
      "name": "Device name",
      "online": "offline",
      "alarm": "",
      "time": "2016-04-29 21:01:26",
      "timestamp": 1461956486,
      "acktimestamp": 0,
      "speed": 0,
      "lat": 55.922996,
      "lng": 23.3466906,
      "course": "0",
      "power": "-",
      "altitude": 175,
      "address": "-",
      "protocol": "osmand",
      "driver": "Drive first",
      "sensors": "[\n    {\n        \"name\": \"Sensor test\",\n        \"value\": \"- nn\",\n        \"show_in_popup\": \"0\"\n    },\n    {\n        \"name\": \"test acc\",\n        \"value\": \"- nn\",\n        \"show_in_popup\": \"1\"\n    }\n]",
      "services": "[\n    {\n        \"name\": \"Test service\",\n        \"value\": \"Engine hours Left (1000 )\"\n    }\n]",
      "tail": "[\n    {\n        \"lat\": \"55.91986482\",\n        \"lng\": \"23.3255625\"\n    },\n    {\n        \"lat\": \"55.91590619\",\n        \"lng\": \"23.33778733\"\n    },\n    {\n        \"lat\": \"55.91928624\",\n        \"lng\": \"23.34572509\"\n    },\n    {\n        \"lat\": \"55.92336524\",\n        \"lng\": \"23.34666575\"\n    },\n    {\n        \"lat\": \"55.92297793\",\n        \"lng\": \"23.34665713\"\n    }\n]",
      "distance_unit_hour": "kph",
      "device_data": {
        "id": "3",
        "traccar_device_id": "3",
        "icon_id": "8",
        "active": "1",
        "deleted": "0",
        "name": "Device name",
        "imei": "789832",
        "fuel_measurement_id": "1",
        "fuel_quantity": "0.00",
        "fuel_price": "0.00",
        "fuel_per_km": "0.00",
        "sim_number": "",
        "device_model": "",
        "plate_number": "",
        "vin": "",
        "registration_number": "",
        "object_owner": "",
        "expiration_date": "0000-00-00",
        "tail_color": "#33cc33",
        "tail_length": "5",
        "engine_hours": "gps",
        "detect_engine": "gps",
        "min_moving_speed": "6",
        "min_fuel_fillings": "10",
        "min_fuel_thefts": "10",
        "snap_to_road": "0",
        "created_at": "2016-04-25 16:21:19",
        "updated_at": "2016-06-26 15:52:46",
        "pivot": {
          "user_id": "2",
          "device_id": "3",
          "group_id": null,
          "current_driver_id": "1",
          "active": "1",
          "timezone_id": null
        },
        "group_id": null,
        "current_driver_id": "1"
      }
    }
  ],
  "events": [],
  "time": 1466992735,
  "version": "2.5.1"
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Device Media

Device Media

GET http://127.0.0.1/api/devices/{device_id}/media
Get device media
operationId: get-devices-device_id-media

Get device media

Request

Path Parameters

NameTypeDescription
device_id requiredstring

Device ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
data array[any]
pagination → pagination_compact
application/json
{
  "success": true,
  "data": [
    {
      "url": "/api/devices/3/media/file/eyJpdiI6IitOMGtwZEVVSWJCZVpnMzdNeTJLOGc9PSIsInZhbHVlIjoiMVlmS0k4TGVSa1JvdzlaRXFid1RjQ1VHYnhjWkozSWFOdGxOeWlIcDRSWT0iLCJtYWMiOiJmYWY1ZjAwMjczMDM2OTFhMzQ3NzdkZmFiNmRkOGY0MWU1MDU2MjFmMmJlYzQ3MmVhZGE1YzM4NjM0ZGM5Nzk3IiwidGFnIjoiIn0%3D",
      "size": "96.2 KB",
      "created_at": "2023-07-16 00:00:36",
      "camera_id": null,
      "camera_name": ""
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null
  }
}
GET http://127.0.0.1/api/devices/{device_id}/media/file/{filename}
Download device media image
operationId: get-devices-device_id-media-file-filename

Download device media image

Request

Path Parameters

NameTypeDescription
device_id requiredinteger

Device ID

filename requiredstring

File hash code

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200

Image content

DELETE http://127.0.0.1/api/devices/{device_id}/media/file/{filename}
Delete device media image
operationId: delete-devices-device_id-media-file-filename

Delete device media image

Request

Path Parameters

NameTypeDescription
device_id requiredinteger

Device ID

filename requiredstring

File hash code

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
delete_count integer
application/json
{
  "status": 1,
  "delete_count": 1
}
GET http://127.0.0.1/api/devices/{id}/image
Download device image
operationId: get-devices-id-image

Download device image

Request

Path Parameters

NameTypeDescription
id requiredstring

Device ID

Responses

200

Image content

Driver

Driver

POST http://127.0.0.1/api/add_user_driver
operationId: POST_add_user_driver

Create user driver

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
item object
application/json
{
  "status": 1,
  "item": {
    "name": "Drive name",
    "user_id": "2",
    "updated_at": "2016-06-26 16:11:16",
    "created_at": "2016-06-26 16:11:16",
    "id": 2
  }
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_user_driver_data
operationId: GET_add_user_driver_data

Get data to create user driver

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
devices object
status integer
application/json
{
  "devices": {
    "3": "Device name"
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_user_driver
operationId: GET_destroy_user_driver

Delete user driver

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
user_driver_id requiredinteger

User driver ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_user_driver
operationId: POST_edit_user_driver

Edit user driver

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_user_driver_data
operationId: GET_edit_user_driver_data

Get data to edit user driver

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
user_driver_id requiredinteger

User driver ID

Responses

200
FieldTypeDescription
item any
devices object
status integer
application/json
{
  "item": {
    "id": 1,
    "user_id": 2,
    "device_id": 3,
    "device_port": null,
    "name": "Drive name",
    "rfid": "",
    "phone": "",
    "email": "",
    "description": "",
    "created_at": "2016-04-27 22:18:25",
    "updated_at": "2016-04-27 22:18:25"
  },
  "devices": {
    "3": "Device name"
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_user_drivers
operationId: GET_get_user_drivers

Get user drivers

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
items object
status integer
application/json
{
  "items": {
    "drivers": {
      "total": 1,
      "per_page": 5,
      "current_page": 1,
      "last_page": 1,
      "next_page_url": null,
      "prev_page_url": null,
      "from": 1,
      "to": 1,
      "data": [
        {
          "id": "1",
          "user_id": "2",
          "device_id": "3",
          "device_port": null,
          "name": "Driver name",
          "rfid": "",
          "phone": "",
          "email": "",
          "description": "",
          "created_at": "2016-04-27 22:18:25",
          "updated_at": "2016-04-27 22:18:25",
          "device": {
            "id": "3",
            "user_id": null,
            "traccar_device_id": "3",
            "icon_id": "8",
            "active": "1",
            "deleted": "0",
            "name": "Device name",
            "imei": "789832",
            "fuel_measurement_id": "1",
            "fuel_quantity": "0.00",
            "fuel_price": "0.00",
            "fuel_per_km": "0.00",
            "sim_number": "",
            "device_model": "",
            "plate_number": "",
            "vin": "",
            "registration_number": "",
            "object_owner": "",
            "expiration_date": "0000-00-00",
            "tail_color": "#33cc33",
            "tail_length": "5",
            "engine_hours": "gps",
            "detect_engine": "gps",
            "min_moving_speed": "6",
            "min_fuel_fillings": "10",
            "min_fuel_thefts": "10",
            "snap_to_road": "0",
            "created_at": "2016-04-25 16:21:19",
            "updated_at": "2016-06-09 13:51:59"
          }
        }
      ],
      "url": "/api/get_user_drivers"
    }
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Event

Event

GET http://127.0.0.1/api/destroy_events
operationId: GET_destroy_events

Istrina visus userio eventus.

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_events
operationId: GET_get_events

Get events

Request

Query Parameters

NameTypeDescription
device_id integer

Device ID

type string

Type

date_from string

Date from

date_to string

Date to

search string

Phrase to search through items attributes

limit integer

Items per page (max 1000)

default: 30
page integer

Page

default: 1
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
items object
application/json
{
  "status": 1,
  "items": {
    "total": 1,
    "per_page": 30,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "data": [
      {}
    ],
    "url": "/api/get_events"
  }
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

FCM

FCM

POST http://127.0.0.1/api/fcm_token
Assign FCM token to current user
operationId: post-fcm_token

Assign FCM token to current user

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
token string

FCM token

project_id string | null

Project ID of the FCM configuration from which the token originates. If not provided, the default FCM configuration will be used for the token.

Responses

200

Geofence

Geofence

POST http://127.0.0.1/api/add_geofence
operationId: POST_add_geofence

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

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
name requiredstring
active boolean
device_id integer
group_id integer
type requiredstring

'circle' or 'polygon'

polygon array[
FieldTypeDescription
lat number
lng number
]

Required with type 'polygon'

radius number

Required with type 'circle'

center object

Required with type 'circle'

polygon_color requiredstring

Hexadecimal color code, e.g., #00AB33

speed_limit number

Responses

200
application/json
{
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/change_active_geofence
operationId: GET_change_active_geofence

Change active status for geofences

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer | array
active boolean

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_geofence
operationId: GET_destroy_geofence

Delete geofence

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
geofence_id requiredinteger

Geofence ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_geofence
operationId: POST_edit_geofence

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

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer
name string
active boolean
device_id integer
group_id integer
type string

'circle' or 'polygon'

polygon array[
FieldTypeDescription
lat number
lng number
]

Required with type 'polygon'

radius number

Required with type 'circle'

center object

Required with type 'circle'

polygon_color string

Hexadecimal color code, e.g., #00AB33

speed_limit number

Responses

200
application/json
{
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/geofences_groups
Get geofence groups list
operationId: get-geofences_groups

Get geofence groups list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
search_phrase string

Value to be detected in properties

limit integer

Items per page

sort_by string

Column to sort by

sort string

Sort direction

Responses

200
FieldTypeDescription
0 object
pagination → pagination_compact
application/json
{
  "0": {
    "id": 1,
    "user_id": 1,
    "title": "group",
    "open": true
  },
  "pagination": {
    "total": 2,
    "per_page": 1,
    "current_page": 1,
    "last_page": 2,
    "next_page_url": "/api/geofences_groups?page=2",
    "prev_page_url": null
  }
}
POST http://127.0.0.1/api/geofences_groups/store
Create geofence group
operationId: post-geofences_groups-store

Create geofence group

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
title string
open boolean
geofences array[integer]

Responses

200
FieldTypeDescription
status integer
id integer
application/json
{
  "status": 1,
  "id": 5
}
PUT http://127.0.0.1/api/geofences_groups/update/{id}
Update geofence group
operationId: put-geofences_groups-update-id

Update geofence group

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
title string
open boolean
geofences array[integer]

Responses

200
FieldTypeDescription
status integer
id integer
application/json
{
  "status": 1,
  "id": 5
}
GET http://127.0.0.1/api/get_geofences
operationId: GET_get_geofences

Get geofences

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
any
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/point_in_geofences
Get names of geofences the point is in
operationId: get-point_in_geofences

Get names of geofences the point is in

Request

Query Parameters

NameTypeDescription
lat requirednumber

Latitude

lng requirednumber

Longitude

lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
zones array[string]
application/json
{
  "status": 1,
  "zones": [
    "Geofence 1",
    "Geofence 2"
  ]
}

GPRS Template

GPRS Template

POST http://127.0.0.1/api/add_user_gprs_template
operationId: POST_add_user_gprs_template

Create user GPRS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
item → gprstemplate
application/json
{
  "status": 1,
  "item": {
    "id": 2,
    "user_id": 2,
    "title": "GPRS Title",
    "message": "message content",
    "updated_at": "2016-06-26 17:41:43",
    "created_at": "2016-06-26 17:41:43"
  }
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_user_gprs_template_data
operationId: GET_add_user_gprs_template_data

Get data to create user GPRS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
protocols array[
FieldTypeDescription
id string
title string
]
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_user_gprs_template
operationId: GET_destroy_user_gprs_template

Delete user GPRS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
user_gprs_template_id requiredinteger

User GPRS template ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_user_gprs_template
operationId: POST_edit_user_gprs_template

Edit user GPRS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
application/json
{
  "status": 1,
  "item": {
    "id": 2,
    "user_id": 2,
    "title": "GPRS Title",
    "message": "message content",
    "updated_at": "2016-06-26 17:41:43",
    "created_at": "2016-06-26 17:41:43"
  }
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_user_gprs_template_data
operationId: GET_edit_user_gprs_template_data

Get data to edit user GPRS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
user_gprs_template_id requiredinteger

User GPRS template ID

Responses

200
FieldTypeDescription
item → gprstemplate
protocols array[
FieldTypeDescription
id string
title string
]
status integer
application/json
{
  "item": {
    "id": 1,
    "user_id": 2,
    "title": "Template title",
    "message": "Template message",
    "created_at": "2016-06-26 17:31:48",
    "updated_at": "2016-06-26 17:31:48"
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_user_gprs_message
operationId: GET_get_user_gprs_message

Get user GPRS templates

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
user_gprs_template_id requiredinteger

User GPRS template ID

Responses

200
FieldTypeDescription
status integer
message string
application/json
{
  "status": 1,
  "message": "message content"
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_user_gprs_templates
operationId: GET_get_user_gprs_templates

Get user GPRS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
items object
status integer
application/json
{
  "items": {
    "user_gprs_templates": {
      "total": 1,
      "per_page": 10,
      "current_page": 1,
      "last_page": 1,
      "next_page_url": null,
      "prev_page_url": null,
      "from": 1,
      "to": 1,
      "data": [
        {
          "id": 1,
          "user_id": 2,
          "title": "Template title",
          "message": "Template message",
          "created_at": "2016-06-26 17:31:48",
          "updated_at": "2016-06-26 17:31:48"
        }
      ],
      "url": "api/get_user_gprs_templates"
    }
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

History

History

POST http://127.0.0.1/api/delete_history_positions
operationId: POST_delete_history_positions

Delete device positions

Request

Query Parameters

NameTypeDescription
device_id requiredinteger

Device ID

lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer | array

Responses

200
FieldTypeDescription
status integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_history
operationId: GET_get_history

Get device history

Request

Query Parameters

NameTypeDescription
snap_to_road boolean

Align GPS point to the nearest point on a road network

lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

from_date requiredstring

Date from

from_time requiredstring

Time from

to_date requiredstring

Date to

to_time requiredstring

Time to

Responses

200
FieldTypeDescription
items array[→ historyitem]
distance_sum string
top_speed string
move_duration string
stop_duration string
engine_hours string
engine_idle string
engine_work string
fuel_consumption string
device → device
sensors array[object]
item_class array[
FieldTypeDescription
id integer
value string
]
images array[
FieldTypeDescription
id integer
value string
]
sensors_values array[object]
fuel_consumption_arr array[object]
status integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_history_messages
operationId: GET_get_history_messages

Get device history paginated

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

from_date requiredstring

Date from

from_time requiredstring

Time from

to_date requiredstring

Date to

to_time requiredstring

Time to

page integer

Page number

limit integer

Limit of items in page

Responses

200
FieldTypeDescription
messages object
sensors array[→ sensor]
pagination_limits object
limit integer
sorting string
status integer
application/json
{
  "messages": {
    "total": 104,
    "per_page": 50,
    "current_page": 1,
    "last_page": 3,
    "next_page_url": "/?page=2",
    "prev_page_url": null,
    "from": 1,
    "to": 50,
    "data": [
      {
        "id": "1",
        "device_id": "3",
        "altitude": 189,
        "course": "265.200012207031",
        "latitude": "55.92291271",
        "longitude": "23.34606776",
        "other": "<info><battery>73.0</battery><ip>78.63.151.5</ip></info>",
        "power": null,
        "speed": 8,
        "time": "2016-04-25 18:53:39",
        "server_time": "2016-04-25 16:53:39",
        "valid": "1",
        "distance": "0",
        "protocol": "osmand",
        "sensor_id": "1",
        "sort": 1461603219,
        "other_arr": [
          "battery: 73.0",
          "ip: 78.63.151.5"
        ],
        "popup_sensors": {
          "2": {
            "name": "test acc",
            "value": "- nn"
          }
        },
        "sensors_value": {
          "2": "- nn"
        }
      },
      {
        "id": "2",
        "device_id": "3",
        "altitude": 217,
        "course": "148.699996948242",
        "latitude": "55.92245666",
        "longitude": "23.34677656",
        "other": "<info><battery>73.0</battery><ip>78.63.151.5</ip></info>",
        "power": null,
        "speed": 4,
        "time": "2016-04-25 18:55:48",
        "server_time": "2016-04-25 16:55:48",
        "valid": "1",
        "distance": "0.067153151821832",
        "protocol": "osmand",
        "sensor_id": "2",
        "sort": 1461603348,
        "other_arr": [
          "battery: 73.0",
          "ip: 78.63.151.5"
        ],
        "popup_sensors": {
          "2": {
            "name": "test acc",
            "value": "- nn"
          }
        },
        "sensors_value": {
          "2": "- nn"
        }
      }
    ],
    "url": "/api/get_history_messages"
  },
  "sensors": [
    {
      "id": "2",
      "user_id": "2",
      "device_id": "3",
      "name": "test acc",
      "type": "acc",
      "tag_name": "tag",
      "add_to_history": "0",
      "on_value": "on",
      "off_value": "off",
      "shown_value_by": null,
      "fuel_tank_name": null,
      "full_tank": null,
      "full_tank_value": null,
      "min_value": null,
      "max_value": null,
      "formula": null,
      "odometer_value_by": null,
      "odometer_value": null,
      "odometer_value_unit": "km",
      "temperature_max": null,
      "temperature_max_value": null,
      "temperature_min": null,
      "temperature_min_value": null,
      "value": "-",
      "value_formula": "0",
      "show_in_popup": "1",
      "unit_of_measurement": "nn",
      "on_tag_value": null,
      "off_tag_value": null,
      "on_type": null,
      "off_type": null,
      "calibrations": null
    }
  ],
  "pagination_limits": {
    "50": 50,
    "100": 100,
    "200": 200,
    "400": 400
  },
  "limit": 50,
  "sorting": "asc",
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Map icon

Map icon

POST http://127.0.0.1/api/add_map_icon
operationId: POST_add_map_icon

Create map icon

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body → mapiconpost

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/change_active_map_icon
operationId: GET_change_active_map_icon

Change active status for map icon

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer | array
active boolean

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_map_icon
operationId: GET_destroy_map_icon

Delete map icon

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
map_icon_id requiredinteger

Map icon ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_map_icon
operationId: POST_edit_map_icon

Update map icon

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body any

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_map_icons
operationId: GET_get_map_icons

Get map icons

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
items array[→ mapicon]
status integer
application/json
{
  "items": [
    {
      "id": 1,
      "path": "frontend/images/map_icons/543ccabd1373b8.41756394.png",
      "width": "32.00",
      "height": "37.00"
    },
    {
      "id": 2,
      "path": "frontend/images/map_icons/543ccabd141637.00777195.png",
      "width": "32.00",
      "height": "37.00"
    },
    {
      "id": 3,
      "path": "frontend/images/map_icons/543ccabd509796.35593817.png",
      "width": "32.00",
      "height": "37.00"
    },
    {
      "id": 53,
      "path": "frontend/images/map_icons/test-2.png",
      "width": "32.00",
      "height": "37.00"
    },
    {
      "id": 54,
      "path": "frontend/images/map_icons/velocimeter.png",
      "width": "32.00",
      "height": "37.00"
    }
  ],
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_user_map_icons
operationId: GET_get_user_map_icons

Get user map icons

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
s string

Value to search in items properties

Responses

200
FieldTypeDescription
items object
status integer
application/json
{
  "items": {
    "mapIcons": [
      {
        "id": 1,
        "user_id": 2,
        "map_icon_id": 26,
        "active": 1,
        "name": "Test icon",
        "description": "",
        "coordinates": "{\n    \"lat\": 54.948442387473655,\n    \"lng\": 23.94847869873047\n}",
        "created_at": "2016-06-26 16:33:46",
        "updated_at": "2016-06-26 16:37:17",
        "map_icon": {
          "id": 26,
          "path": "frontend/images/map_icons/543cec0b0e95d2.88837937.png",
          "width": "32.00",
          "height": "37.00"
        }
      }
    ]
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/pois_groups
Get map icon groups list
operationId: get-pois_groups

Get map icon groups list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
search_phrase string

Value to be detected in properties

limit integer

Items per page

sort_by string

Column to sort by

sort string

Sort direction

Responses

200
FieldTypeDescription
0 object
pagination → pagination_compact
application/json
{
  "0": {
    "id": 1,
    "user_id": 1,
    "title": "group",
    "open": true
  },
  "pagination": {
    "total": 2,
    "per_page": 1,
    "current_page": 1,
    "last_page": 2,
    "next_page_url": "/api/pois_groups?page=2",
    "prev_page_url": null
  }
}
POST http://127.0.0.1/api/pois_groups/store
Create map icon group
operationId: post-pois_groups-store

Create map icon group

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
title string
open boolean
pois array[integer]

Responses

200
FieldTypeDescription
status integer
id integer
application/json
{
  "status": 1,
  "id": 5
}
PUT http://127.0.0.1/api/pois_groups/update/{id}
Update map icon group
operationId: put-pois_groups-update-id

Update map icon group

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
title string
open boolean
pois array[integer]

Responses

200
FieldTypeDescription
status integer
id integer
application/json
{
  "status": 1,
  "id": 5
}

Report

Report

POST http://127.0.0.1/api/add_report
operationId: POST_add_report

Create report

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body any

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_report_data
operationId: GET_add_report_data

Get data to create report

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
devices array[→ device]
geofences array[→ geofence]
formats array[
FieldTypeDescription
id string
value string
]
stops array[
FieldTypeDescription
id integer
value string
]
filters array[
FieldTypeDescription
id integer
value string
]
types array[
FieldTypeDescription
id integer
value string
]
reports any
logs object
status integer
application/json
{
  "devices": [
    {
      "id": "3",
      "user_id": null,
      "traccar_device_id": "3",
      "icon_id": "8",
      "active": "1",
      "deleted": "0",
      "name": "Device name",
      "imei": "789832",
      "fuel_measurement_id": "1",
      "fuel_quantity": "0.00",
      "fuel_price": "0.00",
      "fuel_per_km": "0.00",
      "sim_number": "",
      "device_model": "",
      "plate_number": "",
      "vin": "",
      "registration_number": "",
      "object_owner": "",
      "expiration_date": "0000-00-00",
      "tail_color": "#33cc33",
      "tail_length": "5",
      "engine_hours": "gps",
      "detect_engine": "gps",
      "min_moving_speed": "6",
      "min_fuel_fillings": "10",
      "min_fuel_thefts": "10",
      "snap_to_road": "0",
      "created_at": "2016-04-25 16:21:19",
      "updated_at": "2016-06-26 15:52:46",
      "pivot": {
        "user_id": "2",
        "device_id": "3",
        "group_id": null,
        "current_driver_id": "1",
        "active": "1",
        "timezone_id": null
      },
      "traccar": {
        "id": "3",
        "name": "Device name",
        "uniqueId": "789832",
        "latestPosition_id": "99",
        "lastValidLatitude": "55.92299604",
        "lastValidLongitude": "23.34669059",
        "other": "<info><battery>31.0</battery><ip>83.181.149.238</ip></info>",
        "speed": "0.00",
        "time": "2016-04-29 19:01:26",
        "server_time": "2016-04-29 19:01:26",
        "ack_time": null,
        "altitude": "175",
        "course": "0",
        "power": null,
        "address": null,
        "protocol": "osmand",
        "latest_positions": "55.92297793/23.34665713;55.92336524/23.34666575;55.91928624/23.34572509;55.91590619/23.33778733;55.91986482/23.3255625;55.92581495/23.30829421;55.92748307/23.30725942;55.92966571/23.31183084;55.93430696/23.31986459;55.93769598/23.32408059;55.94483741/23.33093897;55.94417471/23.33107782;55.93988092/23.32629426;55.93719855/23.32534909;55.93344595/23.32372258"
      },
      "icon": {
        "id": "8",
        "order": "3",
        "width": "43.00",
        "height": "57.00",
        "path": "frontend/images/device_icons/8.png"
      },
      "sensors": [
        {
          "id": "1",
          "user_id": "2",
          "device_id": "3",
          "name": "Sensor test",
          "type": "battery",
          "tag_name": "Parameter name",
          "add_to_history": "0",
          "on_value": null,
          "off_value": null,
          "shown_value_by": "tag_value",
          "fuel_tank_name": null,
          "full_tank": null,
          "full_tank_value": null,
          "min_value": null,
          "max_value": null,
          "formula": null,
          "odometer_value_by": null,
          "odometer_value": null,
          "odometer_value_unit": "km",
          "temperature_max": null,
          "temperature_max_value": null,
          "temperature_min": null,
          "temperature_min_value": null,
          "value": "-",
          "value_formula": "0",
          "show_in_popup": "0",
          "unit_of_measurement": "nn",
          "on_tag_value": null,
          "off_tag_value": null,
          "on_type": null,
          "off_type": null,
          "calibrations": null
        }
      ],
      "services": [
        {
          "id": "1",
          "user_id": "2",
          "device_id": "3",
          "name": "Test service",
          "expiration_by": "engine_hours",
          "interval": "0",
          "last_service": "1000",
          "trigger_event_left": "0",
          "renew_after_expiration": "0",
          "expires": "1000",
          "expires_date": null,
          "remind": "1000",
          "remind_date": null,
          "event_sent": "0",
          "expired": "0",
          "email": "",
          "mobile_phone": ""
        }
      ]
    }
  ],
  "geofences": [
    {
      "id": 1,
      "user_id": 2,
      "group_id": null,
      "active": 1,
      "name": "Test geo",
      "coordinates": "[\n    {\n        \"lat\": 55.925307141049,\n        \"lng\": 23.350710868835\n    },\n    {\n        \"lat\": 55.926918076798,\n        \"lng\": 23.333630561829\n    },\n    {\n        \"lat\": 55.91948797954,\n        \"lng\": 23.331656455994\n    },\n    {\n        \"lat\": 55.916000873283,\n        \"lng\": 23.340711593628\n    },\n    {\n        \"lat\": 55.925066697134,\n        \"lng\": 23.353199958801\n    }\n]",
      "polygon_color": "#d000df",
      "created_at": "2016-04-28 22:13:17",
      "updated_at": "2016-04-28 22:13:34"
    }
  ],
  "formats": [
    {
      "id": "html",
      "value": "HTML"
    },
    {
      "id": "xls",
      "value": "XLS"
    },
    {
      "id": "pdf",
      "value": "PDF"
    },
    {
      "id": "pdf_land",
      "value": "PDF (Landscape)"
    }
  ],
  "stops": [
    {
      "id": 1,
      "value": "> 1 min"
    },
    {
      "id": 2,
      "value": "> 2 min"
    },
    {
      "id": 5,
      "value": "> 5 min"
    },
    {
      "id": 10,
      "value": "> 10 min"
    },
    {
      "id": 20,
      "value": "> 20 min"
    },
    {
      "id": 30,
      "value": "> 30 min"
    },
    {
      "id": 60,
      "value": "> 1 h"
    },
    {
      "id": 120,
      "value": "> 2 h"
    },
    {
      "id": 300,
      "value": "> 5 h"
    }
  ],
  "filters": [
    {
      "id": 0,
      "value": ""
    },
    {
      "id": 1,
      "value": "Today"
    },
    {
      "id": 2,
      "value": "Yesterday"
    },
    {
      "id": 3,
      "value": "Before 2 days"
    },
    {
      "id": 4,
      "value": "Before 3 days"
    },
    {
      "id": 5,
      "value": "This week"
    },
    {
      "id": 6,
      "value": "Last week"
    },
    {
      "id": 7,
      "value": "This month"
    },
    {
      "id": 8,
      "value": "Last month"
    }
  ],
  "types": [
    {
      "id": 1,
      "value": "General information"
    },
    {
      "id": 2,
      "value": "General information (merged)"
    },
    {
      "id": 3,
      "value": "Drives and stops"
    },
    {
      "id": 18,
      "value": "Drives and stops / Geofences"
    },
    {
      "id": 4,
      "value": "Travel sheet"
    },
    {
      "id": 5,
      "value": "Overspeed"
    },
    {
      "id": 6,
      "value": "Underspeed"
    },
    {
      "id": 7,
      "value": "Geofence in/out"
    },
    {
      "id": 15,
      "value": "Geofence in/out 24 hour mode"
    },
    {
      "id": 8,
      "value": "Events"
    },
    {
      "id": 10,
      "value": "Fuel level"
    },
    {
      "id": 11,
      "value": "Fuel fillings"
    },
    {
      "id": 12,
      "value": "Fuel thefts"
    },
    {
      "id": 13,
      "value": "Temperature"
    },
    {
      "id": 14,
      "value": "RAG"
    }
  ],
  "reports": {
    "total": 1,
    "per_page": 10,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 1,
    "data": [
      {
        "id": "2",
        "user_id": "2",
        "title": "Report title",
        "type": "4",
        "format": "html",
        "show_addresses": null,
        "zones_instead": null,
        "stops": "1",
        "speed_limit": null,
        "daily": null,
        "weekly": null,
        "email": "",
        "weekly_email_sent": "2016-06-27 00:00:00",
        "daily_email_sent": "2016-06-26 00:00:00",
        "devices": [
          1,
          2,
          3
        ],
        "geofences": []
      }
    ],
    "url": "/api/get_reports"
  },
  "logs": {
    "sorting": {
      "sort": "desc",
      "sort_by": "id"
    }
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_report
operationId: GET_destroy_report

Delete report

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
report_id requiredinteger

Report ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_report
operationId: POST_edit_report

Edit report

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body any

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/generate_report
operationId: POST_generate_report

If the request is successfully returned { 'status': 3 'url': ###}. "url" is link to generated report file

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body any

Responses

200
FieldTypeDescription
status integer
url string
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_reports
operationId: GET_get_reports

Get reports

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
items object
application/json
{
  "status": 1,
  "items": {
    "reports": {
      "total": 1,
      "per_page": 10,
      "current_page": 1,
      "last_page": 1,
      "next_page_url": null,
      "prev_page_url": null,
      "from": 1,
      "to": 1,
      "data": [
        {
          "id": "2",
          "user_id": "2",
          "title": "Report title",
          "type": "4",
          "format": "html",
          "show_addresses": null,
          "zones_instead": null,
          "stops": "1",
          "speed_limit": null,
          "daily": null,
          "weekly": null,
          "email": "",
          "weekly_email_sent": "2016-06-27 00:00:00",
          "daily_email_sent": "2016-06-26 00:00:00",
          "devices": [
            3
          ],
          "geofences": []
        }
      ],
      "url": "/api/get_reports"
    },
    "types": [
      {
        "id": 1,
        "title": "General information"
      },
      {
        "id": 2,
        "title": "General information (merged)"
      },
      {
        "id": 3,
        "title": "Drives and stops"
      },
      {
        "id": 18,
        "title": "Drives and stops / Geofences"
      },
      {
        "id": 4,
        "title": "Travel sheet"
      },
      {
        "id": 5,
        "title": "Overspeed"
      },
      {
        "id": 6,
        "title": "Underspeed"
      },
      {
        "id": 7,
        "title": "Geofence in/out"
      },
      {
        "id": 15,
        "title": "Geofence in/out 24 hour mode"
      },
      {
        "id": 8,
        "title": "Events"
      },
      {
        "id": 10,
        "title": "Fuel level"
      },
      {
        "id": 11,
        "title": "Fuel fillings"
      },
      {
        "id": 12,
        "title": "Fuel thefts"
      },
      {
        "id": 13,
        "title": "Temperature"
      },
      {
        "id": 14,
        "title": "RAG"
      }
    ]
  }
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_reports_types
operationId: GET_get_reports_types

Get report types

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
items array[→ reportType]
status integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Route

Route

POST http://127.0.0.1/api/add_route
operationId: POST_add_route

Create route

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/change_active_route
operationId: GET_change_active_route

Change active status for routes

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer | array
active boolean

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_route
operationId: GET_destroy_route

Delete route

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
route_id requiredinteger

Route ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_route
operationId: POST_edit_route

Edit route

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_routes
operationId: GET_get_routes

Get routes

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
data array[
FieldTypeDescription
id integer
group_id integer
active integer
name string
color string

Example: #AA00F5

coordinates array[
FieldTypeDescription
lat number
lng number
]
]
pagination → pagination_compact
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
default
GET http://127.0.0.1/api/routes_groups
Get route groups list
operationId: get-routes_groups

Get route groups list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
search_phrase string

Value to be detected in properties

limit integer

Items per page

sort_by string

Column to sort by

sort string

Sort direction

Responses

200
FieldTypeDescription
0 object
pagination → pagination_compact
application/json
{
  "0": {
    "id": 1,
    "user_id": 1,
    "title": "group",
    "open": true
  },
  "pagination": {
    "total": 2,
    "per_page": 1,
    "current_page": 1,
    "last_page": 2,
    "next_page_url": "/api/routes_groups?page=2",
    "prev_page_url": null
  }
}
POST http://127.0.0.1/api/routes_groups/store
Create route group
operationId: post-routes_groups-store

Create route group

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
title string
open boolean
routes array[integer]

Responses

200
FieldTypeDescription
status integer
id integer
application/json
{
  "status": 1,
  "id": 5
}
PUT http://127.0.0.1/api/routes_groups/update/{id}
Update route group
operationId: put-routes_groups-update-id

Update route group

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
title string
open boolean
routes array[integer]

Responses

200
FieldTypeDescription
status integer
id integer
application/json
{
  "status": 1,
  "id": 5
}

Sensor

Sensor

POST http://127.0.0.1/api/add_sensor
operationId: POST_add_sensor

The fields depends on the sensor type, which can see the web version.

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body → sensorpost

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_sensor_data
operationId: GET_add_sensor_data

Get data to create device sensor

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

Responses

200
FieldTypeDescription
sensors → sensors
device_id integer
route string
status integer
application/json
{
  "sensors": {
    "acc": "ACC ON/OFF",
    "battery": "Battery",
    "door": "Door Open/Close",
    "engine": "Engine ON/OFF",
    "engine_hours": "Engine hours",
    "fuel_tank": "Fuel tank",
    "fuel_tank_calibration": "Fuel tank (with calibration)",
    "gsm": "GSM",
    "harsh_acceleration": "Harsh acceleration ",
    "harsh_breaking": "Harsh breaking",
    "ignition": "Ignition ON/OFF",
    "odometer": "Odometer",
    "satellites": "Satellites",
    "tachometer": "Tachometer",
    "temperature": "Temperature"
  },
  "device_id": 1,
  "route": "sensors.store",
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_sensor
operationId: GET_destroy_sensor

Delete device sensor

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
sensor_id requiredinteger

Device sensor ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_sensor
operationId: POST_edit_sensor

Edit device sensor

Request

Query Parameters

NameTypeDescription
sensor_id requiredinteger

Device sensor ID

lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body → sensorpost

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_sensor_data
operationId: GET_edit_sensor_data

Get data to edit device sensor

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
sensor_id requiredinteger

Device sensor ID

Responses

200
FieldTypeDescription
sensors → sensors
device_id string | integer
item → sensor
route string
status string | integer
application/json
{
  "sensors": {
    "acc": "ACC ON/OFF",
    "battery": "Battery",
    "door": "Door Open/Close",
    "engine": "Engine ON/OFF",
    "engine_hours": "Engine hours",
    "fuel_tank": "Fuel tank",
    "fuel_tank_calibration": "Fuel tank (with calibration)",
    "gsm": "GSM",
    "harsh_acceleration": "Harsh acceleration ",
    "harsh_breaking": "Harsh breaking",
    "ignition": "Ignition ON/OFF",
    "odometer": "Odometer",
    "satellites": "Satellites",
    "tachometer": "Tachometer",
    "temperature": "Temperature"
  },
  "device_id": "3",
  "item": {
    "id": "2",
    "user_id": "2",
    "device_id": "3",
    "name": "test acc",
    "type": "acc",
    "tag_name": "tag",
    "add_to_history": "0",
    "on_value": "on",
    "off_value": "off",
    "shown_value_by": null,
    "fuel_tank_name": null,
    "full_tank": null,
    "full_tank_value": null,
    "min_value": null,
    "max_value": null,
    "formula": null,
    "odometer_value_by": null,
    "odometer_value": null,
    "odometer_value_unit": "km",
    "temperature_max": null,
    "temperature_max_value": null,
    "temperature_min": null,
    "temperature_min_value": null,
    "value": "-",
    "value_formula": "0",
    "show_in_popup": "1",
    "unit_of_measurement": "nn",
    "on_tag_value": null,
    "off_tag_value": null,
    "on_type": null,
    "off_type": null,
    "calibrations": null
  },
  "route": "sensors.update",
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_sensors
Get device sensors
operationId: get-get_sensors

Get device sensors

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

Responses

200
FieldTypeDescription
current_page integer
data array[any]
first_page_url string | null
from integer
last_page integer
last_page_url string | null
links array[any]
next_page_url string | null
path string
per_page integer
prev_page_url string | null
to integer
total integer
url string
status integer
application/json
{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "device_id": 3,
      "name": "engine on",
      "type": "engine",
      "tag_name": "enginehours",
      "add_to_history": 0,
      "on_value": null,
      "off_value": null,
      "shown_value_by": null,
      "fuel_tank_name": null,
      "full_tank": null,
      "full_tank_value": null,
      "min_value": null,
      "max_value": null,
      "formula": null,
      "odometer_value_by": null,
      "odometer_value": null,
      "odometer_value_unit": "km",
      "temperature_max": null,
      "temperature_max_value": null,
      "temperature_min": null,
      "temperature_min_value": null,
      "value": "-",
      "value_formula": 0,
      "show_in_popup": 0,
      "unit_of_measurement": "",
      "on_tag_value": "1",
      "off_tag_value": "-1",
      "on_type": 1,
      "off_type": 1,
      "data": null,
      "calibrations": null,
      "skip_calibration": null,
      "skip_empty": null,
      "decbin": 0,
      "hexbin": 0,
      "type_title": "Engine ON/OFF"
    }
  ],
  "first_page_url": "/api/get_sensors?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "/api/get_sensors?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "/api/get_sensors?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "/api/get_sensors",
  "per_page": 10,
  "prev_page_url": null,
  "to": 5,
  "total": 5,
  "url": "/api/get_sensors",
  "status": 1
}

Service

Service

POST http://127.0.0.1/api/add_service
operationId: POST_add_service

Create device service

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_service_data
operationId: GET_add_service_data

Get data to create device service

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

Responses

200
FieldTypeDescription
device_id integer
odometer_value string
engine_hours_value string
expiration_by → servicetypes
status integer
application/json
{
  "device_id": 1,
  "odometer_value": "0",
  "engine_hours_value": "0",
  "expiration_by": {
    "odometer": "Odometer",
    "engine_hours": "Engine hours",
    "days": "Days"
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_service
operationId: GET_destroy_service

Delete device service

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
service_id requiredinteger

Device service ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_service
operationId: POST_edit_service

Edit device service

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body any

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_service_data
operationId: GET_edit_service_data

Get data to edit device service

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
service_id requiredinteger

Device service ID

Responses

200
FieldTypeDescription
device_id integer
odometer_value string
engine_hours_value string
expiration_by → servicetypes
item → service
status integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_services
Get device services
operationId: get-get_services

Get device services

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
device_id requiredinteger

Device ID

Responses

200
FieldTypeDescription
current_page integer
data array[any]
first_page_url string | null
from integer
last_page integer
last_page_url string | null
links array[any]
next_page_url string | null
path string
per_page integer
prev_page_url string | null
to integer
total integer
url string
status integer
application/json
{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "device_id": 3,
      "name": "odomter",
      "expiration_by": "odometer",
      "interval": 3600,
      "last_service": "0",
      "trigger_event_left": 1,
      "renew_after_expiration": 0,
      "expires": "\"Sensor\" was not found.",
      "expires_date": null,
      "remind": 3599,
      "remind_date": null,
      "event_sent": 0,
      "expired": 0,
      "email": "",
      "mobile_phone": "",
      "description": "",
      "device": {
        "id": 3,
        "user_id": null,
        "current_driver_id": 1,
        "timezone_id": null,
        "traccar_device_id": 3,
        "icon_id": 0,
        "icon_colors": {
          "moving": "green",
          "stopped": "yellow",
          "offline": "red",
          "engine": "yellow"
        },
        "active": 1,
        "kind": 0,
        "deleted": 0,
        "name": "Demo 1",
        "imei": "100000001",
        "fuel_measurement_id": 1,
        "fuel_quantity": "0.00",
        "fuel_price": "0.00",
        "fuel_per_km": "0.0000",
        "fuel_per_h": "0.0000",
        "sim_number": "",
        "msisdn": null,
        "device_model": "",
        "plate_number": "",
        "vin": "",
        "registration_number": "",
        "object_owner": "",
        "additional_notes": "",
        "authentication": "",
        "comment": "",
        "expiration_date": null,
        "sim_expiration_date": "0000-00-00",
        "sim_activation_date": "0000-00-00",
        "installation_date": "0000-00-00",
        "tail_color": "#33cc33",
        "tail_length": 5,
        "engine_hours": "gps",
        "detect_engine": "gps",
        "detect_speed": "gps",
        "detect_distance": null,
        "min_moving_speed": 6,
        "min_fuel_fillings": 10,
        "min_fuel_thefts": 10,
        "snap_to_road": 0,
        "gprs_templates_only": false,
        "valid_by_avg_speed": 1,
        "parameters": "[\"sat\",\"hdop\",\"rfid\",\"valid\",\"enginehours\"]",
        "currents": null,
        "created_at": "2023-09-28 14:06:41",
        "updated_at": "2023-11-30 14:32:11",
        "forward": null,
        "device_type_id": null,
        "app_tracker_login": 0,
        "fuel_detect_sec_after_stop": 0,
        "sensors": [
          {
            "id": 4054,
            "user_id": 1,
            "device_id": 3,
            "name": "temp",
            "type": "temperature",
            "tag_name": "hdop",
            "add_to_history": 0,
            "on_value": null,
            "off_value": null,
            "shown_value_by": null,
            "fuel_tank_name": null,
            "full_tank": null,
            "full_tank_value": null,
            "min_value": null,
            "max_value": null,
            "formula": "[value]*50",
            "odometer_value_by": null,
            "odometer_value": null,
            "odometer_value_unit": "km",
            "temperature_max": null,
            "temperature_max_value": null,
            "temperature_min": null,
            "temperature_min_value": null,
            "value": "43",
            "value_formula": 0,
            "show_in_popup": 0,
            "unit_of_measurement": "C",
            "on_tag_value": null,
            "off_tag_value": null,
            "on_type": null,
            "off_type": null,
            "data": null,
            "calibrations": null,
            "skip_calibration": null,
            "skip_empty": null,
            "decbin": 0,
            "hexbin": 0
          }
        ]
      }
    }
  ],
  "first_page_url": "/api/get_services?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "/api/get_services?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "/api/get_services?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "/api/get_services",
  "per_page": 10,
  "prev_page_url": null,
  "to": 1,
  "total": 1,
  "url": "/api/get_services",
  "status": 1
}

Setup

Setup

POST http://127.0.0.1/api/change_password
operationId: POST_change_password

Change password

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
password string

Responses

200

Success

400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_setup
operationId: POST_edit_setup

Edit account settings

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
unit_of_distance requiredstring
unit_of_capacity requiredstring
unit_of_altitude requiredstring
timezone_id requiredinteger
groups requiredarray[
FieldTypeDescription
id integer
title string
]
sms_gateway requiredinteger
request_method string
encoding integer
authentication integer
username string
password string
auth_id string
auth_token string
senders_phone string
sms_gateway_url string
week_start_day integer
dst_type string

exact, other, automatic

date_from string
date_to string
month_from integer
month_to integer
week_pos_from integer
week_pos_to integer
week_day_from integer
week_day_to integer
time_from string
time_to string
dst_country_id integer

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_setup_data
operationId: GET_edit_setup_data

Get data to edit account settings

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
item object
timezones array[
FieldTypeDescription
id integer
value string
]
units_of_distance array[
FieldTypeDescription
id string
value string
]
units_of_capacity array[
FieldTypeDescription
id string
value string
]
units_of_altitude array[
FieldTypeDescription
id string
value string
]
groups array[object]
sms_queue_count integer
request_method_select array[
FieldTypeDescription
id string
value string
]
encoding_select array[
FieldTypeDescription
id integer | string
value string
]
authentication_select array[
FieldTypeDescription
id integer
value string
]
dst_types array[
FieldTypeDescription
id string
value string
]
user_dst null
months array[
FieldTypeDescription
id string
value string
]
weekdays object
week_pos object
dst_countries array[
FieldTypeDescription
id integer
value string
]
status integer
application/json
{
  "item": {
    "id": 2,
    "active": 1,
    "group_id": 1,
    "manager_id": null,
    "billing_plan_id": null,
    "map_id": 1,
    "devices_limit": null,
    "email": "admin@yourdomain.com",
    "password": "***",
    "subscription_expiration": "0000-00-00 00:00:00",
    "loged_at": "2016-05-27 01:10:36",
    "api_hash": "***",
    "available_maps": {
      "1": 1,
      "2": 2,
      "3": 3,
      "4": 4,
      "5": 5,
      "6": 6,
      "7": 7,
      "8": 8,
      "9": 9
    },
    "sms_gateway_app_date": "0000-00-00 00:00:00",
    "sms_gateway_params": {
      "request_method": "get",
      "authentication": "0",
      "username": "",
      "password": null,
      "encoding": null
    },
    "open_geofence_groups": "[\n    \"0\"\n]",
    "open_device_groups": "[\n    \"0\"\n]",
    "created_at": "2016-04-19 16:31:00",
    "updated_at": "2016-06-27 01:10:36",
    "unit_of_altitude": "mt",
    "lang": "en",
    "unit_of_distance": "km",
    "unit_of_capacity": "lt",
    "timezone_id": "65",
    "sms_gateway": "0",
    "sms_gateway_url": ""
  },
  "timezones": [
    {
      "id": 1,
      "value": "UTC -14:00"
    },
    {
      "id": 2,
      "value": "UTC -13:45"
    },
    {
      "id": 3,
      "value": "UTC -13:30"
    },
    {
      "id": 4,
      "value": "UTC -13:15"
    },
    {
      "id": 5,
      "value": "UTC -13:00"
    },
    {
      "id": 6,
      "value": "UTC -12:45"
    }
  ],
  "units_of_distance": [
    {
      "id": "km",
      "value": "Kilometer"
    },
    {
      "id": "mi",
      "value": "Mile"
    }
  ],
  "units_of_capacity": [
    {
      "id": "lt",
      "value": "Liter"
    },
    {
      "id": "gl",
      "value": "Gallon"
    }
  ],
  "units_of_altitude": [
    {
      "id": "mt",
      "value": "Meter"
    },
    {
      "id": "ft",
      "value": "Feet"
    }
  ],
  "groups": [],
  "sms_queue_count": 0,
  "request_method_select": [
    {
      "id": "get",
      "value": "GET"
    },
    {
      "id": "post",
      "value": "POST"
    },
    {
      "id": "app",
      "value": "SMS gateway app"
    }
  ],
  "encoding_select": [
    {
      "id": 0,
      "value": "No"
    },
    {
      "id": "json",
      "value": "JSON"
    }
  ],
  "authentication_select": [
    {
      "id": 0,
      "value": "No"
    },
    {
      "id": 1,
      "value": "Yes"
    }
  ],
  "dst_types": [
    {
      "id": "none",
      "value": "None"
    },
    {
      "id": "exact",
      "value": "Exact date"
    },
    {
      "id": "automatic",
      "value": "Automatic"
    },
    {
      "id": "other",
      "value": "Other"
    }
  ],
  "user_dst": null,
  "months": [
    {
      "id": "january",
      "value": "January"
    },
    {
      "id": "february",
      "value": "February"
    },
    {
      "id": "march",
      "value": "March"
    },
    {
      "id": "april",
      "value": "April"
    },
    {
      "id": "may",
      "value": "May"
    },
    {
      "id": "june",
      "value": "June"
    },
    {
      "id": "july",
      "value": "July"
    },
    {
      "id": "august",
      "value": "August"
    },
    {
      "id": "september",
      "value": "September"
    },
    {
      "id": "october",
      "value": "October"
    },
    {
      "id": "november",
      "value": "November"
    },
    {
      "id": "december",
      "value": "December"
    }
  ],
  "weekdays": {
    "monday": "Monday",
    "tuesday": "Tuesday",
    "wednesday": "Wednesday",
    "thursday": "Thursday",
    "friday": "friday",
    "saturday": "Saturday",
    "sunday": "Sunday"
  },
  "week_pos": {
    "first": "First",
    "last": "Last"
  },
  "dst_countries": [
    {
      "id": 1,
      "value": "Akrotiri and Dhekelia(UK)"
    },
    {
      "id": 2,
      "value": "Albania"
    },
    {
      "id": 3,
      "value": "Andorra"
    },
    {
      "id": 4,
      "value": "Australia"
    }
  ],
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_user_data
operationId: GET_get_user_data

Get data to create user

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
email string
expiration_date null | string
days_left null | integer
plan string
devices_limit integer
group_id integer
application/json
{
  "email": "admin@yourdomain.com",
  "expiration_date": null,
  "days_left": null,
  "plan": "Demo",
  "devices_limit": 0
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Sharing

Sharing

GET http://127.0.0.1/api/sharing
Get sharing list
operationId: get-sharing

Get sharing list

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
data array[→ sharing]
pagination → pagination_compact
application/json
{
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "name": "share",
      "hash": "hash",
      "expiration_date": "2124-03-01 00:00:00",
      "active": 0,
      "delete_after_expiration": 0
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null
  }
}
POST http://127.0.0.1/api/sharing
Create sharing
operationId: post-sharing

Create sharing

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
devices array[integer]
active boolean
name string
enable_expiration_date boolean
expiration_date string
email string | array

Email addresses to send message to

sms string | array

Phone numbers to send message to

Responses

200
application/json
{
  "id": 1,
  "user_id": 1,
  "name": "share",
  "hash": "hash",
  "expiration_date": "2124-03-01 00:00:00",
  "active": 0,
  "delete_after_expiration": 0
}
GET http://127.0.0.1/api/sharing/{id}
GET sharing item
operationId: get-sharing-id

GET sharing item

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
application/json
{
  "id": 1,
  "user_id": 1,
  "name": "share",
  "hash": "hash",
  "expiration_date": "2124-03-01 00:00:00",
  "active": 0,
  "delete_after_expiration": 0
}
PUT http://127.0.0.1/api/sharing/{id}
Update sharing item
operationId: put-sharing-id

Update sharing item

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
devices array[integer]
active boolean
name string
enable_expiration_date boolean
expiration_date string

Responses

200
application/json
{
  "id": 1,
  "user_id": 1,
  "name": "share",
  "hash": "hash",
  "expiration_date": "2124-03-01 00:00:00",
  "active": 0,
  "delete_after_expiration": 0
}
DELETE http://127.0.0.1/api/sharing/{id}
Delete sharing item
operationId: delete-sharing-id

Delete sharing item

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
PUT http://127.0.0.1/api/sharing/{id}/devices
Update sharing item devices
operationId: put-sharing-id-devices

Update sharing item devices

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
devices array[integer]

Responses

200
application/json
{
  "id": 1,
  "user_id": 1,
  "name": "share",
  "hash": "hash",
  "expiration_date": "2124-03-01 00:00:00",
  "active": 0,
  "delete_after_expiration": 0
}

SMS Template

SMS Template

POST http://127.0.0.1/api/add_user_sms_template
operationId: POST_add_user_sms_template

Create user SMS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
item → smstemplate
application/json
{
  "status": 1,
  "item": {
    "id": 2,
    "user_id": 2,
    "title": "GPRS Title",
    "message": "message content",
    "updated_at": "2016-06-26 17:41:43",
    "created_at": "2016-06-26 17:41:43"
  }
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/add_user_sms_template_data
operationId: GET_add_user_sms_template_data

Get data to create user SMS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
object
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/destroy_user_sms_template
operationId: GET_destroy_user_sms_template

Delete user SMS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
user_sms_template_id requiredinteger

User SMS template ID

Responses

200
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_user_sms_template
operationId: POST_edit_user_sms_template

Edit user SMS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
application/json
{
  "status": 1,
  "item": {
    "id": 2,
    "user_id": 2,
    "title": "GPRS Title",
    "message": "message content",
    "updated_at": "2016-06-26 17:41:43",
    "created_at": "2016-06-26 17:41:43"
  }
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/edit_user_sms_template_data
operationId: GET_edit_user_sms_template_data

Get data to edit user SMS template

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
user_sms_template_id requiredinteger

User SMS template ID

Responses

200
FieldTypeDescription
item → smstemplate
status integer
application/json
{
  "item": {
    "id": 1,
    "user_id": 2,
    "title": "Template title",
    "message": "Template message",
    "created_at": "2016-06-26 17:31:48",
    "updated_at": "2016-06-26 17:31:48"
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_user_sms_message
operationId: GET_get_user_sms_message

Get user SMS templates

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS
user_sms_template_id requiredinteger

User SMS template ID

Responses

200
FieldTypeDescription
status integer
message string
application/json
{
  "status": 1,
  "message": "message content"
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_user_sms_templates
operationId: GET_get_user_sms_templates

Get user SMS templates

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
items object
status integer
application/json
{
  "items": {
    "user_sms_templates": {
      "total": 1,
      "per_page": 10,
      "current_page": 1,
      "last_page": 1,
      "next_page_url": null,
      "prev_page_url": null,
      "from": 1,
      "to": 1,
      "data": [
        {
          "id": 1,
          "user_id": 2,
          "title": "Template title",
          "message": "Template message",
          "created_at": "2016-06-26 17:32:48",
          "updated_at": "2016-06-26 17:32:48"
        }
      ],
      "url": "/api/get_user_sms_templates"
    }
  },
  "status": 1
}
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

Task

Task

POST http://127.0.0.1/api/add_task
operationId: POST_add_task

Create task

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body → taskpost

Responses

200
FieldTypeDescription
status integer
item → task
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/destroy_task
operationId: POST_destroy_task

Delete task

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
id integer

Responses

200
FieldTypeDescription
status integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
POST http://127.0.0.1/api/edit_task/{id}
operationId: POST_edit_task-id

Edit task

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_task/{id}
operationId: GET_get_task-id

Get task

Request

Path Parameters

NameTypeDescription
id requiredinteger

ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
item → task
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_task_signature/{taskStatusId}
operationId: GET_get_task_signature-taskStatusId

Get task signature

Request

Path Parameters

NameTypeDescription
taskStatusId requiredstring

Task status ID

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200

Success

400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_tasks
operationId: GET_get_tasks

Get tasks

Request

Query Parameters

NameTypeDescription
search_device_id integer

Device ID

search_task_status integer

Task status

search_time_from string

Time from

search_time_to string

Time to

search_invoice_number string

Invoice number

lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
items object
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_tasks_priorities
operationId: GET_get_tasks_priorities

Get task priorities

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
items array[
FieldTypeDescription
id integer
title string
]
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object
GET http://127.0.0.1/api/get_tasks_statuses
operationId: GET_get_tasks_statuses

Get task statuses

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
status integer
items array[
FieldTypeDescription
id integer
title string
]
400
FieldTypeDescription
status integer
errors object
401
FieldTypeDescription
status integer
error string
500
object

User

User

GET http://127.0.0.1/api/admin/device/{device}/users
Get device users list
operationId: get-device-id-users

Get device users list

Request

Path Parameters

NameTypeDescription
device requiredstring

Device ID

Query Parameters

NameTypeDescription
limit integer

Items per page

Responses

200
FieldTypeDescription
status integer
data array[
FieldTypeDescription
id integer
email string
active integer
]
pagination → pagination_compact
application/json
{
  "status": 1,
  "data": [
    {
      "id": 7,
      "email": "test@compaany.com",
      "active": 1
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 30,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null
  }
}
GET http://127.0.0.1/api/user_client
Get current user's client
operationId: get-user_client

Get current user's client

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Responses

200
FieldTypeDescription
data object
POST http://127.0.0.1/api/user_client
Set current user's client
operationId: post-user_client

Set current user's client

Request

Query Parameters

NameTypeDescription
lang requiredstring

Lang

default: en
user_api_hash requiredstring

User API hash

default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS

Request Body

NameTypeDescription
body
FieldTypeDescription
first_name string
last_name string
birth_date string
personal_code string
address string

Responses

200
FieldTypeDescription
data object

Welcome

Welcome

GET http://127.0.0.1/api/insert.php
operationId: GET_insert-php

http://[YOUR_URL]/insert.php
<br><br>
uniqueId - device IMEI<br>
protocol - device protocol<br>
altitude - current device altitude in meters<br>
course - current device angle from 0 to 360<br>
latitude - current device latitude<br>
longitude - current device longitude<br>
speed - current device speed in knot unit (https://en.wikipedia.org/wiki/Knot_(unit))<br>
fixTime - current device time in timestamp with miliseconds<br>
attributes - key:value your other parameters<br>

Request

Request Body

NameTypeDescription
body
FieldTypeDescription
uniqueId requiredstring
altitude requirednumber
course requirednumber
latitude requirednumber
longitude requirednumber
speed requirednumber
fixTime requiredinteger
protocol requiredstring
attributes requiredarray[
FieldTypeDescription
key1 string | number | null | boolean
key2 string | number | null | boolean
keyN string | number | null | boolean
]

Responses

200
default
GET http://127.0.0.1/api/insert.php2
operationId: GET_insert-php2

http://[YOUR_URL]/insert.php

Request

Query Parameters

NameTypeDescription
uniqueId requiredstring

Device IMEI

protocol requiredstring

Device protocol

altitude requiredstring

Current device altitude in meters

course requiredstring

Current device angle from 0 to 360

latitude requiredstring

Current device latitude

longitude requiredstring

Current device longitude

speed requiredstring

Current device speed in knot unit (https://en.wikipedia.org/wiki/Knot_(unit))

fixTime requiredstring

Current device time in timestamp with miliseconds

attributes requiredarray[string]

Key-value array (e.g., attributes[attr1]=value1&attributes[attrN]=valueN)

Responses

200
default

Schemas / Models

task

FieldTypeDescription
id integer
device_id integer
title string
comment string
priority integer
status integer
pickup_address string
pickup_address_lat number
pickup_address_lng number
pickup_time_from string
pickup_time_to string
delivery_address string
delivery_address_lat number
delivery_address_lng number
delivery_time_from string
delivery_time_to string
created_at string
updated_at string
statuses array[→ task-status]
invoice_number string

geofencePost

FieldTypeDescription
name requiredstring
polygon_color requiredstring
polygon requiredarray[→ latlng]
group_id integer
type requiredstring
center → latlng2
radius number

device

FieldTypeDescription
id string
user_id integer | null
traccar_device_id string
icon_id string
active string
deleted string
name string
imei string
fuel_measurement_id string
fuel_quantity string
fuel_price string
fuel_per_km string
sim_number string
device_model string
plate_number string
vin string
registration_number string
object_owner string
expiration_date string
tail_color string
tail_length string
engine_hours string
detect_engine string
min_moving_speed string
min_fuel_fillings string
min_fuel_thefts string
snap_to_road string
created_at string
updated_at string
pivot object
traccar object
icon object
sensors array[
FieldTypeDescription
id string
user_id string
device_id string
name string
type string
tag_name string
add_to_history string
on_value null
off_value null
shown_value_by string
fuel_tank_name null
full_tank null
full_tank_value null
min_value null
max_value null
formula null
odometer_value_by null
odometer_value null
odometer_value_unit string
temperature_max null
temperature_max_value null
temperature_min null
temperature_min_value null
value string
value_formula string
show_in_popup string
unit_of_measurement string
on_tag_value null
off_tag_value null
on_type null
off_type null
calibrations null
]
services array[
FieldTypeDescription
id string
user_id string
device_id string
name string
expiration_by string
interval string
last_service string
trigger_event_left string
renew_after_expiration string
expires string
expires_date null
remind string
remind_date null
event_sent string
expired string
email string
mobile_phone string
]

mapiconpost

FieldTypeDescription
name requiredstring
description string
map_icon_id requiredinteger
coordinates required→ latlng

event

FieldTypeDescription
id integer
user_id integer
device_id integer
geofence_id integer
position_id integer
alert_id integer
message string
created_at string
updated_at string
address string
altitude number
course null | number
latitude number
longitude number
power null | number
speed number
time string
deleted integer

alert

FieldTypeDescription
id integer
user_id integer
active integer
name string
type string
overspeed integer

For type: overspeed

time_duration integer

For type: time_duration

stop_duration integer

For type: move_start, stop_duration, poi_stop_duration

offline_duration integer

For type: offline_duration

move_duration integer

For type: move_duration

min_parking_duration integer

For type: move_duration

idle_duration integer

For type: idle_duration, poi_idle_duration

ignition_duration integer

For type: ignition_duration

state integer

For type: ignition, fuel_change

authorized boolean

For type: driver_unauthorized

continuous_duration integer

For type: custom, unplugged

distance integer

For type: distance

period integer

For type: distance

distance_tolerance integer

For type: distance, poi_stop_duration, poi_idle_duration

task_status array[integer]

For type: statuses

created_at string
updated_at string
devices array[integer]
drivers array[integer]
geofences array[integer]
events_custom array[integer]
pois array[integer]
zone integer
zones array[object]
schedule boolean
schedules array[
FieldTypeDescription
id string
title string
items array[
FieldTypeDescription
id string
title string
active boolean
]
]
notifications object
command object | null

smstemplatepost

FieldTypeDescription
title string
message string

smstemplate

FieldTypeDescription
id integer
user_id integer
title string
message string
updated_at string
created_at string

servicetypes

FieldTypeDescription
key string

report

FieldTypeDescription
id integer | string
user_id integer | string
title string
type integer | string
format string
show_addresses null | integer
zones_instead null | integer
stops integer | string
speed_limit null | number
daily null | integer
weekly null | integer
email string
weekly_email_sent string
daily_email_sent string
devices array[integer]
geofences array[integer]

sensorpost

FieldTypeDescription
device_id requiredinteger
sensor_type requiredstring
sensor_name requiredstring
unit_of_measurement requiredstring
show_in_popup integer
tag_name string
shown_value_by string
min_value string
max_value string
formula string
odometer_value_by string
odometer_value string
calibrations array[
FieldTypeDescription
key integer
]
on_value string
off_value string

latlng

FieldTypeDescription
lat number
lng number

latlng2

FieldTypeDescription
lat number
lng number

pagination

FieldTypeDescription
total integer
per_page integer
current_page integer
last_page integer
from integer
to integer
next_page_url string | null
prev_page_url string | null
url string

pagination_compact

FieldTypeDescription
total integer
per_page integer
current_page integer
last_page integer
next_page_url string | null
prev_page_url string | null
url string

sharing

FieldTypeDescription
id integer
user_id integer
name string
hash string
expiration_date string
active integer
delete_after_expiration integer

call_action

FieldTypeDescription
id integer
user_id integer
device_id integer
alert_id integer
event_id integer
called_at string
response_type string
remarks string
created_at string
updated_at string

device_lookup

FieldTypeDescription
id integer
active boolean
name string
imei string
sim_number string | null
device_model string | null
plate_number string | null
vin string | null
registration_number string | null
object_owner string
additional_notes string | null
protocol string | null
expiration_date string | null

user

object

reportpost

FieldTypeDescription
title requiredstring
type requiredinteger
format requiredstring
speed_limit number
devices requiredarray[integer]
geofences array[integer]
daily integer
weekly integer
send_to_email string
date_from requiredstring
date_to requiredstring
from_time string
to_time string
show_addresses boolean
zones_instead boolean
stops integer

sensors

FieldTypeDescription
key string

gprstemplate

FieldTypeDescription
id integer
user_id integer
title string
message string
protocol string
updated_at string
created_at string

alertpost

FieldTypeDescription
name requiredstring
type requiredstring
devices requiredarray[integer]
zone integer
zones array[integer]
schedule boolean
schedules array[
FieldTypeDescription
monday array[string]
tuesday array[string]
wednesday array[string]
thursday array[string]
friday array[string]
saturday array[string]
sunday array[string]
]
notifications object
command object

service

FieldTypeDescription
id string | integer
user_id string | integer
device_id string | integer
name string
expiration_by string
interval string
last_service string
trigger_event_left string
renew_after_expiration string
expires string
expires_date null | string
remind string
remind_date null | string
event_sent string
expired string
email string
mobile_phone string
device → device

servicepost

FieldTypeDescription
device_id requiredinteger
name requiredstring
expiration_by requiredstring
interval requiredstring
last_service requiredstring
trigger_event_left requiredstring
renew_after_expiration requiredinteger
email string
mobile_phone string

sensor

FieldTypeDescription
id string | integer
user_id string | integer
device_id string | integer
name string
type string
tag_name string
add_to_history string | integer
on_value string
off_value string
shown_value_by null | string
fuel_tank_name null | string
full_tank null | string
full_tank_value null | string
min_value null | string
max_value null | string
formula null | string
odometer_value_by null | string
odometer_value null | string
odometer_value_unit string
temperature_max null | string
temperature_max_value null | string
temperature_min null | string
temperature_min_value null | string
value string
value_formula string
show_in_popup string
unit_of_measurement string
on_tag_value null | string
off_tag_value null | string
on_type null | string
off_type null | string
calibrations null | array

driverpost

FieldTypeDescription
device_id requiredinteger
name requiredstring
rfid string
phone string
email string
description string

historyitem

FieldTypeDescription
status integer

1 - Drive, 2 - Stop, 3 - Start, 4 - Finish, 5 - Event

time string | null
show string
distance number | string
raw_time string
items array[
FieldTypeDescription
id integer | string
device_id integer | string
altitude number | string
course number | string
latitude number | string
longitude number | string
other string
power number | null
speed number
time string | null
server_time string
valid string
distance number
protocol string
sensor_id integer | string
sort integer
item_id string
raw_time string
lat number | string
lng number | string
other_arr array[string]
sensors_data array[
FieldTypeDescription
id string
value string | number
]
]
driver → driver

objectID

FieldTypeDescription
id requiredinteger

changeActive

FieldTypeDescription
id requiredinteger | array
active requiredstring

mapicon

FieldTypeDescription
id integer
path string
width number | string
height number | string

group

FieldTypeDescription
id integer
user_id integer
title string
open boolean

geofence

FieldTypeDescription
id integer
type string
user_id integer
group_id null | integer
active integer
name string
center → latlng
radius number | null
coordinates string | array
polygon_color string
created_at string
updated_at string

gprstemplatepost

FieldTypeDescription
title requiredstring
message requiredstring
protocol requiredstring

customeventpost

FieldTypeDescription
protocol requiredstring
message requiredstring
tag array[string]
type array[integer]
tag_value array[string]
show_always integer

devicepost

FieldTypeDescription
name requiredstring
imei requiredstring
icon_id integer
group_id integer
sim_number string
device_model string
plate_number string
vin string
registration_number string
object_owner string
fuel_measurement_id string
fuel_quantity number
fuel_price number
min_moving_speed number
min_fuel_fillings number
min_fuel_thefts number
tail_color string
tail_length integer

routepost

FieldTypeDescription
name requiredstring
color requiredstring
polyline requiredstring | array

driver

FieldTypeDescription
date integer | string
id integer | string
user_id integer | string
device_id integer | string
device_port null | string
name string
rfid string
phone string
email string
description string
created_at string
updated_at string
device → device

success

FieldTypeDescription
status integer

address

FieldTypeDescription
id string
place_id integer
lat string
lng string
address string
country string
country_code string
state string
city string
road string
house string
zip string
type string

reportType

FieldTypeDescription
type integer
name string
formats array[string]
fields array[string]
parameters any

task-status

FieldTypeDescription
id integer
task_id integer
comment string
status integer
created_at string
updated_at string

taskpost

FieldTypeDescription
device_id requiredinteger
title requiredstring
comment requiredstring
priority requiredinteger
status requiredinteger
pickup_address requiredstring
pickup_address_lat requirednumber
pickup_address_lng requirednumber
pickup_time_from requiredstring
pickup_time_to requiredstring
delivery_address requiredstring
delivery_address_lat requirednumber
delivery_address_lng requirednumber
delivery_time_from requiredstring
delivery_time_to requiredstring
invoice_number string

a

any
No endpoints match your filter.