Tracking Software
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
| Scheme | Type | Details |
|---|---|---|
| user_api_hash | apiKey | in: query, name: user_api_hash |
Address
Address
http://127.0.0.1/api/address
get-addressGeofence 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
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| lat required | number | Latitude |
| lng required | number | Longitude |
Responses
http://127.0.0.1/api/address/autocomplete
get-address-autocompleteGet autocompleted addresses list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| q required | string | Phrase to be sought for in addresses |
Responses
http://127.0.0.1/api/address/reverse
get-address-reverseResolve address from coordinate
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| lat required | number | Latitude |
| lng required | number | Longitude |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| location | → address |
http://127.0.0.1/api/address/search
get-address-searchGet address that is the best match for query
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| q required | string | Phrase to be sought for |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| location | → address |
Admin Companies
Admin Companies
http://127.0.0.1/api/admin/companies
get-admin-companiesGet companies list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | 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
| Field | Type | Description |
|---|---|---|
| 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 |
{
"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
}http://127.0.0.1/api/admin/companies
post-admin-companiesCreate company
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||
Responses
http://127.0.0.1/api/admin/companies/{id}
get-admin-companies-idGet company
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| var_number | string | |
| registration_code | string | |
| address | string | |
| comment | string | |
| created_at | string | |
| updated_at | string | |
| user_id | integer |
{
"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
}http://127.0.0.1/api/admin/companies/{id}
put-admin-companies-idUpdate company
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||
Responses
http://127.0.0.1/api/admin/companies/{id}
delete-admin-companies-idDelete company
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
Admin Devices
Admin Devices
http://127.0.0.1/api/admin/device/{device}
get-admin-device-deviceGet device
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device required | integer | Device ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| data | object |
{
"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
}
}http://127.0.0.1/api/admin/device/{device}/expiration
post-admindevice-device-expirationChange device expiration date
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device required | string | Device ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
http://127.0.0.1/api/admin/device/{device}/status
post-admin-device-device-statusChange device 'active' status
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device required | string | ID or IMEI |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
http://127.0.0.1/api/admin/device/{device}/user
post-device-device-userAssign user to device
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device required | string | ID or IMEI |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||
Responses
http://127.0.0.1/api/admin/device/{device}/user
delete-device-device-userRevoke user from device
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device required | string | ID or IMEI |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
http://127.0.0.1/api/admin/device/{device}/users
get-device-id-usersGet device users list
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device required | string | Device ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| limit | integer | Items per page |
Responses
| Field | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| status | integer | |||||||||||||
| data | array[
| |||||||||||||
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/admin/devices
get-admin-devicesGet devices list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | 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
| Field | Type | Description |
|---|---|---|
| status | integer | |
| data | array[→ device_lookup] | |
| pagination | → pagination_compact |
{
"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
http://127.0.0.1/api/admin/client
post-clientCreate client
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
{
"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
}
}http://127.0.0.1/api/admin/client
put-clientUpdate client
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
http://127.0.0.1/api/admin/client/status
post-admin-client-statusUpdate client 'active' status
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
http://127.0.0.1/api/admin/client/{id}
delete-admin-client-idDelete client
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
http://127.0.0.1/api/admin/client/{id}/devices
get-user-id-devicesGet user devices list
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| limit | integer | Items per page |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | integer | ||||||||||
| data | array[
| ||||||||||
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/admin/clients
get-admin-clientsGet clients list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | 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: |
| limit | integer | Items per page |
| sort_by | string | Column to sort by |
| sort | string | Sort direction |
Responses
| Field | Type | Description |
|---|---|---|
| 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 |
{
"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
}http://127.0.0.1/api/admin/clients
delete-admin-clientsDelete clients
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
http://127.0.0.1/api/admin/users/{id}/client
get-admin-users-id-clientGet user's client
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | User ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| data | object |
http://127.0.0.1/api/admin/users/{id}/client
post-admin-users-id-clientSet user's client
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | User ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| data | object |
Alert
Alert
http://127.0.0.1/api/add_alert
POST_add_alertDepending on type, also add attributes to the body. List of types and their attributes can be found at '/get_alerts_attributes'.
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_alert_data
GET_add_alert_dataGet data to create alert
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| devices | array[
| |||||||||||||||||||||||||||||||
| geofences | array[
| |||||||||||||||||||||||||||||||
| alert_zones | array[
| |||||||||||||||||||||||||||||||
| types | array[
| |||||||||||||||||||||||||||||||
| notifications | array[
| |||||||||||||||||||||||||||||||
| schedules | array[
|
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/change_active_alert
GET_change_active_alertChange active status for alerts
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||
Responses
Success
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_alert
GET_destroy_alertDelete alert
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| alert_id required | integer | Alert ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/devices/{device_id}/alerts
get-devices-device_id-alertsGet device alerts
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device_id required | integer | Device ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| data | array[
| |||||||||||||||||||
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/devices/{device_id}/alerts/{alert_id}/time_period
post-devices-device_id-alerts-alert_id-time_periodSet when alerts are active from or/and to
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device_id required | integer | Device ID |
| alert_id required | integer | Alert ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||
Responses
http://127.0.0.1/api/edit_alert
POST_edit_alertDepending on type, also add attributes to the body. List of types and their attributes can be found at '/get_alerts_attributes'.
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_alert_data
GET_edit_alert_dataGet data to edit alert
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| alert_id required | integer | Alert ID |
Responses
| Field | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item | → alert | |||||||||||||||||||||||||||||||
| devices | array[
| |||||||||||||||||||||||||||||||
| geofences | array[
| |||||||||||||||||||||||||||||||
| alert_zones | array[
| |||||||||||||||||||||||||||||||
| types | array[
| |||||||||||||||||||||||||||||||
| notifications | array[
| |||||||||||||||||||||||||||||||
| schedules | array[
|
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_alerts
GET_get_alertsGet alerts
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| items | object |
{
"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": []
}
]
}
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_alerts_attributes
get-get_alerts_attributesGet alert types with input fields
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| status | integer | |||||||||||||||||||||||||
| types | array[
|
http://127.0.0.1/api/get_alerts_commands
get-get_alerts_commandsGet alert commands
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
http://127.0.0.1/api/get_alerts_summary
get-get_alerts_summaryGet alerts summary
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
http://127.0.0.1/api/get_custom_events_by_device
GET_get_custom_events_by_deviceGet devices custom events
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| key | string | ||||||||||
| name | string | ||||||||||
| items | array[
|
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_events_by_protocol
get-get_events_by_protocolGet events by protocol
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| protocol required | string | Protocol |
| type required | integer | If type = 1, then user events are taken, otherwise - general |
Responses
| Field | Type | Description |
|---|---|---|
| 0 | object | |
| status | integer |
{
"0": {
"id": 0,
"value": {
"id": 2,
"value": "test",
"title": "test"
},
"title": {
"id": 2,
"value": "test",
"title": "test"
}
},
"status": 1
}http://127.0.0.1/api/get_protocols
GET_get_protocolsGet device protocols
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| 0 | object | |
| 1 | object | |
| status | integer |
{
"0": {
"id": 0,
"value": {
"type": 1,
"items": [
{
"id": "osmand",
"value": "osmand"
}
]
}
},
"1": {
"id": 1,
"value": {
"type": 2,
"items": []
}
},
"status": 1
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/set_alert_devices
GET_set_alert_devicesSet alert devices
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| alert_id required | integer | Alert ID |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Authentication
Authentication
http://127.0.0.1/api/login
POST_loginFollowing 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
| Name | Type | Description |
|---|---|---|
| email required | string | |
| password required | string | password |
| as | string | Other user's to login as, email |
Responses
| Field | Type | Description |
|---|---|---|
| status required | integer | |
| user_api_hash required | string |
{
"status": 1,
"user_api_hash": "$2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS"
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| message | string |
{
"status": 0,
"message": "Wrong credentials."
}http://127.0.0.1/api/password_reminder
get-password_reminderRetrieve code to email for password change
Request
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
| Field | Type | Description |
|---|---|---|
| success | integer |
{
"email": "test@test.com"
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| message | string |
{
"status": 0,
"message": "Wrong credentials."
}http://127.0.0.1/api/password_reminder
post-password_reminderChange password using provided code
Request
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| success | integer |
{
"email": "test@test.com"
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| message | string |
{
"status": 0,
"message": "Wrong credentials."
}http://127.0.0.1/api/register
get-registerRegister user
Request
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| message | string |
{
"email": "test@test.com"
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| message | string |
{
"status": 0,
"message": "Wrong credentials."
}Call Action
Call Action
http://127.0.0.1/api/call_actions
get-call_actionsGet call actions list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| data | array[→ call_action] | |
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/call_actions/destory/{id}
delete-call_actions-destory-idDelete call action item
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
http://127.0.0.1/api/call_actions/event_types
get-call_actions-event_typesGet call action event types
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | integer | ||||||||||
| types | array[
|
{
"status": 1,
"types": [
{
"type": "zone_in",
"title": "Zone in"
},
{
"type": "zone_out",
"title": "Zone out"
}
]
}http://127.0.0.1/api/call_actions/response_types
get-call_actions-response_typesGet call action response types
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | integer | ||||||||||
| types | array[
|
{
"status": 1,
"types": [
{
"type": "answer",
"title": "Answer"
},
{
"type": "no_answer",
"title": "No answer"
},
{
"type": "no_response",
"title": "No response"
}
]
}http://127.0.0.1/api/call_actions/store
post-call_actions-storeCreate call action item
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||
Responses
{
"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"
}http://127.0.0.1/api/call_actions/update/{id}
put-call_actions-update-idUpdate call action item
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||
Responses
http://127.0.0.1/api/call_actions/{id}
get-call_actions-idGet call action item
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
{
"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
http://127.0.0.1/api/get_device_commands
GET_get_device_commandsGet commands sent to device
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
Responses
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| type required | string | ||||||||||||||||||||||||||||||||||||||||
| title required | string | ||||||||||||||||||||||||||||||||||||||||
| connection | string |
| |||||||||||||||||||||||||||||||||||||||
| attributes | array[
|
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/send_command_data
GET_send_command_dataGet data to create GPRS/SMS command
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| devices_sms | array[object] | |||||||||||||
| devices_gprs | array[
| |||||||||||||
| sms_templates | array[
| |||||||||||||
| gprs_templates | array[
| |||||||||||||
| commands | array[
| |||||||||||||
| units | array[
| |||||||||||||
| number_index | array[
| |||||||||||||
| actions | array[
| |||||||||||||
| devices_protocols | object | |||||||||||||
| commands_all | object | |||||||||||||
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/send_gprs_command
POST_send_gprs_commandCreate GPRS command
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Form Data
| Name | Type | Description |
|---|---|---|
| device_id | integer | Device ID |
| type | string | type |
| message | string | message |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/send_sms_command
POST_send_sms_commandCreate SMS command
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Form Data
| Name | Type | Description |
|---|---|---|
| message required | string | message |
| devices required | array[integer] | devices |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/sent_commands
get-sent_commandsGet sent commands
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| sorting[sort_by] | string | Sort by column default: created_at |
| sorting[sort] | string | Sort direction default: DESC |
| includes | array[] | Relations to include. Available: |
| connection | string | Find items with exact |
| search | string | Value to search in items properties |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| data | array[
| ||||||||||||||||||||||||||||||||||||||||
| pagination | → pagination_compact |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Custom event
Custom event
http://127.0.0.1/api/add_custom_event
POST_add_custom_eventCreate custom event
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_custom_event_data
GET_add_custom_event_dataGet data to create custom event
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| protocols | array[
| ||||||||||
| types | array[
| ||||||||||
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_custom_event
GET_destroy_custom_eventDelete custom event
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| custom_event_id required | integer | Custom event ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_custom_event
POST_edit_custom_eventEdit custom event
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | any | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_custom_event_data
GET_edit_custom_event_dataGet data to edit custom event
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| custom_event_id required | integer | Custom event ID |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| item | object | ||||||||||
| protocols | array[
| ||||||||||
| types | array[
| ||||||||||
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_custom_events
GET_get_custom_eventsGet custom events
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| items | object | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Device
Device
http://127.0.0.1/api/add_device
GET_add_deviceCreate device
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_device_data
GET_add_device_dataData to create device
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| device_groups | array[
| |||||||||||||||||||||||||
| sensor_groups | array[
| |||||||||||||||||||||||||
| device_fuel_measurements | array[
| |||||||||||||||||||||||||
| device_icons | array[
| |||||||||||||||||||||||||
| users | array[→ user] | |||||||||||||||||||||||||
| timezones | array[
| |||||||||||||||||||||||||
| expiration_date_select | object | |||||||||||||||||||||||||
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/change_active_device
GET_change_active_deviceChange active status for devices
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_device
GET_destroy_deviceDelete device
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/devices_groups
get-devices_groupsGet device groups list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | 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
| Field | Type | Description |
|---|---|---|
| 0 | object | |
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/devices_groups/store
post-devices_groups-storeCreate device group
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
{
"status": 1,
"id": 5
}http://127.0.0.1/api/devices_groups/update/{id}
put-devices_groups-update-idUpdate device group
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
{
"status": 1,
"id": 5
}http://127.0.0.1/api/edit_device
GET_edit_deviceEdit device
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| device_id required | integer | Device ID |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_device_data
GET_edit_device_dataData to edit device
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
Responses
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| device_groups | array[
| |||||||||||||||||||||||||
| sensor_groups | array[
| |||||||||||||||||||||||||
| device_fuel_measurements | array[
| |||||||||||||||||||||||||
| device_icons | array[
| |||||||||||||||||||||||||
| users | array[→ user] | |||||||||||||||||||||||||
| timezones | array[
| |||||||||||||||||||||||||
| expiration_date_select | object | |||||||||||||||||||||||||
| engine_hours | array[
| |||||||||||||||||||||||||
| detect_engine | array[
| |||||||||||||||||||||||||
| sensors | any | |||||||||||||||||||||||||
| services | any | |||||||||||||||||||||||||
| item | → device | |||||||||||||||||||||||||
| status | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_devices
GET_get_devicesGet devices
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | 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 |
| imei | string | Find items with exact |
| sim_number | string | Find items with exact |
| msisdn | string | Find items with exact |
| vin | string | Find items with exact |
| plate_number | string | Find items with exact |
| registration_number | string | Find items with exact |
| object_owner | string | Find items with exact |
| device_model | string | Find items with exact |
| group_id | string | Find items with exact |
| status | array[string] | Find items with exact |
| online | string | Find items which status is |
| offline | string | Find items which status is |
Responses
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| title | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| items | array[
|
[
{
"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"
}
}
]
}
]| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_devices_latest
GET_get_devices_latestReturn only devices whose information has changed, all the response returns "time", the time needed to transmit the next request.
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| time | string | Filter items that were updated since provided UNIX timestamp default: 5 seconds ago |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| filters[id] | integer | Find items with exact |
| filters[imei] | string | Find items with exact |
| filters[sim_number] | string | Find items with exact |
| filters[msisdn] | string | Find items with exact |
| filters[vin] | string | Find items with exact |
| filters[plate_number] | string | Find items with exact |
| filters[registration_number] | string | Find items with exact |
| filters[object_owner] | string | Find items with exact |
| filters[device_model] | string | Find items with exact |
| filters[group_id] | integer | Find items with exact |
| filters[status] | array[string] | Find items with exact |
| filters[online] | string | Find items which status is |
| filters[offline] | string | Find items which status is |
Responses
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array[
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| events | array[any] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| time | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| version | string |
{
"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"
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Device Media
Device Media
http://127.0.0.1/api/devices/{device_id}/media
get-devices-device_id-mediaGet device media
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device_id required | string | Device ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| data | array[any] | |
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/devices/{device_id}/media/file/{filename}
get-devices-device_id-media-file-filenameDownload device media image
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device_id required | integer | Device ID |
| filename required | string | File hash code |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
Image content
http://127.0.0.1/api/devices/{device_id}/media/file/{filename}
delete-devices-device_id-media-file-filenameDelete device media image
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device_id required | integer | Device ID |
| filename required | string | File hash code |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| delete_count | integer |
{
"status": 1,
"delete_count": 1
}http://127.0.0.1/api/devices/{id}/image
get-devices-id-imageDownload device image
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | string | Device ID |
Responses
Image content
Driver
Driver
http://127.0.0.1/api/add_user_driver
POST_add_user_driverCreate user driver
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| item | object |
{
"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
}
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_user_driver_data
GET_add_user_driver_dataGet data to create user driver
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| devices | object | |
| status | integer |
{
"devices": {
"3": "Device name"
},
"status": 1
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_user_driver
GET_destroy_user_driverDelete user driver
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| user_driver_id required | integer | User driver ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_user_driver
POST_edit_user_driverEdit user driver
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_user_driver_data
GET_edit_user_driver_dataGet data to edit user driver
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| user_driver_id required | integer | User driver ID |
Responses
| Field | Type | Description |
|---|---|---|
| item | any | |
| devices | object | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_user_drivers
GET_get_user_driversGet user drivers
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| items | object | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Event
Event
http://127.0.0.1/api/destroy_events
GET_destroy_eventsIstrina visus userio eventus.
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_events
GET_get_eventsGet events
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| 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 required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| items | object |
{
"status": 1,
"items": {
"total": 1,
"per_page": 30,
"current_page": 1,
"last_page": 1,
"from": 1,
"to": 1,
"data": [
{}
],
"url": "/api/get_events"
}
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
FCM
FCM
http://127.0.0.1/api/fcm_token
post-fcm_tokenAssign FCM token to current user
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||
Responses
Geofence
Geofence
http://127.0.0.1/api/add_geofence
POST_add_geofence"polygon" first and last coordinate must be the same as it closes Polygone.
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||||||||||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/change_active_geofence
GET_change_active_geofenceChange active status for geofences
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_geofence
GET_destroy_geofenceDelete geofence
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| geofence_id required | integer | Geofence ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_geofence
POST_edit_geofence"polygon" first and last coordinate must be the same as it closes Polygone.
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||||||||||||||||||||||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/geofences_groups
get-geofences_groupsGet geofence groups list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | 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
| Field | Type | Description |
|---|---|---|
| 0 | object | |
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/geofences_groups/store
post-geofences_groups-storeCreate geofence group
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
{
"status": 1,
"id": 5
}http://127.0.0.1/api/geofences_groups/update/{id}
put-geofences_groups-update-idUpdate geofence group
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
{
"status": 1,
"id": 5
}http://127.0.0.1/api/get_geofences
GET_get_geofencesGet geofences
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/point_in_geofences
get-point_in_geofencesGet names of geofences the point is in
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lat required | number | Latitude |
| lng required | number | Longitude |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| zones | array[string] |
{
"status": 1,
"zones": [
"Geofence 1",
"Geofence 2"
]
}GPRS Template
GPRS Template
http://127.0.0.1/api/add_user_gprs_template
POST_add_user_gprs_templateCreate user GPRS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| item | → gprstemplate |
{
"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"
}
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_user_gprs_template_data
GET_add_user_gprs_template_dataGet data to create user GPRS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| protocols | array[
|
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_user_gprs_template
GET_destroy_user_gprs_templateDelete user GPRS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| user_gprs_template_id required | integer | User GPRS template ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_user_gprs_template
POST_edit_user_gprs_templateEdit user GPRS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
{
"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"
}
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_user_gprs_template_data
GET_edit_user_gprs_template_dataGet data to edit user GPRS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| user_gprs_template_id required | integer | User GPRS template ID |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| item | → gprstemplate | ||||||||||
| protocols | array[
| ||||||||||
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_user_gprs_message
GET_get_user_gprs_messageGet user GPRS templates
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| user_gprs_template_id required | integer | User GPRS template ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| message | string |
{
"status": 1,
"message": "message content"
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_user_gprs_templates
GET_get_user_gprs_templatesGet user GPRS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| items | object | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
History
History
http://127.0.0.1/api/delete_history_positions
POST_delete_history_positionsDelete device positions
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| device_id required | integer | Device ID |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_history
GET_get_historyGet device history
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| snap_to_road | boolean | Align GPS point to the nearest point on a road network |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
| from_date required | string | Date from |
| from_time required | string | Time from |
| to_date required | string | Date to |
| to_time required | string | Time to |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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[
| ||||||||||
| images | array[
| ||||||||||
| sensors_values | array[object] | ||||||||||
| fuel_consumption_arr | array[object] | ||||||||||
| status | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_history_messages
GET_get_history_messagesGet device history paginated
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
| from_date required | string | Date from |
| from_time required | string | Time from |
| to_date required | string | Date to |
| to_time required | string | Time to |
| page | integer | Page number |
| limit | integer | Limit of items in page |
Responses
| Field | Type | Description |
|---|---|---|
| messages | object | |
| sensors | array[→ sensor] | |
| pagination_limits | object | |
| limit | integer | |
| sorting | string | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Map icon
Map icon
http://127.0.0.1/api/add_map_icon
POST_add_map_iconCreate map icon
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | → mapiconpost | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/change_active_map_icon
GET_change_active_map_iconChange active status for map icon
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_map_icon
GET_destroy_map_iconDelete map icon
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| map_icon_id required | integer | Map icon ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_map_icon
POST_edit_map_iconUpdate map icon
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | any | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_map_icons
GET_get_map_iconsGet map icons
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| items | array[→ mapicon] | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_user_map_icons
GET_get_user_map_iconsGet user map icons
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| s | string | Value to search in items properties |
Responses
| Field | Type | Description |
|---|---|---|
| items | object | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/pois_groups
get-pois_groupsGet map icon groups list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | 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
| Field | Type | Description |
|---|---|---|
| 0 | object | |
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/pois_groups/store
post-pois_groups-storeCreate map icon group
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
{
"status": 1,
"id": 5
}http://127.0.0.1/api/pois_groups/update/{id}
put-pois_groups-update-idUpdate map icon group
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
{
"status": 1,
"id": 5
}Report
Report
http://127.0.0.1/api/add_report
POST_add_reportCreate report
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | any | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_report_data
GET_add_report_dataGet data to create report
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| devices | array[→ device] | ||||||||||
| geofences | array[→ geofence] | ||||||||||
| formats | array[
| ||||||||||
| stops | array[
| ||||||||||
| filters | array[
| ||||||||||
| types | array[
| ||||||||||
| reports | any | ||||||||||
| logs | object | ||||||||||
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_report
GET_destroy_reportDelete report
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| report_id required | integer | Report ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_report
POST_edit_reportEdit report
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | any | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/generate_report
POST_generate_reportIf the request is successfully returned { 'status': 3 'url': ###}. "url" is link to generated report file
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | any | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| url | string |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_reports
GET_get_reportsGet reports
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| items | object |
{
"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"
}
]
}
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_reports_types
GET_get_reports_typesGet report types
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| items | array[→ reportType] | |
| status | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Route
Route
http://127.0.0.1/api/add_route
POST_add_routeCreate route
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/change_active_route
GET_change_active_routeChange active status for routes
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| ||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_route
GET_destroy_routeDelete route
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| route_id required | integer | Route ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_route
POST_edit_routeEdit route
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_routes
GET_get_routesGet routes
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| data | array[
| |||||||||||||||||||||||||||||||
| pagination | → pagination_compact |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/routes_groups
get-routes_groupsGet route groups list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | 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
| Field | Type | Description |
|---|---|---|
| 0 | object | |
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/routes_groups/store
post-routes_groups-storeCreate route group
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
{
"status": 1,
"id": 5
}http://127.0.0.1/api/routes_groups/update/{id}
put-routes_groups-update-idUpdate route group
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| id | integer |
{
"status": 1,
"id": 5
}Sensor
Sensor
http://127.0.0.1/api/add_sensor
POST_add_sensorThe fields depends on the sensor type, which can see the web version.
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | → sensorpost | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_sensor_data
GET_add_sensor_dataGet data to create device sensor
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
Responses
| Field | Type | Description |
|---|---|---|
| sensors | → sensors | |
| device_id | integer | |
| route | string | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_sensor
GET_destroy_sensorDelete device sensor
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| sensor_id required | integer | Device sensor ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_sensor
POST_edit_sensorEdit device sensor
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| sensor_id required | integer | Device sensor ID |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | → sensorpost | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_sensor_data
GET_edit_sensor_dataGet data to edit device sensor
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| sensor_id required | integer | Device sensor ID |
Responses
| Field | Type | Description |
|---|---|---|
| sensors | → sensors | |
| device_id | string | integer | |
| item | → sensor | |
| route | string | |
| status | string | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_sensors
get-get_sensorsGet device sensors
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
Responses
| Field | Type | Description |
|---|---|---|
| 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 |
{
"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": "« Previous",
"active": false
},
{
"url": "/api/get_sensors?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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
http://127.0.0.1/api/add_service
POST_add_serviceCreate device service
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_service_data
GET_add_service_dataGet data to create device service
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
Responses
| Field | Type | Description |
|---|---|---|
| device_id | integer | |
| odometer_value | string | |
| engine_hours_value | string | |
| expiration_by | → servicetypes | |
| status | integer |
{
"device_id": 1,
"odometer_value": "0",
"engine_hours_value": "0",
"expiration_by": {
"odometer": "Odometer",
"engine_hours": "Engine hours",
"days": "Days"
},
"status": 1
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_service
GET_destroy_serviceDelete device service
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| service_id required | integer | Device service ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_service
POST_edit_serviceEdit device service
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | any | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_service_data
GET_edit_service_dataGet data to edit device service
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| service_id required | integer | Device service ID |
Responses
| Field | Type | Description |
|---|---|---|
| device_id | integer | |
| odometer_value | string | |
| engine_hours_value | string | |
| expiration_by | → servicetypes | |
| item | → service | |
| status | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_services
get-get_servicesGet device services
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| device_id required | integer | Device ID |
Responses
| Field | Type | Description |
|---|---|---|
| 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 |
{
"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": "« Previous",
"active": false
},
{
"url": "/api/get_services?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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
http://127.0.0.1/api/change_password
POST_change_passwordChange password
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
Success
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_setup
POST_edit_setupEdit account settings
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_setup_data
GET_edit_setup_dataGet data to edit account settings
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| item | object | ||||||||||
| timezones | array[
| ||||||||||
| units_of_distance | array[
| ||||||||||
| units_of_capacity | array[
| ||||||||||
| units_of_altitude | array[
| ||||||||||
| groups | array[object] | ||||||||||
| sms_queue_count | integer | ||||||||||
| request_method_select | array[
| ||||||||||
| encoding_select | array[
| ||||||||||
| authentication_select | array[
| ||||||||||
| dst_types | array[
| ||||||||||
| user_dst | null | ||||||||||
| months | array[
| ||||||||||
| weekdays | object | ||||||||||
| week_pos | object | ||||||||||
| dst_countries | array[
| ||||||||||
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_user_data
GET_get_user_dataGet data to create user
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| string | ||
| expiration_date | null | string | |
| days_left | null | integer | |
| plan | string | |
| devices_limit | integer | |
| group_id | integer |
{
"email": "admin@yourdomain.com",
"expiration_date": null,
"days_left": null,
"plan": "Demo",
"devices_limit": 0
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Sharing
Sharing
http://127.0.0.1/api/sharing
get-sharingGet sharing list
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| data | array[→ sharing] | |
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/sharing
post-sharingCreate sharing
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||||||||
Responses
{
"id": 1,
"user_id": 1,
"name": "share",
"hash": "hash",
"expiration_date": "2124-03-01 00:00:00",
"active": 0,
"delete_after_expiration": 0
}http://127.0.0.1/api/sharing/{id}
get-sharing-idGET sharing item
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
{
"id": 1,
"user_id": 1,
"name": "share",
"hash": "hash",
"expiration_date": "2124-03-01 00:00:00",
"active": 0,
"delete_after_expiration": 0
}http://127.0.0.1/api/sharing/{id}
put-sharing-idUpdate sharing item
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||
Responses
{
"id": 1,
"user_id": 1,
"name": "share",
"hash": "hash",
"expiration_date": "2124-03-01 00:00:00",
"active": 0,
"delete_after_expiration": 0
}http://127.0.0.1/api/sharing/{id}
delete-sharing-idDelete sharing item
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
http://127.0.0.1/api/sharing/{id}/devices
put-sharing-id-devicesUpdate sharing item devices
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
{
"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
http://127.0.0.1/api/add_user_sms_template
POST_add_user_sms_templateCreate user SMS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| item | → smstemplate |
{
"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"
}
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/add_user_sms_template_data
GET_add_user_sms_template_dataGet data to create user SMS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_user_sms_template
GET_destroy_user_sms_templateDelete user SMS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| user_sms_template_id required | integer | User SMS template ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_user_sms_template
POST_edit_user_sms_templateEdit user SMS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
{
"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"
}
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_user_sms_template_data
GET_edit_user_sms_template_dataGet data to edit user SMS template
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| user_sms_template_id required | integer | User SMS template ID |
Responses
| Field | Type | Description |
|---|---|---|
| item | → smstemplate | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_user_sms_message
GET_get_user_sms_messageGet user SMS templates
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
| user_sms_template_id required | integer | User SMS template ID |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| message | string |
{
"status": 1,
"message": "message content"
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_user_sms_templates
GET_get_user_sms_templatesGet user SMS templates
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| items | object | |
| status | integer |
{
"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
}| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
Task
Task
http://127.0.0.1/api/add_task
POST_add_taskCreate task
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description |
|---|---|---|
| body | → taskpost | |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| item | → task |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/destroy_task
POST_destroy_taskDelete task
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| body |
| |||||||
Responses
| Field | Type | Description |
|---|---|---|
| status | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/edit_task/{id}
POST_edit_task-idEdit task
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_task/{id}
GET_get_task-idGet task
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| item | → task |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_task_signature/{taskStatusId}
GET_get_task_signature-taskStatusIdGet task signature
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| taskStatusId required | string | Task status ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
Success
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_tasks
GET_get_tasksGet tasks
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| 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 required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| status | integer | |
| items | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_tasks_priorities
GET_get_tasks_prioritiesGet task priorities
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | integer | ||||||||||
| items | array[
|
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
http://127.0.0.1/api/get_tasks_statuses
GET_get_tasks_statusesGet task statuses
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | integer | ||||||||||
| items | array[
|
| Field | Type | Description |
|---|---|---|
| status | integer | |
| errors | object |
| Field | Type | Description |
|---|---|---|
| status | integer | |
| error | string |
User
User
http://127.0.0.1/api/admin/device/{device}/users
get-device-id-usersGet device users list
Request
Path Parameters
| Name | Type | Description |
|---|---|---|
| device required | string | Device ID |
Query Parameters
| Name | Type | Description |
|---|---|---|
| limit | integer | Items per page |
Responses
| Field | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| status | integer | |||||||||||||
| data | array[
| |||||||||||||
| pagination | → pagination_compact |
{
"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
}
}http://127.0.0.1/api/user_client
get-user_clientGet current user's client
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Responses
| Field | Type | Description |
|---|---|---|
| data | object |
http://127.0.0.1/api/user_client
post-user_clientSet current user's client
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| lang required | string | Lang default: en |
| user_api_hash required | string | User API hash default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS |
Request Body
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||
Responses
| Field | Type | Description |
|---|---|---|
| data | object |
Welcome
Welcome
http://127.0.0.1/api/insert.php
GET_insert-phphttp://[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
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| body |
| |||||||||||||||||||||||||||||||||||||||||||
Responses
http://127.0.0.1/api/insert.php2
GET_insert-php2http://[YOUR_URL]/insert.php
Request
Query Parameters
| Name | Type | Description |
|---|---|---|
| uniqueId required | string | Device IMEI |
| protocol required | string | Device protocol |
| altitude required | string | Current device altitude in meters |
| course required | string | Current device angle from 0 to 360 |
| latitude required | string | Current device latitude |
| longitude required | string | Current device longitude |
| speed required | string | Current device speed in knot unit (https://en.wikipedia.org/wiki/Knot_(unit)) |
| fixTime required | string | Current device time in timestamp with miliseconds |
| attributes required | array[string] | Key-value array (e.g., attributes[attr1]=value1&attributes[attrN]=valueN) |
Schemas / Models
task
| Field | Type | Description |
|---|---|---|
| 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
| Field | Type | Description |
|---|---|---|
| name required | string | |
| polygon_color required | string | |
| polygon required | array[→ latlng] | |
| group_id | integer | |
| type required | string | |
| center | → latlng2 | |
| radius | number |
device
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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[
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| services | array[
|
mapiconpost
| Field | Type | Description |
|---|---|---|
| name required | string | |
| description | string | |
| map_icon_id required | integer | |
| coordinates required | → latlng |
event
| Field | Type | Description |
|---|---|---|
| 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
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | integer | |||||||||||||||||||||||||
| user_id | integer | |||||||||||||||||||||||||
| active | integer | |||||||||||||||||||||||||
| name | string | |||||||||||||||||||||||||
| type | string | |||||||||||||||||||||||||
| overspeed | integer | For | ||||||||||||||||||||||||
| time_duration | integer | For | ||||||||||||||||||||||||
| stop_duration | integer | For | ||||||||||||||||||||||||
| offline_duration | integer | For | ||||||||||||||||||||||||
| move_duration | integer | For | ||||||||||||||||||||||||
| min_parking_duration | integer | For | ||||||||||||||||||||||||
| idle_duration | integer | For | ||||||||||||||||||||||||
| ignition_duration | integer | For | ||||||||||||||||||||||||
| state | integer | For | ||||||||||||||||||||||||
| authorized | boolean | For | ||||||||||||||||||||||||
| continuous_duration | integer | For | ||||||||||||||||||||||||
| distance | integer | For | ||||||||||||||||||||||||
| period | integer | For | ||||||||||||||||||||||||
| distance_tolerance | integer | For | ||||||||||||||||||||||||
| task_status | array[integer] | For | ||||||||||||||||||||||||
| 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[
| |||||||||||||||||||||||||
| notifications | object | |||||||||||||||||||||||||
| command | object | null |
smstemplatepost
| Field | Type | Description |
|---|---|---|
| title | string | |
| message | string |
smstemplate
| Field | Type | Description |
|---|---|---|
| id | integer | |
| user_id | integer | |
| title | string | |
| message | string | |
| updated_at | string | |
| created_at | string |
servicetypes
| Field | Type | Description |
|---|---|---|
| key | string |
report
| Field | Type | Description |
|---|---|---|
| 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 | |
| string | ||
| weekly_email_sent | string | |
| daily_email_sent | string | |
| devices | array[integer] | |
| geofences | array[integer] |
sensorpost
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| device_id required | integer | |||||||
| sensor_type required | string | |||||||
| sensor_name required | string | |||||||
| unit_of_measurement required | string | |||||||
| 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[
| |||||||
| on_value | string | |||||||
| off_value | string |
latlng
| Field | Type | Description |
|---|---|---|
| lat | number | |
| lng | number |
latlng2
| Field | Type | Description |
|---|---|---|
| lat | number | |
| lng | number |
pagination
| Field | Type | Description |
|---|---|---|
| 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
| Field | Type | Description |
|---|---|---|
| total | integer | |
| per_page | integer | |
| current_page | integer | |
| last_page | integer | |
| next_page_url | string | null | |
| prev_page_url | string | null | |
| url | string |
sharing
| Field | Type | Description |
|---|---|---|
| id | integer | |
| user_id | integer | |
| name | string | |
| hash | string | |
| expiration_date | string | |
| active | integer | |
| delete_after_expiration | integer |
call_action
| Field | Type | Description |
|---|---|---|
| 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
| Field | Type | Description |
|---|---|---|
| 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
objectreportpost
| Field | Type | Description |
|---|---|---|
| title required | string | |
| type required | integer | |
| format required | string | |
| speed_limit | number | |
| devices required | array[integer] | |
| geofences | array[integer] | |
| daily | integer | |
| weekly | integer | |
| send_to_email | string | |
| date_from required | string | |
| date_to required | string | |
| from_time | string | |
| to_time | string | |
| show_addresses | boolean | |
| zones_instead | boolean | |
| stops | integer |
sensors
| Field | Type | Description |
|---|---|---|
| key | string |
gprstemplate
| Field | Type | Description |
|---|---|---|
| id | integer | |
| user_id | integer | |
| title | string | |
| message | string | |
| protocol | string | |
| updated_at | string | |
| created_at | string |
alertpost
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name required | string | |||||||||||||||||||||||||
| type required | string | |||||||||||||||||||||||||
| devices required | array[integer] | |||||||||||||||||||||||||
| zone | integer | |||||||||||||||||||||||||
| zones | array[integer] | |||||||||||||||||||||||||
| schedule | boolean | |||||||||||||||||||||||||
| schedules | array[
| |||||||||||||||||||||||||
| notifications | object | |||||||||||||||||||||||||
| command | object |
service
| Field | Type | Description |
|---|---|---|
| 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 | |
| string | ||
| mobile_phone | string | |
| device | → device |
servicepost
| Field | Type | Description |
|---|---|---|
| device_id required | integer | |
| name required | string | |
| expiration_by required | string | |
| interval required | string | |
| last_service required | string | |
| trigger_event_left required | string | |
| renew_after_expiration required | integer | |
| string | ||
| mobile_phone | string |
sensor
| Field | Type | Description |
|---|---|---|
| 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
| Field | Type | Description |
|---|---|---|
| device_id required | integer | |
| name required | string | |
| rfid | string | |
| phone | string | |
| string | ||
| description | string |
historyitem
| Field | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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[
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| driver | → driver |
objectID
| Field | Type | Description |
|---|---|---|
| id required | integer |
changeActive
| Field | Type | Description |
|---|---|---|
| id required | integer | array | |
| active required | string |
mapicon
| Field | Type | Description |
|---|---|---|
| id | integer | |
| path | string | |
| width | number | string | |
| height | number | string |
group
| Field | Type | Description |
|---|---|---|
| id | integer | |
| user_id | integer | |
| title | string | |
| open | boolean |
geofence
| Field | Type | Description |
|---|---|---|
| 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
| Field | Type | Description |
|---|---|---|
| title required | string | |
| message required | string | |
| protocol required | string |
customeventpost
| Field | Type | Description |
|---|---|---|
| protocol required | string | |
| message required | string | |
| tag | array[string] | |
| type | array[integer] | |
| tag_value | array[string] | |
| show_always | integer |
devicepost
| Field | Type | Description |
|---|---|---|
| name required | string | |
| imei required | string | |
| 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
| Field | Type | Description |
|---|---|---|
| name required | string | |
| color required | string | |
| polyline required | string | array |
driver
| Field | Type | Description |
|---|---|---|
| date | integer | string | |
| id | integer | string | |
| user_id | integer | string | |
| device_id | integer | string | |
| device_port | null | string | |
| name | string | |
| rfid | string | |
| phone | string | |
| string | ||
| description | string | |
| created_at | string | |
| updated_at | string | |
| device | → device |
success
| Field | Type | Description |
|---|---|---|
| status | integer |
address
| Field | Type | Description |
|---|---|---|
| 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
| Field | Type | Description |
|---|---|---|
| type | integer | |
| name | string | |
| formats | array[string] | |
| fields | array[string] | |
| parameters | any |
task-status
| Field | Type | Description |
|---|---|---|
| id | integer | |
| task_id | integer | |
| comment | string | |
| status | integer | |
| created_at | string | |
| updated_at | string |
taskpost
| Field | Type | Description |
|---|---|---|
| device_id required | integer | |
| title required | string | |
| comment required | string | |
| priority required | integer | |
| status required | integer | |
| pickup_address required | string | |
| pickup_address_lat required | number | |
| pickup_address_lng required | number | |
| pickup_time_from required | string | |
| pickup_time_to required | string | |
| delivery_address required | string | |
| delivery_address_lat required | number | |
| delivery_address_lng required | number | |
| delivery_time_from required | string | |
| delivery_time_to required | string | |
| invoice_number | string |