unit/list.json?key=yourapikey means that full request URL will be: https://mapon.com/api/v1/unit/list.json?key=yourapikey
Base URL for every HTTP request is:
https://mapon.com/api/v1/
API is defined by classes and actions. For example, there are unit class which can have multiple
actions. For example, list action which returns car list with current location and other data. URL for
such request would look like this:
https://mapon.com/api/v1/unit/list.json?key=yourapikey
list is default action for every class, so this means you can also make this request by omitting the
/list part:
https://mapon.com/api/v1/unit.json?key=yourapikey
Some actions can take arrays as input parameters. For example, unit/list input parameter unit_id
has type "int or int array". This means you can either pass single value:
https://mapon.com/api/v1/unit/list.json?key=yourapikey&unit_id=14700
Or you can pass multiple values by adding [] to parameter names:
https://mapon.com/api/v1/unit/list.json?key=yourapikey&unit_id[]=14700&unit_id[]=14701
Authentication is done by using API Key. API Keys are managed by company administrators.
API Key can be with unlimited access rights to units and/or actions, but it’s also possible to authorize individual API Key to use just limited list of units and/or actions.
To authenticate, API Key is passed to each HTTP GET request as query parameter key or for a HTTP POST request as form field parameter key.
In practice the HTTP request will look similar to this:
https://mapon.com/api/v1/unit.json?key=yourapikey
You can also add the API Key to the request header, by setting header key value
HTTP GET method - all parameters must be added to the url query string, for example:
https://mapon.com/api/v1/unit/list.json?key=yourapikey&unit_id[]=14700&unit_id[]=14701
HTTP POST or HTTP DELETE method - parameters must be sent in the request body. Supported content types are: Urlencoded string, JSON
By default, we treat the request payload as urlencoded string (as if the Content-Type header was set to application/x-www-form-urlencoded or multipart/form-data
If you wish to pass request payload as JSON, then you MUST set the Content-Type header as application/json
Please note that passing request payload as JSON ia only currently supported for POST and DELETE requests
Response format is defined by appending format name to the action. For example, to return results in JSON, append ".json" to the action:
https://mapon.com/api/v1/unit/list.json?key=yourapikey
Currently API supports responses formatted as JSON or XML.
Currently we allow 5 concurrent requests.
If request fails, validation is not passed or any other error occurs, the response will contain following data:
{
"error": {
"code": 1004,
"msg": "Missing API key"
}
}
Error codes equal and larger than #1000 are API wide (global) errors.
Error codes starting from #1 to #999 are action specific errors. This means that for example error code #1 for action
unit/list can mean something else than for action route/list. Action specific error codes
are listed to each corresponding action description.
| Code | Description |
|---|---|
| 1000 | Unknown error |
| 1001 | Server error |
| 1002 | Invalid request |
| 1003 | Invalid format |
| 1004 | Missing API key |
| 1005 | API key not found |
| 1006 | Method not available |
| 1007 | Method is not yet implemented |
| 1008 | API key does not have any associated units |
| 1009 | Use SSL for requests |
| 1010 | Error sending command to device |
| 1011 | Request limit reached |
| 1012 | Company suspended |
| 1013 | Endpoint needs "unlimited" api key access |
| 1014 | Invalid JSON data payload |
| 1015 | Endpoint needs a paid add-on feature |
To ease working with API there is a simple PHP wrapper library for making API calls.
You can download it there: https://github.com/mapon-com/client-api-php-sdk
GET https://mapon.com/api/v1/alert/list.jsonUTC datetime string in Y-m-dTH:i:sZ formatUTC datetime string in Y-m-dTH:i:sZ formatid - alert idlocation - coordinates of the locationaddress - address of the locationdriver - driver idname - name of the driversurname - surname of the driver[1; 150], default = 20)1)UTC timezone.{
"data": [
{
"unit_id": 1,
"time": "2021-08-02T01:10:17Z",
"alert_type": "supply_voltage",
"alert_val": "9.865|battery_voltage",
"msg": "Supply voltage 9.865 (Internal battery). ",
"id": 123,
"location": "12.12345,12.12345",
"address": "xxxxx"
}
],
"_meta": {
"total": 22,
"total_pages": 4,
"per_page": 7,
"page": 4
}
}| Code | Description |
|---|---|
| 1 | Invalid user |
| 2 | Invalid parameter from |
| 3 | Invalid parameter till |
| 4 | Invalid period |
| 5 | Invalid period days |
| 6 | Invalid period length (max 31d) |
| 7 | Invalid parameter limit |
| 8 | Invalid parameter page |
| 9 | Invalid parameter include |
| 10 | Invalid parameter unit_id |
| 11 | Invalid parameter alert_type |
| 12 | Invalid parameter driver |
GET https://mapon.com/api/v1/alert/setup_types.jsondata.groups.group_namedata.groups.alert_types.titledata.groups.alert_types.description{
"groups": [
{
"group_id": "objects",
"group_name": "Object alerts",
"alert_types": [
{
"type": "in_object",
"title": "Arrives\/leaves the object",
"description": "You will be announced when vehicle arrives at the object!"
}
]
},
{
"group_id": "technical",
"group_name": "Technical alerts",
"alert_types": [
{
"type": "no_power",
"title": "Power off",
"description": "You will be announced, if equipment has been disconnected!"
},
{
"type": "supply_voltage",
"title": "Supply voltage alert",
"description": "We will alert when voltage will be lower then set "
},
{
"type": "battery_level",
"title": "Battery level",
"description": "We will alert when battery level will be lower then set "
}
]
},
{
"group_id": "moving",
"group_name": "Driving alerts",
"alert_types": [
{
"type": "speeding",
"title": "Overspeeding",
"description": "You will be announced if vehicle overspeeds!"
},
{
"type": "moving",
"title": "Vehicle started movement",
"description": "Vehicle started movement"
}
]
},
{
"group_id": "other",
"group_name": "Other alerts",
"alert_types": [
{
"type": "sosbutton",
"title": "SOS Button",
"description": "Notification will be sent every time your SOS button is triggered."
}
]
}
]
}| Code | Description |
|---|---|
| 1 | Invalid user |
GET https://mapon.com/api/v1/alert/setup_fields.jsonsetup_types endpointfields array of field objects, grouped by field_groupfield_groups List of available field groups for the selected alert typefields properties:type* - string. Indicates field type. Possible values: select, date, phone, email, checkbox, text, numeric, integertitle* - string. Localized field name.field* - string. Field key. Required to use the exact same field when passing values to alert setup storage endpoint. Alert setup list endpoint uses the same field keys to specify field valuesfield_group* - string. Field group key. Related fields are grouped together with the same field_group keydescription - string. Localized field description. Included only if existsrequired - bool. If true field is mandatory. Present for all field types, except checkboxrequired_if - string. Value format: field:value. Indicates that the field will be treated as required if another field has a specific value.multiple - bool. Indicates if field can have multiple values. Always included with select field type. For other field types it is included only when true - the field accepts multiple valuesoptions - array. List of accepted field values. Only included with select field type. Each option has title and value propertiesrange - array. Allowed (inclusive) range of values. Only included with numeric or integer field types . Format: [X,Y]{
"fields": {
"other": [
{
"type": "text",
"title": "Additional reminder text",
"required": true,
"field": "alert_text"
}
],
"objects": [
{
"field": "object_visits",
"field_group": "objects",
"title": "Arrives\/leaves the object",
"type": "select",
"multiple": true,
"required": true,
"options": [
{
"value": "object_visit",
"title": "Arrives at the object"
},
{
"value": "object_leave",
"title": "Leaves the object!"
}
]
},
{
"field": "object_type",
"field_group": "objects",
"title": "Objects",
"type": "select",
"multiple": false,
"required": true,
"options": [
{
"title": "All objects",
"value": "all_objects"
},
{
"title": "Objects",
"value": "objects"
},
{
"title": "Object groups",
"value": "object_groups"
}
]
},
{
"field": "objects",
"field_group": "objects",
"title": "Objects",
"type": "select",
"multiple": true,
"required": true,
"options": {
"631312": {
"title": "A4 Gorlitz",
"value": 631312
},
"631336": {
"title": "56000 Vannes",
"value": 631336
},
"668462": {
"title": "Leaflet",
"value": 668462
},
"678063": {
"title": "THIAROYE 13+450",
"value": 678063
},
"743134": {
"title": "2 As Oy Alakartanontie 17",
"value": 743134
},
"808312": {
"title": "Malgrat parking",
"value": 808312
},
"943377": {
"title": "\ufeffMULTIVEND SERVICES LIMITED",
"value": 943377
},
"943379": {
"title": "SAVEWISE SUPERMARKET",
"value": 943379
}
}
},
{
"field": "object_groups",
"field_group": "objects",
"title": "Object groups",
"type": "select",
"multiple": true,
"required": true,
"options": [
{
"title": "Alerts",
"value": 24158
},
{
"title": "GRP 2",
"value": 19850
},
{
"title": "as24fuel",
"value": 22049
}
]
}
],
"vehicles": [
{
"field": "car_type",
"field_group": "vehicles",
"title": "Vehicles",
"type": "select",
"multiple": false,
"required": true,
"options": [
{
"value": "all_cars",
"title": "All vehicles"
},
{
"value": "cars",
"title": "Vehicles"
},
{
"value": "cars_groups",
"title": "Vehicle groups"
}
]
},
{
"field": "cars",
"field_group": "vehicles",
"title": "Vehicles",
"type": "select",
"multiple": true,
"required": true,
"options": [
{
"title": "AB-1234 (Volvo FH)",
"value": 297802
},
{
"title": "Android",
"value": 270233
},
{
"title": "BLE-115 (BLE test)",
"value": 383462
},
{
"title": "JG-1402 (DAF 105)",
"value": 312725
},
{
"title": "JL-2400 (BMW)",
"value": 81297
}
]
},
{
"field": "cars_groups",
"field_group": "vehicles",
"title": "Vehicle groups",
"type": "select",
"multiple": true,
"required": true,
"options": []
}
],
"active_times": [
{
"title": "Time from",
"field": "time_hour_from",
"field_group": "active_times",
"required": true,
"type": "select",
"multiple": false,
"options": [
{
"title": "00",
"value": "00"
},
{
"title": "01",
"value": "01"
},
{
"title": "02",
"value": "02"
},
{
"title": "03",
"value": "03"
},
{
"title": "04",
"value": "04"
},
{
"title": "05",
"value": "05"
},
{
"title": "06",
"value": "06"
},
{
"title": "07",
"value": "07"
},
{
"title": "08",
"value": "08"
},
{
"title": "09",
"value": "09"
},
{
"title": "10",
"value": "10"
},
{
"title": "11",
"value": "11"
},
{
"title": "12",
"value": "12"
},
{
"title": "13",
"value": "13"
},
{
"title": "14",
"value": "14"
},
{
"title": "15",
"value": "15"
},
{
"title": "16",
"value": "16"
},
{
"title": "17",
"value": "17"
},
{
"title": "18",
"value": "18"
},
{
"title": "19",
"value": "19"
},
{
"title": "20",
"value": "20"
},
{
"title": "21",
"value": "21"
},
{
"title": "22",
"value": "22"
},
{
"title": "23",
"value": "23"
}
]
},
{
"title": "Minutes",
"field": "time_minute_from",
"field_group": "active_times",
"required": true,
"type": "select",
"multiple": false,
"options": [
{
"title": "00",
"value": "00"
},
{
"title": "05",
"value": "05"
},
{
"title": "10",
"value": "10"
},
{
"title": "15",
"value": "15"
},
{
"title": "20",
"value": "20"
},
{
"title": "25",
"value": "25"
},
{
"title": "30",
"value": "30"
},
{
"title": "35",
"value": "35"
},
{
"title": "40",
"value": "40"
},
{
"title": "45",
"value": "45"
},
{
"title": "50",
"value": "50"
},
{
"title": "55",
"value": "55"
},
{
"title": "59",
"value": "59"
}
]
},
{
"title": "Time to",
"field": "time_hour_to",
"field_group": "active_times",
"required": true,
"type": "select",
"multiple": false,
"options": [
{
"title": "00",
"value": "00"
},
{
"title": "01",
"value": "01"
},
{
"title": "02",
"value": "02"
},
{
"title": "03",
"value": "03"
},
{
"title": "04",
"value": "04"
},
{
"title": "05",
"value": "05"
},
{
"title": "06",
"value": "06"
},
{
"title": "07",
"value": "07"
},
{
"title": "08",
"value": "08"
},
{
"title": "09",
"value": "09"
},
{
"title": "10",
"value": "10"
},
{
"title": "11",
"value": "11"
},
{
"title": "12",
"value": "12"
},
{
"title": "13",
"value": "13"
},
{
"title": "14",
"value": "14"
},
{
"title": "15",
"value": "15"
},
{
"title": "16",
"value": "16"
},
{
"title": "17",
"value": "17"
},
{
"title": "18",
"value": "18"
},
{
"title": "19",
"value": "19"
},
{
"title": "20",
"value": "20"
},
{
"title": "21",
"value": "21"
},
{
"title": "22",
"value": "22"
},
{
"title": "23",
"value": "23"
}
]
},
{
"title": "Minutes",
"field": "time_minute_to",
"field_group": "active_times",
"required": true,
"type": "select",
"multiple": false,
"options": [
{
"title": "00",
"value": "00"
},
{
"title": "05",
"value": "05"
},
{
"title": "10",
"value": "10"
},
{
"title": "15",
"value": "15"
},
{
"title": "20",
"value": "20"
},
{
"title": "25",
"value": "25"
},
{
"title": "30",
"value": "30"
},
{
"title": "35",
"value": "35"
},
{
"title": "40",
"value": "40"
},
{
"title": "45",
"value": "45"
},
{
"title": "50",
"value": "50"
},
{
"title": "55",
"value": "55"
},
{
"title": "59",
"value": "59"
}
]
},
{
"type": "select",
"title": "Days",
"required": true,
"options": [
{
"title": "Mo",
"value": 1
},
{
"title": "Tu",
"value": 2
},
{
"title": "We",
"value": 3
},
{
"title": "Th",
"value": 4
},
{
"title": "Fr",
"value": 5
},
{
"title": "St",
"value": 6
},
{
"title": "Sn",
"value": 7
}
],
"field_group": "active_times",
"multiple": true,
"field": "days"
}
],
"delivery": [
{
"type": "checkbox",
"title": "To e-mail: %email%",
"field": "email",
"field_group": "delivery"
},
{
"type": "checkbox",
"title": "To phone: %phone%",
"field": "phone",
"field_group": "delivery"
},
{
"type": "checkbox",
"title": "Pop-up window (WEB)",
"field": "show_popup",
"field_group": "delivery"
},
{
"type": "email",
"multiple": true,
"title": "Additional e-mails",
"field_group": "delivery",
"field": "additional_emails"
},
{
"type": "phone",
"multiple": true,
"title": "Additional phones",
"field_group": "delivery",
"field": "additional_phones"
}
],
"active_period": [
{
"title": "Active",
"field": "active",
"field_group": "active_period",
"required": true,
"type": "select",
"multiple": false,
"options": [
{
"title": "Active always",
"value": "always"
},
{
"title": "Active in period",
"value": "period"
}
]
},
{
"title": "Date from",
"field": "date_active_from",
"field_group": "active_period",
"required": false,
"type": "date"
},
{
"title": "Time from",
"field": "hour_active_from",
"field_group": "active_period",
"required": false,
"type": "select",
"multiple": false,
"options": [
{
"title": "00",
"value": "00"
},
{
"title": "01",
"value": "01"
},
{
"title": "02",
"value": "02"
},
{
"title": "03",
"value": "03"
},
{
"title": "04",
"value": "04"
},
{
"title": "05",
"value": "05"
},
{
"title": "06",
"value": "06"
},
{
"title": "07",
"value": "07"
},
{
"title": "08",
"value": "08"
},
{
"title": "09",
"value": "09"
},
{
"title": "10",
"value": "10"
},
{
"title": "11",
"value": "11"
},
{
"title": "12",
"value": "12"
},
{
"title": "13",
"value": "13"
},
{
"title": "14",
"value": "14"
},
{
"title": "15",
"value": "15"
},
{
"title": "16",
"value": "16"
},
{
"title": "17",
"value": "17"
},
{
"title": "18",
"value": "18"
},
{
"title": "19",
"value": "19"
},
{
"title": "20",
"value": "20"
},
{
"title": "21",
"value": "21"
},
{
"title": "22",
"value": "22"
},
{
"title": "23",
"value": "23"
}
]
},
{
"title": "",
"field": "minute_active_from",
"field_group": "active_period",
"required": false,
"type": "select",
"multiple": false,
"options": [
{
"title": "00",
"value": "00"
},
{
"title": "05",
"value": "05"
},
{
"title": "10",
"value": "10"
},
{
"title": "15",
"value": "15"
},
{
"title": "20",
"value": "20"
},
{
"title": "25",
"value": "25"
},
{
"title": "30",
"value": "30"
},
{
"title": "35",
"value": "35"
},
{
"title": "40",
"value": "40"
},
{
"title": "45",
"value": "45"
},
{
"title": "50",
"value": "50"
},
{
"title": "55",
"value": "55"
},
{
"title": "59",
"value": "59"
}
]
},
{
"title": "Date to",
"field": "date_active_to",
"field_group": "active_period",
"required": false,
"type": "date"
},
{
"title": "Time to",
"field": "hour_active_to",
"field_group": "active_period",
"required": false,
"type": "select",
"multiple": false,
"options": [
{
"title": "00",
"value": "00"
},
{
"title": "01",
"value": "01"
},
{
"title": "02",
"value": "02"
},
{
"title": "03",
"value": "03"
},
{
"title": "04",
"value": "04"
},
{
"title": "05",
"value": "05"
},
{
"title": "06",
"value": "06"
},
{
"title": "07",
"value": "07"
},
{
"title": "08",
"value": "08"
},
{
"title": "09",
"value": "09"
},
{
"title": "10",
"value": "10"
},
{
"title": "11",
"value": "11"
},
{
"title": "12",
"value": "12"
},
{
"title": "13",
"value": "13"
},
{
"title": "14",
"value": "14"
},
{
"title": "15",
"value": "15"
},
{
"title": "16",
"value": "16"
},
{
"title": "17",
"value": "17"
},
{
"title": "18",
"value": "18"
},
{
"title": "19",
"value": "19"
},
{
"title": "20",
"value": "20"
},
{
"title": "21",
"value": "21"
},
{
"title": "22",
"value": "22"
},
{
"title": "23",
"value": "23"
}
]
},
{
"title": "",
"field": "minute_active_to",
"field_group": "active_period",
"required": false,
"type": "select",
"multiple": false,
"options": [
{
"title": "00",
"value": "00"
},
{
"title": "05",
"value": "05"
},
{
"title": "10",
"value": "10"
},
{
"title": "15",
"value": "15"
},
{
"title": "20",
"value": "20"
},
{
"title": "25",
"value": "25"
},
{
"title": "30",
"value": "30"
},
{
"title": "35",
"value": "35"
},
{
"title": "40",
"value": "40"
},
{
"title": "45",
"value": "45"
},
{
"title": "50",
"value": "50"
},
{
"title": "55",
"value": "55"
},
{
"title": "59",
"value": "59"
}
]
}
]
},
"field_groups": [
"other",
"objects",
"vehicles",
"active_times",
"delivery",
"active_period"
]
}| Code | Description |
|---|---|
| 1 | Invalid user |
| 2 | Parameter "alert_type" can not be empty |
| 3 | The provided alert type is not supported |
| 4 | The provided alert type is not accessible |
GET https://mapon.com/api/v1/alert/list_setups.jsonsetup_types endpointsetup_id value can be obtained from response of this method. Recommended to use without other filters (alert_type, unit_ids) as it will not override those filters and you may end up with no results.condition - alert condition message. Localized.units_title - formatted title for alert setup units. Localized.created - information about alert setup creator and creation timemodified - information about last alert setup modification (time and actor)fields - list of alert setup field values0 and 1fields object property keys match those that are returned in setup_fields endpoint.title, condition and units_title.{
"setups": [
{
"setup_id": "MzY3MjI6aW5fb2JqZWN0OmV2ZW50",
"alert_type": "in_object",
"title": "Arrives\/leaves the object",
"expired": false,
"active": true,
"condition": "Arrives\/leaves the object 3 territories (00:00-23:59) Mo, Tu, We, Th, Fr",
"units_title": "All vehicles (104)",
"created": {
"created_at": "2023-03-10T09:47:18Z",
"created_by": "Admin User"
},
"modified": null,
"fields": {
"objects": [
1143954,
1184388,
1189089
],
"alert_text": "",
"days": [
1,
2,
3,
4,
5
],
"email": true,
"phone": true,
"show_popup": true,
"additional_emails": [],
"additional_phones": [],
"object_visits": [
"object_visit",
"object_leave"
],
"car_type": "all_cars",
"cars": null,
"cars_groups": null,
"object_type": "objects",
"object_groups": [],
"time_hour_from": "00",
"time_minute_from": "00",
"time_hour_to": "23",
"time_minute_to": "59",
"active": "always",
"date_active_from": null,
"hour_active_from": null,
"minute_active_from": null,
"date_active_to": null,
"hour_active_to": null,
"minute_active_to": null
}
},
{
"setup_id": "MzY3MjE6c3BlZWRpbmdfZXZlbnQ6ZXZlbnQ=",
"alert_type": "speeding",
"title": "Overspeeding",
"expired": false,
"active": true,
"condition": "Driving speed is >120 km\/h for 3min",
"units_title": "4 Vehicles",
"created": {
"created_at": "2023-03-10T09:44:39Z",
"created_by": "Admin User"
},
"modified": null,
"fields": {
"speed": 120,
"duration": 180,
"days": [
1,
2,
3,
4,
5
],
"email": true,
"phone": false,
"show_popup": true,
"additional_emails": [],
"additional_phones": [],
"car_type": "cars",
"cars": {
"133982": 133982,
"213572": 213572,
"265317": 265317,
"297802": 297802
},
"cars_groups": null,
"time_hour_from": "00",
"time_minute_from": "00",
"time_hour_to": "23",
"time_minute_to": "59",
"active": "always",
"date_active_from": null,
"hour_active_from": null,
"minute_active_from": null,
"date_active_to": null,
"hour_active_to": null,
"minute_active_to": null
}
},
{
"setup_id": "NDM4MzEyOm1vdmluZzphbGVydA==",
"alert_type": "moving",
"title": "Vehicle started movement",
"expired": false,
"active": true,
"condition": "(00:00-23:59) Mo, Tu, We, Th, Fr",
"units_title": "56 Vehicles",
"created": {
"created_at": "2023-03-10T09:41:09Z",
"created_by": "Admin User"
},
"modified": null,
"fields": {
"days": [
1,
2,
3,
4,
5
],
"email": true,
"phone": false,
"show_popup": true,
"additional_emails": [],
"additional_phones": [],
"car_type": "cars_groups",
"cars": null,
"cars_groups": {
"361": 361,
"59877": 59877
},
"time_hour_from": "00",
"time_minute_from": "00",
"time_hour_to": "23",
"time_minute_to": "59",
"active": "period",
"date_active_from": "2023-03-10",
"hour_active_from": "00",
"minute_active_from": "00",
"date_active_to": "2023-03-31",
"hour_active_to": "23",
"minute_active_to": "59"
}
},
{
"setup_id": "MzY3MjA6c29zYnV0dG9uX2V2ZW50OmV2ZW50",
"alert_type": "sosbutton",
"title": "SOS Button",
"expired": false,
"active": true,
"condition": "SOS Button triggered",
"units_title": "All vehicles (14)",
"created": {
"created_at": "2023-03-10T09:39:42Z",
"created_by": "Admin User"
},
"modified": {
"modified_at": "2023-03-10T09:48:13Z",
"modified_by": ""
},
"fields": {
"days": [
1,
2,
3,
4,
5
],
"email": false,
"phone": false,
"show_popup": false,
"additional_emails": [],
"additional_phones": [],
"car_type": "all_cars",
"cars": null,
"cars_groups": null,
"time_hour_from": "00",
"time_minute_from": "00",
"time_hour_to": "23",
"time_minute_to": "59",
"active": "always",
"date_active_from": null,
"hour_active_from": null,
"minute_active_from": null,
"date_active_to": null,
"hour_active_to": null,
"minute_active_to": null
}
},
{
"setup_id": "NDM4MzExOm5vX3Bvd2VyOmFsZXJ0",
"alert_type": "no_power",
"title": "Power off",
"expired": false,
"active": true,
"condition": "Equipment has been disconnected!",
"units_title": "All vehicles (104)",
"created": {
"created_at": "2023-03-10T09:38:33Z",
"created_by": "Admin User"
},
"modified": null,
"fields": {
"alert_connecting": true,
"days": [
1,
2,
3,
4,
5
],
"email": true,
"phone": true,
"show_popup": true,
"additional_emails": [],
"additional_phones": [],
"car_type": "all_cars",
"cars": null,
"cars_groups": null,
"time_hour_from": "02",
"time_minute_from": "45",
"time_hour_to": "19",
"time_minute_to": "45",
"active": "always",
"date_active_from": null,
"hour_active_from": null,
"minute_active_from": null,
"date_active_to": null,
"hour_active_to": null,
"minute_active_to": null
}
},
{
"setup_id": "NDA1MzAzOnN1cHBseV92b2x0YWdlX25ldzphbGVydA==",
"alert_type": "supply_voltage",
"title": "Supply voltage alert",
"expired": false,
"active": true,
"condition": "Supply voltage 12.00 (External power).",
"units_title": "Audi-A4-MG-test (Audi a4)",
"created": {
"created_at": "2022-08-12T06:07:57Z",
"created_by": "Admin User"
},
"modified": {
"modified_at": "2023-03-10T09:37:11Z",
"modified_by": "Admin User"
},
"fields": {
"min_supply_voltage": 12,
"supply_types": [
"power"
],
"object": 1189088,
"duration": 0,
"email": false,
"phone": false,
"show_popup": false,
"additional_emails": [
"some.user@example.com"
],
"additional_phones": [
"+123 12345678"
],
"car_type": "cars",
"cars": {
"197798": 197798
},
"cars_groups": null,
"active": "always",
"date_active_from": null,
"hour_active_from": null,
"minute_active_from": null,
"date_active_to": null,
"hour_active_to": null,
"minute_active_to": null
}
},
{
"setup_id": "MzE2MjQ3OmJhdHRlcnlfbGV2ZWw6YWxlcnQ=",
"alert_type": "battery_level",
"title": "Battery level",
"expired": false,
"active": true,
"condition": "Battery level under 35%",
"units_title": "JT-821 (AlfaRomeo 156)",
"created": {
"created_at": "2020-11-03T09:25:51Z",
"created_by": "Admin User"
},
"modified": {
"modified_at": "2021-10-30T22:50:43Z",
"modified_by": "28065 test"
},
"fields": {
"level": 35,
"remind_level": null,
"object": null,
"email": false,
"phone": true,
"show_popup": true,
"additional_emails": [],
"additional_phones": [
"+37122444339"
],
"car_type": "cars",
"cars": {
"93843": 93843
},
"cars_groups": null,
"active": "always",
"date_active_from": null,
"hour_active_from": null,
"minute_active_from": null,
"date_active_to": null,
"hour_active_to": null,
"minute_active_to": null
}
}
]
}| Code | Description |
|---|---|
| 1 | Invalid user |
| 2 | Parameter "alert_type" can not be empty |
| 3 | The provided alert type is not supported |
| 4 | The provided alert type is not accessible |
| 5 | Parameter "setup_id" can not be empty |
| 6 | Invalid parameter "setup_id" |
| 7 | Alert setup not found |
| 9 | Invalid include |
| 10 | Invalid or missing "unit_id" parameter |
POST https://mapon.com/api/v1/alert/store_setup.jsonsetup_id property obtained from list_setups endpointsetup_types endpointsetup_fields endpoint. MUST use property field as key and set the value according to limitations and format indicated in the responseImportant! All field values that contain dates and times MUST be passed in UTC timezone, regardless of formatvalidation_errors property will be null if no validation errors have been encountered.
If there are validation errors, then the validation_errors property will contain array of fields that failed to pass validation along with messages about violated rules.
If saving of the setup succeeds then id will contain setup id and success will be true. If it fails then id will be null and success will be false
{
"id": null,
"success": false,
"validation_errors": {
"objects": [
"can not be empty!"
],
"cars_groups": [
"Illegal value"
],
"additional_emails": [
"Invalid e-mail"
]
}
}| Code | Description |
|---|---|
| 1 | Invalid user |
| 2 | Parameter "alert_type" can not be empty |
| 3 | The provided alert type is not supported |
| 4 | The provided alert type is not accessible |
| 5 | Parameter "setup_id" can not be empty |
| 6 | Invalid parameter "setup_id" |
| 7 | Alert setup not found |
| 8 | Parameter "fields" is required |
| 9 | Failed to save alert setup |
POST https://mapon.com/api/v1/alert/delete_setup.jsonsetup_id property obtained from list_setups endpoint{
"success": true
}| Code | Description |
|---|---|
| 1 | Invalid user |
| 2 | Parameter "alert_type" can not be empty |
| 3 | The provided alert type is not supported |
| 4 | The provided alert type is not accessible |
| 5 | Parameter "setup_id" can not be empty |
| 6 | Invalid parameter "setup_id" |
| 7 | Alert setup not found |
| 8 | Internal error. Failed to delete alert setup |
GET https://mapon.com/api/v1/company/get.jsonkm,
mile,
mile_us
{
"data": {
"companies": [
{
"id": 1,
"name": "xxxx",
"legal_name": "xxxx",
"reg_no": 10714348,
"address": "xxxxx",
"timezone": "Europe\/Riga",
"currency": "EUR",
"distance_unit": "km",
"application_fields": [
{
"id": 1,
"application_id": 1,
"level": "driver",
"type": "text",
"title": "Text title",
"title_translation": null,
"unique_per_company": false,
"value": "xx",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T09:00:00Z"
}
]
}
]
}
}POST https://mapon.com/api/v1/company_clients/create.json0;1. Default: 10;1. Default: 10;1. Default: 10;1. Default: 10;1. Default: 10;1. Default:00;1. Default: 000:00, to:23:59} is saved.00-23. Allowed minutes range: 00-59.00-23. Allowed minutes range: 00-59.{
"data": {
"id": 1
}
}| Code | Description |
|---|---|
| 1 | invalid or missing name parameter |
| 3 | invalid email parameter |
| 4 | invalid address parameter |
| 8 | invalid working_times item from parameter |
| 9 | invalid working_times item to parameter |
| 11 | working_times parameters must be different |
GET https://mapon.com/api/v1/company_clients/list.json11;Max value:200array data
int idstring namestring addressfloat address_latfloat address_lngstring phonestring emailstring commentsobject|null working_days
bool mondaybool tuesdaybool wednesdaybool thursdaybool fridaybool saturdaybool sundayobject|null working_times
string fromstring toobject _meta
int totalint total_pagesint per_pagesint page{
"data": [
{
"id": 1,
"name": "A",
"address": "Sample street",
"address_lat": 1.12345,
"address_lng": 2.12345,
"phone": "+1234567890",
"email": "john.smith@example.com",
"comments": "Some comments",
"working_days": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"working_times": {
"from": "09:00",
"to": "18:59"
}
}
],
"_meta": {
"total": 1,
"total_pages": 1,
"per_page": 100,
"page": 1
}
}GET https://mapon.com/api/v1/preset/list.json{
"data": [
{
"id": 1,
"title": "Preset #1",
"is_custom": false
},
{
"id": 2,
"title": "Custom preset for user id XX",
"is_custom": true
}
]
}GET https://mapon.com/api/v1/preset/one.json{
"data": {
"title": "Custom preset for user ID XX",
"is_custom": true,
"has_access_to_all_cars": false,
"has_access_to_all_drivers": false,
"has_access_to_all_objects": true,
"has_access_to_all_menus": false,
"has_access_to_all_ble_beacons": false,
"cars": [
1,
2
],
"carGroups": [],
"carDepots": [],
"drivers": [],
"driverDepots": [],
"objects": [],
"objectGroups": [],
"bleBeacons": [],
"menus": [
3
],
"permissions": {
"can_edit_object": false,
"has_limited_objects_access": false,
"can_edit_obj_others": false,
"can_access_tracking_link": true,
"has_reefer_control": false,
"do_allow_sms_features": true,
"has_private_car_groups": false,
"can_control_device": false,
"can_export_reefer_report": false,
"communication_with_driver": "default"
},
"restrictions": {
"restricted_mobile_access": false,
"restricted_ip_range": null
}
}
}GET https://mapon.com/api/v1/preset/availablepermissions.json{
"data": {
"can_edit_object": false,
"has_limited_objects_access": false,
"can_edit_obj_others": false,
"can_access_tracking_link": false,
"has_reefer_control": false,
"do_allow_sms_features": false,
"has_private_car_groups": false,
"can_control_device": false,
"can_export_reefer_report": false,
"communication_with_driver": "default"
}
}POST https://mapon.com/api/v1/preset/delete.json{
"status": "successful"
}POST https://mapon.com/api/v1/preset/create.jsonrestricted_mobile_access - boolean, whether to restrict access to system from mobile phonerestricted_ip_range - string, range of restricted IP's1 or 0{
"id": 123,
"status": "successful"
}POST https://mapon.com/api/v1/preset/edit.json_ids) are not passed, those are considered to be deleted.
To keep the array information present, mirror data from Preset data endpoint.
restricted_mobile_access - boolean, whether to restrict access to system from mobile phonerestricted_ip_range - string, range of restricted IP's{
"status": "successful"
}POST https://mapon.com/api/v1/customlayers/save.jsonid created/edited custom layer id{
"data": {
"id": 1
}
}| Code | Description |
|---|---|
| 1 | missing or invalid name parameter |
| 2 | missing or invalid geom_type parameter |
| 3 | invalid id parameter |
| 5 | missing or invalid color parameter |
GET https://mapon.com/api/v1/customlayers/list.jsonidname Max length: 255color Color hex code. E.g. #FF5733{
"id": 1,
"name": "Gas stations",
"color": "#FF5733"
}| Code | Description |
|---|---|
| 1 | invalid limit parameter |
| 2 | invalid offset paremter |
POST https://mapon.com/api/v1/customlayers/delete.jsonstatus{
"data": {
"status": true
}
}| Code | Description |
|---|---|
| 1 | missing or invalid id parameter |
POST https://mapon.com/api/v1/customlayers_geometries/add.jsonPOINT. E.g. POINT(51.49318 -0.15068)status{
"data": {
"status": true
}
}| Code | Description |
|---|---|
| 1 | missing or invalid layer_id parameter |
| 2 | missing or invalid geometries parameter |
| 3 | 1000 geometries are allowed per request |
| 100 | invalid name parameter |
| 101 | missing or invalid wkt parameter |
POST https://mapon.com/api/v1/customlayers_geometries/edit.jsonPOINT. E.g. POINT(51.49318 -0.15068)status{
"data": {
"status": true
}
}| Code | Description |
|---|---|
| 1 | missing or invalid id parameter |
| 100 | invalid name parameter |
| 101 | missing or invalid wkt parameter |
POST https://mapon.com/api/v1/customlayers_geometries/list.json{
"data": {
"geometries": [
{
"id": 1,
"name": "Gas station 1",
"wkt": "POINT(51.49318 -0.15068)"
}
],
"total": 123
}
}| Code | Description |
|---|---|
| 1 | missing or invalid layer_id parameter |
| 2 | invalid limit parameter |
| 3 | invalid offset parameter |
POST https://mapon.com/api/v1/customlayers_geometries/delete.jsonstatus{
"data": {
"status": true
}
}| Code | Description |
|---|---|
| 1 | missing or invalid id parameter |
GET https://mapon.com/api/v1/menu/list.json{
"data": [
{
"id": 1,
"name": "Map",
"parent_id": 0
},
{
"id": 3,
"name": "Online",
"parent_id": 1
}
]
}GET https://mapon.com/api/v1/unit/list.jsonin_objects - return objects where unit is located (currently this will work only if single unit is requested)io_din - return digital input infofuel - return fuel levelsfuel_tank - return fuel tank volumescan - return can datareefer - return data about refrigeratordrivers - return data about driverstemperature - return data about temperature sensorsambienttemp - return data about ambient temperature sensorshumidity - return data about humidity sensorsdevice - return data about installed devicesupply_voltage - return supply voltagebattery_voltage - return battery voltagebattery_level_percentage - return battery percentage (if data exists)relays - return relay dataweights - return CAN weight dataignition - return current ignition statetachograph - return tachograph driver card presence and tachograph driver id informationaltitude - return latest GPS altitudetechnical_details - vehicle technical informationtrailer_connections - connected trailers informationsaved_values - return saved values from mappings (currently this will work only if single unit is requested)driving,
standing,
nodata,
nogps,
service
driving,
standing
0 - 360P - PetrolD - DieselG - LPG (liquefied petroleum gas)E - ElectricPROPANE - PropaneLNG - LNG (liquefied natural gas)CNG - CNG (compressed natural gas)ETHANOL - EthanolHYDROGEN - HydrogenHYBRID - Hybridl\100km - fuel consumption by distance,
l/1h - fuel consumption per hour
kg/100km - fuel weight (for vehicles that use CNG) consumption by distance
kg/100km all fuel values, i.e. avg_fuel_consumption are represented in KG, not in L
null - fuel tank volumes not available{
"data": {
"units": [
{
"unit_id": 1,
"box_id": 1,
"company_id": 1,
"country_code": "LV",
"label": "VOLVO FH",
"number": "XX1234",
"shortcut": "XX1234",
"vehicle_title": "XX1234",
"car_reg_certificate": "SW33T",
"vin": "xxx",
"type": "car",
"icon": "no-icon",
"lat": 38.30008,
"lng": 23.65109,
"direction": 0,
"speed": 10,
"mileage": 113746523,
"last_update": "2017-05-22T12:23:46Z",
"ignition_total_time": 16508293,
"state": {
"name": "standing",
"start": "2017-05-22T11:21:13Z",
"duration": 3840,
"debug_info": {
"msg": "LOW VOLTAGE",
"data": {
"battery": "1",
"last_voltage": "4.43",
"power_status": "on",
"power_status_gmt": "2016-09-30 12:27:05",
"last_data": 1479280400
}
}
},
"fuel_type": "P",
"avg_fuel_consumption": {
"norm": 8.2,
"measurement": "l\/100km"
},
"created_at": "2019-01-01T01:00:00Z",
"movement_state": {
"name": "standing",
"start": "2017-05-22T11:21:13Z",
"duration": 3840
},
"supply_voltage": {
"gmt": "2017-12-27T11:35:51Z",
"value": 25.71
},
"battery_voltage": {
"gmt": "2017-12-27T11:37:51Z",
"value": 215.71
},
"device": {
"id": 1,
"serial_number": "1",
"imei": 11111,
"sim": "555-2368"
},
"io_din": [
{
"no": 1,
"label": "Alarm",
"state": "0"
},
{
"no": 2,
"label": "Ignition",
"state": "1"
}
],
"connected": {
"unit_id": "2",
"type": "trailer",
"location": {
"lat": "38.2998",
"lng": "23.651"
}
},
"fuel": [
{
"type": "CAN",
"metrics": "L",
"value": 2052,
"last_update": "2017-05-22T11:21:53Z"
}
],
"fuel_tank": {
"total_vol": 70,
"fuel_tank_vol_0": 70
},
"in_objects": {
"objects": [
{
"object_id": "1",
"name": "R\u012bga"
}
]
},
"temperature": {
"temp_2": {
"gmt": "2017-05-17T09:02:38Z",
"value": 16.28
}
},
"ambienttemp": {
"gmt": "2017-05-22T11:38:01Z",
"value": 28.3
},
"humidity": {
"humidity_tank_2": {
"gmt": "2017-05-17T09:02:48Z",
"value": 67.5
}
},
"can": {
"odom": {
"gmt": "2017-05-22T11:38:01Z",
"value": "115224.965"
},
"fuel_total": {
"gmt": "2017-05-22T11:41:08Z",
"value": "30527.5"
},
"engine_hours": {
"gmt": "2017-05-22T11:21:51Z",
"value": "1719.45"
}
},
"weights": {
"axis": {
"1": {
"gmt": "2019-11-08T14:03:09Z",
"value": "4500"
},
"2": {
"gmt": "2019-11-08T14:03:09Z",
"value": "9600"
}
},
"combination_weight": {
"gmt": "2019-11-08T14:07:11Z",
"value": "32000"
},
"powered_weight": {
"gmt": "2019-11-08T14:49:28Z",
"value": "14100"
}
},
"reefer": {
"0": {
"flags": {
"flag": {
"value": 1,
"gmt": "2016-01-26T06:55:30Z"
}
},
"hours": {
"diesel": {
"value": 1788,
"gmt": "2016-01-26T06:55:30Z"
},
"electric": {
"value": 8,
"gmt": "2016-01-26T06:55:30Z"
},
"standby": {
"value": 97,
"gmt": "2016-01-26T06:55:30Z"
}
},
"mode": {
"power": {
"value": 0,
"gmt": "2016-01-26T06:55:30Z"
},
"run": {
"value": 1,
"gmt": "2016-01-26T06:55:30Z"
},
"speed": {
"value": 0,
"gmt": "2016-01-26T06:55:30Z"
}
},
"temperature": {
"return": {
"value": 4.7,
"gmt": "2016-01-26T06:55:30Z"
},
"setpoint": {
"value": 4,
"gmt": "2016-01-26T06:55:30Z"
},
"supply": {
"value": 1.5,
"gmt": "2016-01-26T06:55:30Z"
},
"cargowatch_rear": {
"value": -17.8,
"gmt": "2016-01-26T06:55:30Z"
},
"cargowatch_return": {
"value": 7.4,
"gmt": "2016-01-26T06:55:30Z"
}
},
"state": {
"value": "off",
"gmt": "2016-01-26T06:55:30Z"
}
},
"refrigerator_communication_type": "2",
"refrigerator_compartment_count": "1",
"refrigerator_type": "THERMOKING"
},
"drivers": {
"driver1": {
"id": "1",
"name": "Name Surname",
"phone": "",
"ibutton": "",
"tacho_id": "00000000000001"
},
"driver2": {
"id": "2",
"name": "Name Surname",
"phone": "",
"ibutton": "",
"tacho_id": "00000000000002"
}
},
"relays": [
{
"relay_id": "1",
"relay_state": "0",
"type": "basic",
"title": "Door",
"inverted": "0",
"control_while_moving": "0",
"enabled": "1"
},
{
"relay_id": "2",
"relay_state": "1",
"type": "engine_block",
"title": "Engine",
"inverted": "0",
"control_while_moving": "0",
"enabled": "1"
}
],
"application_fields": [
{
"id": 1,
"application_id": 1,
"level": "vehicle",
"type": "text",
"title": "Text title",
"title_translation": null,
"unique_per_company": false,
"value": "xx",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T09:00:00Z"
}
],
"tachograph": {
"driver1": {
"tacho_card": {
"gmt": "2020-09-07T14:39:37Z",
"value": 1
},
"tacho_id": {
"gmt": "2020-09-07T14:42:11Z",
"value": "0000000012345678"
}
},
"driver2": {
"tacho_card": {
"gmt": "2020-09-07T14:39:08Z",
"value": 0
},
"tacho_id": {
"gmt": "2020-09-06T23:59:59Z",
"value": ""
}
}
},
"saved_values": [
{
"key": "My value",
"value": "3",
"gmt": "2024-05-19 21:42:46"
}
],
"technical_details": {
"stage_classification": "Stage2",
"emission_class": "Euro1",
"gross_weight": 2250,
"make_year": "2001",
"make_month": "3",
"power_ps": 14,
"power_kw": 10,
"cubic_capacity": 0.04,
"co2_emissions": {
"value": "12",
"metrics": "g\/km"
}
}
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | in_objects info is available only when requesting single unit |
| 3 | saved_values info is available only when requesting single unit |
POST https://mapon.com/api/v1/unit/install.json{
"data": {
"status": "ok",
"unit_id": 1
}
}| Code | Description |
|---|---|
| 1 | Not specified box_id or car_number parameter |
| 2 | Car number already in use |
| 3 | Can't find device with specified parameter |
| 4 | Error while creating car |
POST https://mapon.com/api/v1/unit/uninstall.json{
"data": {
"status": "ok",
"unit_id": 1
}
}| Code | Description |
|---|---|
| 1 | Not specified "unit_id" parameter |
| 2 | API key does not have associated unit with specified parameters |
| 3 | Invalid value or incorrect format for parameter unit_id (int) |
| 4 | Unit is not associated with device |
POST https://mapon.com/api/v1/unit/change_device.json{
"data": {
"status": "ok",
"unit_id": 1,
"box_id": 1
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "unit_id" parameter |
| 2 | API key does not have associated unit with specified parameters |
| 3 | Unit must be from your own company |
| 4 | Invalid or unknown "box_id" parameter |
| 5 | API key does not have access to device with specified parameters |
| 6 | Failed to change unit device |
POST https://mapon.com/api/v1/unit/edit.jsonD,
P,
G,
E,
PROPANE,
LNG,
CNG,
ETHANOL,
HYDROGEN,
HYBRID,
Ll/100km (default),l/h (for tractors), kg/100km (for vehicles with CNG fuel systems){
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Not specified "unit_id" or "vin" parameter |
| 2 | Invalid value or incorrect format for parameter unit_id (int) |
| 3 | Can`t find unit with specified parameters |
| 4 | API key does not have associated unit with specified parameters |
| 5 | service_till invalid format |
| 6 | Illegal driver ID |
| 7 | Illegal co-driver ID |
| 8 | Demo car |
| 9 | Can`t find depot associated with this API key |
| 10 | Invalid value or incorrect format for parameter reefer_type |
| 11 | Invalid value or incorrect format for parameter reefer_communication_level |
| 12 | Invalid value or incorrect format for parameter reefer_compartment_count |
| 13 | Invalid fuel representation value |
POST https://mapon.com/api/v1/unit/change_relay.jsonhttps://mapon.com/api/v1/unit/list.json endpoint with relays as the include parameter.{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "unit_id" parameter |
| 2 | Invalid or unknown "relay_id" parameter |
| 3 | Invalid or unknown "relay_state" parameter |
| 4 | API key does not have any units associated |
| 5 | Company does not have any users to associate the relay change with |
| 6 | Relay id not found |
| 7 | Can not block engine while vehicle is driving |
GET https://mapon.com/api/v1/unit/custom_fields.json{
"data": [
{
"id": 1,
"label": "Tyre size",
"type": "select",
"settings": {
"options": {
"5ae07f0120141": "R14",
"5ae07f012017a": "R15",
"5ae07f01201b2": "R16"
}
},
"value": "5ae07f012017a"
},
{
"id": 2,
"label": "Photo",
"type": "image",
"settings": [],
"value": "http:\/\/example.com?file.php?234sf23fsw"
},
{
"id": 3,
"label": "Trailer no.",
"type": "text",
"settings": [],
"value": "AAA 0000"
},
{
"id": 4,
"label": "datums",
"type": "date",
"settings": [],
"value": "1524661491"
},
{
"id": 5,
"label": "Video",
"type": "hyperlink",
"settings": [],
"value": "http:\/\/example.com\/aaa.mp4",
"title": "Test"
},
{
"id": 6,
"label": "Documents",
"type": "file",
"settings": [],
"value": null
}
]
}| Code | Description |
|---|---|
| 1 | Not specified unit_id parameter |
| 2 | API key does not have associated unit with specified parameters |
| 3 | Can't find unit with specified parameters |
| 4 | Invalid value or incorrect format for parameter unit_id (int) |
POST https://mapon.com/api/v1/unit/save_custom_fields_values.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Not specified "unit_id" or/and "fields" parameter |
| 2 | API key does not have associated unit with specified parameters |
| 3 | Can't find unit with specified parameters |
| 4 | Can't find fields with specified parameters |
| 5 | Fields with type hyperlink JSON string must contain title un value keys |
| 6 | Invalid field "{FIELD_NAME}" value. |
| 7 | File upload allowed only for fields with types: image, file |
| 8 | Fields with type {FIELD_TYPE} Allowed formats: {ALLOWED_FORMATS} |
| 9 | Invalid value or incorrect format for parameter unit_id (int) |
GET https://mapon.com/api/v1/unit/available_icons.json{
"data": {
"status": "ok",
"icons": [
"",
"animal",
"bicycle",
"boat",
"boom-lift",
"box",
"bulldozer",
"bus",
"car",
"cement",
"cistern",
"crane",
"elevator",
"emergency",
"excavator",
"forklift",
"generator",
"golfcart",
"loader",
"minibus",
"motorbike",
"no-icon",
"paver",
"person",
"radio",
"roller",
"stationary-crane",
"tractor",
"trailer",
"trailer-freezer",
"train",
"train-wagon",
"tram",
"trolleybus",
"truck",
"truck-heavy",
"truck-no-trailer"
]
}
}GET https://mapon.com/api/v1/unit_data/ignitions.json{
"data": {
"units": [
{
"unit_id": 8743,
"ignitions": [
{
"on": "2016-09-08 10:54:47",
"off": "2016-09-08 12:52:17"
},
{
"on": "2016-09-08 13:00:53",
"off": "2016-09-08 13:06:22"
},
{
"on": "2016-09-08 13:17:57",
"off": "2016-09-08 13:20:29"
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/unit_data/temperature.json{
"data": {
"units": [
{
"unit_id": 1,
"sensors": [
{
"no": 1,
"temperatures": [
{
"gmt": "2017-04-01 12:21:17",
"value": 5.2
},
{
"gmt": "2017-04-01 12:23:17",
"value": 5.1
},
{
"gmt": "2017-04-01 12:26:30",
"value": 5
},
{
"gmt": "2017-04-01 12:28:30",
"value": 5.1
}
]
},
{
"no": 2,
"temperatures": [
{
"gmt": "2017-04-01 12:19:17",
"value": 2
},
{
"gmt": "2017-04-01 12:21:17",
"value": 2.1
},
{
"gmt": "2017-04-01 12:23:17",
"value": 2
}
]
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/unit_data/digital_inputs.json{
"data": {
"units": [
{
"unit_id": 1,
"digital_inputs": [
{
"no": 1,
"states": [
{
"on": "2017-04-01 12:21:17",
"off": "2017-04-01 12:21:17"
},
{
"on": "2017-04-01 12:21:17",
"off": "2017-04-01 12:21:17"
}
]
},
{
"no": 2,
"states": [
{
"on": "2017-04-01 12:21:17",
"off": "2017-04-01 12:21:17"
},
{
"on": "2017-04-01 12:21:17",
"off": "2017-04-01 12:21:17"
}
]
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/unit_data/digital_inputs_extended.jsonlabel - Add label{
"data": {
"units": [
{
"unit_id": 123456,
"digital_inputs": [
{
"input_id": 1,
"label": "Example label",
"states": [
{
"gmt_on": "2020-10-20 08:45:18",
"lat_on": 56.934996,
"lng_on": 24.14113,
"place_on": "Krasta street, Riga",
"gmt_off": "2020-10-20 08:50:27",
"lat_off": 56.934996,
"lng_off": 24.14113,
"place_off": "Krasta street, Riga",
"distance_on": 1507,
"driver_id": 1234
}
]
},
{
"input_id": 2,
"states": [
{
"gmt_on": "2020-10-19 23:31:27",
"lat_on": 56.934996,
"lng_on": 24.14113,
"place_on": "Krasta street, Riga",
"gmt_off": "2020-10-20 00:03:45",
"lat_off": 56.934996,
"lng_off": 24.14113,
"place_off": "Krasta street, Riga",
"distance_on": 23490,
"driver_id": 1234
},
{
"gmt_on": "2020-10-20 09:51:46",
"lat_on": 56.934996,
"lng_on": 24.14113,
"place_on": "Krasta street, Riga",
"gmt_off": null,
"lat_off": 0,
"lng_off": 0,
"place_off": "",
"distance_on": 0,
"driver_id": 0
}
]
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or unknown input_id parameter |
| 3 | Invalid or missing from parameter |
| 4 | Invalid or missing till parameter |
| 5 | Invalid period |
| 6 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/unit_data/ibuttons.json{
"data": {
"units": [
{
"unit_id": 123456,
"ibuttons": [
{
"gmt": "2019-11-20 20:05:54",
"value": "000000000000"
},
{
"gmt": "2019-11-20 20:12:38",
"value": "000001238D0B"
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/unit_data/can_period.jsonrpm_average - Average RPMrpm_max - Maximum RPMfuel_level - Fuel level (%)service_distance - Service distance (km)total_distance - Total driven distance (km)total_fuel - Total used fuel (l)total_engine_hours - Total engine hours (h)ambient_temperature - Ambient temperature (°C)weight_on_axis - Weight on axis (kg)weight_on_chassis_total - Weight on chassis total (kg)weight_on_chassis_powered - Weight on chassis powered (kg)trailer_axle_load - Trailer axle load (kg)external_weight - External weight
kg/100km, then total_fuel values are represented in KG, not in L
{
"data": {
"units": [
{
"unit_id": 1,
"total_fuel": [
{
"gmt": "2016-09-13 12:22:14",
"value": "130410"
},
{
"gmt": "2016-09-13 12:30:14",
"value": "130414"
},
{
"gmt": "2016-09-13 12:38:14",
"value": "130417"
},
{
"gmt": "2016-09-13 12:46:14",
"value": "130420"
},
{
"gmt": "2016-09-13 12:53:05",
"value": "130424"
},
{
"gmt": "2016-09-13 12:55:05",
"value": "130424"
},
{
"gmt": "2016-09-13 12:57:05",
"value": "130425"
},
{
"gmt": "2016-09-13 12:59:05",
"value": "130426"
},
{
"gmt": "2016-09-13 13:01:05",
"value": "130426"
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/unit_data/can_point.jsonrpm_average - Average RPMrpm_max - Maximum RPMfuel_level - Fuel level (%)service_distance - Service distance (km)total_distance - Total driven distance (km)total_fuel - Total used fuel (l)total_engine_hours - Total engine hours (h)ambient_temperature - Ambient temperature (°C)weight_on_axis - Weight on axis (kg)trailer_axle_load - Trailer axle load (kg)external_weight - External weight
kg/100km, then total_fuel values are represented in KG, not in L
{
"data": {
"units": [
{
"unit_id": 1,
"rpm_average": {
"gmt": "2015-09-10 11:53:00",
"value": "0"
},
"rpm_max": {
"gmt": "2015-09-10 11:53:00",
"value": "0"
},
"fuel_level": {
"gmt": "2015-09-10 11:45:08",
"value": "12.4"
},
"total_distance": {
"gmt": "2015-09-10 11:45:00",
"value": "265357"
},
"total_fuel": {
"gmt": "2015-09-10 11:45:00",
"value": "69381.5"
},
"total_engine_hours": {
"gmt": "2015-09-10 11:53:00",
"value": "3836.85"
},
"weight_on_axis": [
{
"gmt": "2015-09-10 11:53:00",
"value": 4638,
"axis": 2,
"wheel": 3
},
{
"gmt": "2015-09-10 11:53:01",
"value": 4908,
"axis": 3,
"wheel": 1
}
],
"trailer_axle_load": {
"gmt": "2015-09-10 11:53:00",
"value": 2112
},
"ambient_temperature": {
"gmt": "2015-09-10 11:53:00",
"value": "4.4"
}
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing datetime parameter |
GET https://mapon.com/api/v1/unit_data/history_point.jsonYYYY-MM-DDTHH:II:SSZ2019-04-08T12:00:00Z
can_total_distance - Total driven distance(km) at datetime from CANmileage - Total driven distance (km) at datetime from GPSposition - Latest reported GPS coordinate at datetime{
"data": {
"units": [
{
"unit_id": 125035,
"can_total_distance": {
"gmt": "2019-04-15 06:05:19",
"value": 92337
},
"position": {
"gmt": "2019-04-17 11:56:28",
"value": {
"lat": 56.92666,
"lng": 24.02024
}
},
"mileage": {
"gmt": "2019-04-17 12:00:00",
"value": 92335.52
}
}
]
}
}GET https://mapon.com/api/v1/unit_data/fields.json{
"data": {
"units": [
{
"unit_id": 1,
"fields": {
"field1": "example",
"field2": 4
}
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
GET https://mapon.com/api/v1/unit_data/debug_info.json{
"data": {
"units": [
{
"unit_id": 11340,
"last_location": {
"lat": 56.88199,
"lng": 23.96393,
"gmt": "2015-05-25 12:41:15"
},
"fw_version": "1.2.3",
"tachograph": {
"last_test": null,
"last_id": "2014-11-20 06:40:12",
"last_status": "2015-05-24 02:26:36",
"last_vehicle_download": null,
"last_driver_download": null
},
"can": {
"total_distance": {
"value": "462416.21",
"gmt": "2015-12-30 09:01:22"
}
},
"gpsstatus": {
"value": "on",
"gmt": "2015-05-23 12:51:30"
}
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
GET https://mapon.com/api/v1/unit_data/drivingtime.json{
"data": {
"driver1": {
"current_state": "DRIVING",
"source": "can",
"driver_id": 39585,
"driver_name": "Test driver",
"driving_now": 4550,
"until_rest": 11650,
"today": {
"current": 9430,
"remaining": 26570
},
"week": {
"current": 56554,
"remaining": 145046,
"10h_driving_extensions": 0,
"10h_driving_extensions_max": 2,
"9h_rest_shortening": 2,
"9h_rest_shortening_max": 3,
"previous": 90917,
"next": 201600
},
"next_daily_rest": 37980,
"next_daily_rest_remaining": 54000,
"next_weekly_rest": 1526022578,
"next_weekly_rest_remaining": 166116
}
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "unit_id" parameter |
| 1000 | Prediction disabled |
| 1001 | Waiting for data update to calculate proper driving times |
| 1015 | Endpoint needs Tachograph remote download subscription |
GET https://mapon.com/api/v1/unit_data/driving_time_extended.json{
"data": {
"driver1": {
"current_state": "DRIVING",
"now": {
"driving": 1933,
"driving_remaining": 14267,
"driving_available": 16200,
"rest": 0
},
"today": {
"driving": 20048,
"driving_remaining": 15952,
"driving_available": 36000,
"shift": 32635,
"shift_start": 1588039020,
"shift_remaining": 21365,
"shift_available": 54000,
"daily_rest_start": 1588093020,
"daily_rest_min": 32400
},
"week": {
"driving": 55448,
"driving_remaining": 136492,
"driving_available": 191940,
"10h_driving_extensions_used": 1,
"10h_driving_extensions_remaining": 1,
"10h_driving_extensions_available": 2,
"9h_rest_shortening_used": 0,
"9h_rest_shortening_remaining": 3,
"9h_rest_shortening_available": 3,
"weekly_rest_remaining": 399005,
"weekly_rest_start": 1588470660,
"weekly_rest_min": 86400,
"previous_week_driving": 132060,
"next_fixed_week_driving_remaining": 201600,
"45_hour_rest": false,
"previous_week_45_hour_rest": true
},
"next_shift_start": 1588125420,
"next_shift_remaining": 53765,
"next_rest_min": 32400,
"driver_id": 1,
"driver_card_id": "LV10000012345000",
"driver_card_id_static": "LV100000123450",
"driver_name": "John",
"driver_surname": "Smith"
}
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "unit_id" parameter |
| 2 | Prediction disabled |
| 3 | Waiting for data update to calculate proper driving times |
| 4 | Drive time intervals cannot be processed |
| 1015 | Endpoint needs Tachograph remote download subscription |
GET https://mapon.com/api/v1/unit_data/nexogen.json{
"data": {
"12345": {
"driver1": {
"type": "ExtendedEC561",
"dataUpdatedAt": "2020-05-12T06:49:30Z",
"driverId": 1,
"driverCardId": "0000000001234001",
"driverCardIdStatic": "00000000012340",
"startOfOperationalDay": "2020-05-12T06:43:25Z",
"startOfOperationalWeek": "2020-05-12T06:43:25Z",
"lastRegularWeeklyRestSettlementWeek": "ThisWeek",
"lastEvent": {
"activity": "Drive",
"startedAt": "2020-05-12T06:43:25Z"
},
"totals": {
"drive": {
"continuous": "0:07",
"daily": "0:07",
"weekly": "0:07",
"fortnightly": "0:07"
},
"duty": {
"continuous": "0:07",
"daily": "0:07"
},
"restCompensation": {
"weekly": "0:00",
"total": "0:00"
},
"extendedDrives": 0,
"reducedDayRests": 0,
"splitDayRests": 0
},
"lastDownload": "2020-05-01T17:55:49Z"
}
},
"12346": {
"error": "Waiting for data update to calculate proper driving times"
},
"12347": {
"driver1": {
"type": "ExtendedEC561",
"dataUpdatedAt": "2020-05-12T06:49:30Z",
"driverId": 2,
"driverCardId": "RUD0000012345100",
"driverCardIdStatic": "RUD00000123451",
"startOfOperationalDay": "2020-05-11T06:04:00Z",
"startOfOperationalWeek": "2020-05-11T06:04:00Z",
"lastRegularWeeklyRestSettlementWeek": "PreviousWeek",
"lastEvent": {
"activity": "Rest",
"startedAt": "2020-05-11T14:58:47Z"
},
"totals": {
"drive": {
"continuous": "0:00",
"daily": "6:10",
"weekly": "6:10",
"fortnightly": "1.0:48"
},
"duty": {
"continuous": "0:00",
"daily": "6:17"
},
"restCompensation": {
"weekly": "0:00",
"total": "21:00"
},
"extendedDrives": 0,
"reducedDayRests": 0,
"splitDayRests": 0
},
"lastDownload": "2020-05-11T11:10:29Z"
}
}
}
}| Code | Description |
|---|---|
| 1 | Invalid unit_id parameter |
| 2 | Prediction disabled |
| 3 | Waiting for data update to calculate proper driving times |
| 4 | Drive time intervals cannot be processed |
| 5 | Getting all cars data disabled for current api key |
| 6 | No assigned drivers |
| 1015 | Endpoint needs Tachograph remote download subscription |
GET https://mapon.com/api/v1/unit_data/humidity.json{
"data": {
"units": [
{
"unit_id": 1,
"sensors": [
{
"no": 1,
"humidities": [
{
"gmt": "2017-04-01 12:21:17",
"value": 23
},
{
"gmt": "2017-04-01 12:23:17",
"value": 33.4
},
{
"gmt": "2017-04-01 12:26:30",
"value": 5
},
{
"gmt": "2017-04-01 12:28:30",
"value": 65.9
}
]
},
{
"no": 2,
"humidities": [
{
"gmt": "2017-04-01 12:19:17",
"value": 23.3
},
{
"gmt": "2017-04-01 12:21:17",
"value": 4.8
},
{
"gmt": "2017-04-01 12:23:17",
"value": 21.8
}
]
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/unit_groups/list.json{
"data": [
{
"id": 1,
"name": "Group name",
"parent_id": ""
}
]
}| Code | Description |
|---|---|
| 1 | Invalid unit_id parameter |
POST https://mapon.com/api/v1/unit_groups/save.json{
"data": {
"status": "successful",
"group_id": 1
}
}| Code | Description |
|---|---|
| 1 | Invalid name parameter |
| 2 | Invalid id parameter |
| 3 | Group cannot be parent of itself |
| 4 | Invalid parent_id parameter |
| 5 | Invalid group hierarchy. Group cannot be parent of itself |
POST https://mapon.com/api/v1/unit_groups/delete.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Invalid id parameter |
GET https://mapon.com/api/v1/unit_groups/list_units.json{
"data": {
"units": [
{
"id": 1
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid id parameter |
POST https://mapon.com/api/v1/unit_groups/attach_unit.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Invalid id parameter |
| 2 | Invalid unit_id parameter |
POST https://mapon.com/api/v1/unit_groups/detach_unit.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Invalid id parameter |
| 2 | Invalid unit_id parameter |
POST https://mapon.com/api/v1/unit_groups/clear_unit.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Invalid unit_id parameter |
GET https://mapon.com/api/v1/unit_commands/get_available.json{
"data": [
"open_doors",
"close_doors",
"open_trunk",
"open_windows",
"close_windows",
"hazard_lights"
]
}| Code | Description |
|---|---|
| 1 | Not specified or invalid unit_id parameter |
POST https://mapon.com/api/v1/unit_commands/execute.jsonstatus Possible values:ok,failed
{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Not specified or invalid unit_id parameter |
| 2 | Not specified or invalid command parameter |
GET https://mapon.com/api/v1/driver_groups/list.json{
"data": [
{
"id": 2,
"name": "Group name",
"parent_id": 1
}
]
}| Code | Description |
|---|---|
| 2 | Invalid driver parameter |
POST https://mapon.com/api/v1/driver_groups/save.json{
"data": {
"status": "successful",
"group_id": 1
}
}| Code | Description |
|---|---|
| 2 | Invalid id parameter |
| 3 | Group cannot be accessed |
| 4 | Missing name parameter |
| 5 | Group cannot be parent of itself |
| 6 | Parent group cannot be accessed |
| 7 | Invalid group hierarchy. Group cannot be parent of itself |
POST https://mapon.com/api/v1/driver_groups/delete.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Missing id parameter |
| 2 | Invalid id parameter |
| 3 | Group cannot be accessed |
GET https://mapon.com/api/v1/driver_groups/list_drivers.json{
"data": {
"drivers": [
{
"id": 1
}
]
}
}| Code | Description |
|---|---|
| 1 | Missing id parameter |
| 2 | Invalid id parameter |
| 3 | Group cannot be accessed |
POST https://mapon.com/api/v1/driver_groups/add_driver.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Missing id parameter |
| 2 | Invalid id parameter |
| 3 | Group cannot be accessed |
| 4 | Missing driver parameter |
| 5 | Invalid driver parameter |
POST https://mapon.com/api/v1/driver_groups/remove_driver.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Missing id parameter |
| 2 | Invalid id parameter |
| 3 | Group cannot be accessed |
| 4 | Missing driver parameter |
| 5 | Invalid driver parameter |
POST https://mapon.com/api/v1/driver_groups/clear_driver.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Missing driver parameter |
| 2 | Invalid driver parameter |
GET https://mapon.com/api/v1/route/list.jsonpolyline - encoded polyline (see Google Maps API Encoded Polyline Algorithm Format
and Geometry Library Encoding Methods on how to decode this data)speed - route velocity and time informationdecoded_route - list of coordinates together with time and speed (available only when requesting routes for one unit)driver_id - ID of the driver that was driving the car during the route. Will be 0 if no driver was registered for the route.countries - Each route will include array with time and distance in each driven countrycan - Each route will include array of start and end can dataroute_details - Extra route detailsstructured_addresses - Detailed address information. Available only for routes after 2019-07-17route_fields - custom route fields. Will be returned for routes with type "route". Contains values for fields:
client_title,invoice,custom_distance,selected_distance,
extra_passengers,extra_expenses,trailer. If field is not present, it had no value for the route.
business, private0 or 1.route_id, avg_speed, max_speed, polyline, speed, route_details, route_fieldskg/100km, then can -> total_fuel values are represented in KG, not in L
split_routes_on_border_crossing is set and the route is actually split into virtual parts for each country then the routes->start->address and routes->end->address fields will contain only ISO country code.
routes->start->address shows the country that the unit entered and routes->end->address shows the country the unit exited.
{
"data": {
"units": [
{
"unit_id": 1,
"routes": [
{
"type": "stop",
"route_id": 987988691,
"start": {
"time": "2013-03-12T15:07:06Z",
"address": "Carrer de Pujades, 55, 08005 Barcelona, Barcelona, Spain",
"address_structured": {
"country": "Spain",
"countryCode": "es",
"city": "Barcelona",
"postCode": "08005",
"street": "Carrer de Pujades",
"house": "55",
"district": "Barcelones",
"state": "Catalunya",
"region": "Barcelona"
},
"lat": 56.1368,
"lng": 24.8169
},
"end": {
"time": "2013-03-13T05:50:02Z"
}
},
{
"type": "route",
"route_id": 9785023147,
"start": {
"time": "2013-03-13T05:50:02Z",
"address": "Carrer de Pujades, 55, 08005 Barcelona, Barcelona, Spain",
"address_structured": {
"country": "Spain",
"countryCode": "es",
"city": "Barcelona",
"postCode": "08005",
"street": "Carrer de Pujades",
"house": "55",
"district": "Barcelones",
"state": "Catalunya",
"region": "Barcelona"
},
"lat": 56.1368,
"lng": 24.8169,
"can": {
"fuel_level": 13,
"service_distance": 13000,
"total_distance": 12131,
"total_fuel": 152,
"total_engine_hours": 2041
}
},
"end": {
"time": "2013-03-13T06:06:27Z",
"address": "Carrer de Pujades, 55, 08005 Barcelona, Barcelona, Spain",
"address_structured": {
"country": "Spain",
"countryCode": "es",
"city": "Barcelona",
"postCode": "08005",
"street": "Carrer de Pujades",
"house": "55",
"district": "Barcelones",
"state": "Catalunya",
"region": "Barcelona"
},
"lat": 56.9217,
"lng": 24.3145,
"can": {
"fuel_level": 13,
"service_distance": 13131,
"total_distance": 13131,
"total_fuel": 222,
"total_engine_hours": 2341
}
},
"avg_speed": 52,
"max_speed": 72,
"decoded_route": {
"points": [
{
"gmt": "2017-04-03T14:44:16Z",
"lat": 56.9259,
"lng": 24.0196,
"speed": 0
}
]
},
"distance": 15770,
"countries": [
{
"code": "RU",
"distance": 31546,
"time": 1324
},
{
"code": "LV",
"distance": 956461,
"time": 3536
}
],
"driver_id": 43722,
"route_details": {
"type": "new",
"group_id": "10",
"explanation": "Explanation",
"explanation_time": "2019-01-25 02:12:00"
},
"route_fields": {
"client_title": "Client company",
"invoice": "John Smith",
"custom_distance": "123",
"selected_distance": "111",
"extra_passengers": "0",
"extra_expenses": "1.2",
"trailer": "no"
}
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
| 6 | decoded_route parameter available only when requesting routes for one unit |
| 7 | Invalid or unknown driver_id parameter |
| 8 | Invalid or unknown route_types parameter |
| 9 | Failed to get period days |
GET https://mapon.com/api/v1/route/custom_fields.json{
"data": [
{
"route_id": 12345678,
"fields": {
"client_title": "Temparamente",
"extra_passengers": "1",
"type": "business",
"explanation": "Kalasdidu"
}
}
]
}| Code | Description |
|---|---|
| 1 | Maximum 100 routes per request |
GET https://mapon.com/api/v1/route/country_crossings.json{
"data": {
"units": [
{
"unit_id": 1,
"crossings": [
{
"to": {
"code": "LT",
"name": "Lithuania"
},
"gmt": "2019-06-25T12:28:15Z"
},
{
"from": {
"code": "LT",
"name": "Lithuania"
},
"to": {
"code": "PL",
"name": "Poland"
},
"gmt": "2019-06-26T21:13:16Z"
},
{
"from": {
"code": "PL",
"name": "Poland"
},
"to": {
"code": "DE",
"name": "Germany"
},
"gmt": "2019-06-27T18:38:57Z"
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/fuel/summary.jsonkg/100km, then all fuel values are represented in KG, not in L
{
"data": [
{
"unit_id": 1,
"fuel_consumption_measurement": "l\/100km",
"sensor": {
"start": 1213,
"end": 615,
"total_consumed": 589,
"fueled": 86,
"drained": -95,
"avg_consumption": 35.45855923867,
"avg_consumption_type": "km"
},
"can": {
"start": 1213,
"end": 615,
"total_consumed": 589,
"fueled": 86,
"drained": -95,
"avg_consumption": 35.45855923867,
"avg_consumption_type": "km"
}
}
]
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/fuel/changes.jsonkg/100km, then all fuel values are represented in KG, not in L
{
"data": [
{
"unit_id": 1,
"fuel_consumption_measurement": "l\/100km",
"sensor": [],
"can": [],
"number": "0000 AA"
},
{
"unit_id": 2,
"fuel_consumption_measurement": "l\/h",
"sensor": [
{
"fuel_change": 275,
"fuel_before": 528,
"lat": 53.8711,
"lng": 10.6511,
"gmt": "2016-03-15T09:29:33Z",
"driver": "Driver A",
"driver_id": 1,
"address": "Sch\u00f6nb\u00f6ckener Str. 61, 23556 L\u00fcbeck, Germany"
}
],
"can": [],
"number": "000 AAA"
},
{
"unit_id": 3,
"fuel_consumption_measurement": "kg\/100km",
"sensor": [],
"can": [
{
"fuel_change": -27,
"fuel_before": 938,
"lat": 55.4614,
"lng": 22.6956,
"gmt": "2016-03-15T04:05:20Z",
"driver": "Driver B",
"driver_id": 2,
"address": "E85, 60375, Lithuania"
}
],
"number": "000-000"
}
]
}| Code | Description |
|---|---|
| 1 | Invalid or unknown unit_id parameter |
| 2 | Invalid or missing from parameter |
| 3 | Invalid or missing till parameter |
| 4 | Invalid period |
| 5 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/fuel/data.jsonsensor - fuel levels from fuel rodscan - fuel levels from board computerflow - flow rate in time segmentkg/100km, then all fuel values are represented in KG, not in L
{
"data": {
"unit_id": 1234,
"fuel_consumption_measurement": "l\/100km",
"sensor": {
"total": {
"values": [
{
"gmt": "2019-03-14T13:25:32Z",
"value": 2098
},
{
"gmt": "2019-03-14T13:25:42Z",
"value": 2097
},
{
"gmt": "2019-03-14T13:31:00Z",
"value": 2058
},
{
"gmt": "2019-03-14T13:35:20Z",
"value": 2045
}
]
},
"tanks": [
{
"tank": 1,
"values": [
{
"gmt": "2019-03-14T13:25:32Z",
"value": 1049
},
{
"gmt": "2019-03-14T13:25:42Z",
"value": 1049
},
{
"gmt": "2019-03-14T13:31:00Z",
"value": 1029
},
{
"gmt": "2019-03-14T13:35:20Z",
"value": 1022
}
]
},
{
"tank": 2,
"values": [
{
"gmt": "2019-03-14T13:25:32Z",
"value": 1049
},
{
"gmt": "2019-03-14T13:25:42Z",
"value": 1048
},
{
"gmt": "2019-03-14T13:31:00Z",
"value": 1029
},
{
"gmt": "2019-03-14T13:35:20Z",
"value": 1023
}
]
}
]
},
"can": {
"values": [
{
"gmt": "2019-03-14T13:25:32Z",
"value": 2098
},
{
"gmt": "2019-03-14T13:25:42Z",
"value": 2097
},
{
"gmt": "2019-03-14T13:31:00Z",
"value": 2058
},
{
"gmt": "2019-03-14T13:35:20Z",
"value": 2045
}
]
},
"flow": {
"values": [
{
"gmt": "2019-03-14T13:25:42Z",
"value": 13.5
},
{
"gmt": "2019-03-14T13:31:00Z",
"value": 393
},
{
"gmt": "2019-03-14T13:32:51Z",
"value": 10.1
},
{
"gmt": "2019-03-14T13:35:20Z",
"value": 136
},
{
"gmt": "2019-03-14T13:35:26Z",
"value": 0
},
{
"gmt": "2019-03-14T13:35:30Z",
"value": 0
}
]
}
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "unit_id" parameter |
| 2 | Invalid or missing "from" parameter |
| 3 | Invalid or missing "till" parameter |
| 4 | "data_source" values not recognized, [data_source] unknown |
| 5 | Unit [unit_id] does not have [data_source] sensor attached |
| 6 | Invalid date and time period |
| 7 | Maximum allowed period between dates is 31 days |
| 8 | Error getting associated company |
| 9 | Error in [query_name] query |
GET https://mapon.com/api/v1/fuel_check/list.jsonodometer_gps and odometer_can values are returned in meterskg/100km value of liters is shown in KG, not in L{
"data": {
"checks": [
{
"id": 539742,
"unit_id": 42218,
"card_id": "1337",
"card_name": "Card number 1",
"gmt": "2018-07-24 13:00:00",
"check_no": "13389",
"fuel_station": "Gavana",
"fuel_type": "D",
"liters": "20.000000",
"total_sum": "120.000000",
"currency": "GBP",
"location": {
"place": "Example place address 1",
"coordinates": {
"lat": 57.81752,
"lng": 25.12883
},
"object": {
"id": 1,
"name": "Object 1"
}
},
"odometer_gps": 35074160,
"odometer_can": 35082530
},
{
"id": 539743,
"unit_id": 42218,
"card_id": "1338",
"card_name": "Card number 2",
"gmt": "2018-07-24 14:00:00",
"check_no": "1338",
"fuel_station": "Circ",
"fuel_type": "98",
"liters": "20.000000",
"total_sum": "120.000000",
"currency": "GBP",
"location": {
"place": "",
"coordinates": {
"lat": 0,
"lng": 0
},
"object": {
"id": null,
"name": null
}
},
"odometer_gps": 0,
"odometer_can": 0
}
]
}
}POST https://mapon.com/api/v1/fuel_check/add.jsonY-m-dTH:i:sD - Diesel95 - E9598 - E98100 - High octane fuelG - gasA - AdBlueL - agriculture fuelCNG - compressed natural gasEUR)id value 0 means that data was saved successfully, but wont be visible in the system until the corresponding integration fuel card is activated in the system
{
"data": {
"status": "successful",
"id": 539744
}
}| Code | Description |
|---|---|
| 1 | Failed to save fuel check - generic error when storing of fuel check data failed in unhandled manner |
| 3 | Invalid or missing "unit_id" parameter - used API key has no access to the provided unit_id parameter or it is malformed |
| 5 | Failed to save fuel card - generic error when fuel card data with provided card_id could not be saved |
| 6 | Data is not validated - generic validation error message for unsupported validation exceptions |
| 8 | Invalid car selected - no access to the provided unit_id |
| 9 | Invalid date - incorrect date format or invalid date value |
| 10 | Invalid fuel station - missing or invalid fuel_station parameter |
| 11 | Invalid fuel type - missing or unsupported fuel_type parameter |
| 12 | Invalid total amount - missing or invalid amount parameter |
| 13 | Invalid fuel volume - missing or invalid liters parameter |
| 14 | Invalid fuel card name - invalid card_name parameter |
| 15 | Invalid fuel check number - invalid check_no parameter |
| 16 | Invalid currency - unsupported currency parameter value |
| 17 | Missing or invalid "card_id" parameter - card_id parameter was not provided, but request was made with API key that is assigned to an integration |
| 18 | Integrations fuel card is disabled - fuel card with provided card_id parameter exists, but is deactivated - check can not be stored |
POST https://mapon.com/api/v1/fuel_check/edit.jsonunit_id parameter can be changed, and in some cases card_name as wellD - Diesel95 - E9598 - E98100 - High octane fuelG - gasA - AdBlueL - agriculture fuelCNG - compressed natural gasEUR){
"data": {
"status": "successful",
"id": 539744
}
}| Code | Description |
|---|---|
| 1 | Failed to save fuel check - generic error when storing of fuel check data failed in unhandled manner |
| 2 | This card already exists in the system - fuel card with the provided card_id parameter already exists |
| 3 | Invalid or missing "unit_id" parameter - used API key has no access to the provided unit_id parameter or it is malformed |
| 4 | The selected fuel card does not exist |
| 5 | Failed to save fuel card - generic error when fuel card data with provided card_id could not be saved |
| 6 | Data is not validated - generic validation error message for unsupported validation exceptions |
| 7 | Check does not exist in company OR Check belongs to a different integration - check with provided id parameter not found for the company or it exists, but was created by a different integration |
| 8 | Invalid car selected - no access to the provided unit_id |
| 9 | Invalid date - incorrect date format or invalid date value |
| 10 | Invalid fuel station - missing or invalid fuel_station parameter |
| 11 | Invalid fuel type - missing or unsupported fuel_type parameter |
| 12 | Invalid total amount - missing or invalid amount parameter |
| 13 | Invalid fuel volume - missing or invalid liters parameter |
| 14 | Invalid fuel card name - invalid card_name parameter |
| 15 | Invalid fuel check number - invalid check_no parameter |
| 16 | Invalid currency - unsupported currency parameter value |
| 17 | Invalid or unknown "id" parameter |
| 18 | Check does not exist |
POST https://mapon.com/api/v1/fuel_check/delete.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "id" parameter |
| 2 | Check not found |
| 3 | Check belongs to another integration |
| 4 | No access to the vehicle |
| 5 | Failed to delete check |
POST https://mapon.com/api/v1/fuel_check/add_card.json{
"data": {
"status": "successful",
"id": 40190
}
}| Code | Description |
|---|---|
| 1 | Invalid or missing "card_id" parameter |
| 2 | This card already exists in the system |
| 3 | Invalid or missing "unit_id" parameter |
| 5 | Failed to create fuel card |
POST https://mapon.com/api/v1/fuel_check/update_card.json{
"data": {
"status": "successful",
"id": 40190
}
}| Code | Description |
|---|---|
| 1 | Invalid or missing "card_id" parameter |
| 2 | This card already exists in the system |
| 3 | Invalid or missing "unit_id" parameter |
| 4 | The selected fuel card does not exist |
| 5 | Invalid or missing "id" parameter |
| 6 | Failed to update fuel card |
| 7 | Fuel card id number can not be changed for integration cards |
| 8 | Fuel card name change is not allowed for this integration |
POST https://mapon.com/api/v1/fuel_check/delete_card.json{
"data": {
"status": "successful"
}
}| Code | Description |
|---|---|
| 1 | Invalid or missing "id" parameter |
| 2 | No access to fuel card |
| 3 | Failed to delete fuel card |
GET https://mapon.com/api/v1/object/list.json{
"data": {
"objects": [
{
"id": 1,
"name": "Object Name",
"wkt": "POLYGON((56.927624872333446 24.018473625183105,56.92456859150492 24.018945693969727,56.92479108782985 24.023537635803223,56.927648291143406 24.022915363311768,56.927624872333446 24.018473625183105))",
"user_id": "1",
"group_id": "0",
"private": "N",
"updated": "2016-04-16T11:23:16Z",
"created": "2016-04-15T07:59:01Z",
"deleted": "Y",
"deleted_gmt": "2016-04-17T12:09:48Z"
}
]
}
}POST https://mapon.com/api/v1/object/save.jsonuser_id defined.{
"data": {
"status": "ok",
"id": 1
}
}| Code | Description |
|---|---|
| 1 | Invalid name parameter |
| 2 | Invalid wkt parameter |
| 3 | Invalid user_id parameter |
| 4 | Invalid group_id parameter |
| 5 | Invalid private parameter |
| 6 | Invalid wkt polygon. Check if polygon starts and end in same location. |
| 7 | Cannot change private option and user_id for existing object |
| 8 | Cannot create private object in public group and public object in private group |
| 9 | Cannot create private object without specifying user_id |
POST https://mapon.com/api/v1/object/delete.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Invalid id parameter |
GET https://mapon.com/api/v1/object/custom_fields.json{
"data": [
{
"id": 1,
"label": "Tyre size",
"type": "select",
"settings": {
"options": {
"5ae07f0120141": "R14",
"5ae07f012017a": "R15",
"5ae07f01201b2": "R16"
}
},
"value": "5ae07f012017a"
},
{
"id": 2,
"label": "Photo",
"type": "image",
"settings": [],
"value": "http:\/\/example.com?file.php?234sf23fsw"
},
{
"id": 3,
"label": "Trailer no.",
"type": "text",
"settings": [],
"value": "AAA 0000"
},
{
"id": 4,
"label": "datums",
"type": "date",
"settings": [],
"value": "1524661491"
},
{
"id": 5,
"label": "Video",
"type": "hyperlink",
"settings": [],
"value": "http:\/\/example.com\/aaa.mp4",
"title": "Test"
},
{
"id": 6,
"label": "Documents",
"type": "file",
"settings": [],
"value": null
}
]
}| Code | Description |
|---|---|
| 1 | Not specified id parameter |
| 2 | Access denied |
| 3 | Can't find unit with specified parameters |
| 4 | Invalid value or incorrect format for parameter id (int) |
POST https://mapon.com/api/v1/object/save_custom_fields_values.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Not specified "id" or/and "fields" parameter |
| 2 | API key does not have associated unit with specified parameters |
| 3 | Can't find object with specified parameters |
| 4 | Can't find fields with specified parameters |
| 5 | Fields with type hyperlink JSON string must contain title un value keys |
| 6 | Invalid field "{FIELD_NAME}" value. |
| 7 | File upload allowed only for fields with types: image, file |
| 8 | Fields with type {FIELD_TYPE} Allowed formats: {ALLOWED_FORMATS} |
| 9 | Invalid value or incorrect format for parameter id (int) |
GET https://mapon.com/api/v1/object/list_groups.json{
"data": {
"groups": [
{
"id": 1,
"name": "Group name",
"user_id": "0",
"private": "N",
"color": "FF0000"
}
]
}
}POST https://mapon.com/api/v1/object/save_group.json{
"data": {
"status": "ok",
"id": 1
}
}| Code | Description |
|---|---|
| 1 | Invalid "name" parameter. |
| 2 | Invalid "color" parameter. |
| 3 | Invalid "user_id" parameter. |
| 4 | Invalid "private" parameter. Possible values ["Y"|"N"]. |
| 5 | Cannot change private option and user_id for existing object group |
| 6 | Cannot create private object group without specifying user_id |
POST https://mapon.com/api/v1/object/delete_group.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Invalid "id" parameter. |
| 2 | Group not found. |
| 3 | Can not delete group! Group has object. |
POST https://mapon.com/api/v1/user/create.jsonuser_all,user)1 and 01 and 0 (Default: 0){
"id": 1,
"password": "pA151abZ"
}POST https://mapon.com/api/v1/user/update.jsonuser_all,user)1 and 0blocked is 1{
"status": "successful"
}| Code | Description |
|---|---|
| 1 | Invalid or unknown user_id parameter |
| 2 | Invalid phone parameter |
| 3 | Email is already in use |
POST https://mapon.com/api/v1/user/change_password.json{
"status": "successful"
}| Code | Description |
|---|---|
| 1 | Invalid or unknown user_id parameter |
| 2 | Password does not fulfill complexity requirements. Accompanied by a message that explains which rule check failed |
| 3 | Password is the same as the current users password |
| 4 | No access to user with id user_id |
POST https://mapon.com/api/v1/user/delete.json{
"status": "successful"
}| Code | Description |
|---|---|
| 1 | Invalid user_id parameter |
GET https://mapon.com/api/v1/user/list.json{
"data": {
"users": [
{
"id": "1",
"email": "example@domain.com",
"name": "John",
"surname": "Smith",
"preset": {
"id": 1,
"title": "Preset X",
"is_custom": false
},
"timezone": "Europe\/Riga",
"language": "lv",
"phone": "00000000",
"type": "driver",
"blocked": "N",
"blocked_text_fe": "",
"last_login": "2016-08-11 14:54:56",
"created": "2016-08-10 12:50:56",
"application_fields": [
{
"id": 1,
"application_id": 1,
"level": "driver",
"type": "text",
"title": "Text title",
"title_translation": null,
"unique_per_company": false,
"value": "xx",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T09:00:00Z"
}
]
}
]
}
}GET https://mapon.com/api/v1/device/sms_history.json{
"data": [
[
[
{
"phone": "123456789",
"response": "Data Link: 1 GPRS: 1 Phone: 0 SIM: 0 LAC: 3",
"received_at": "2017-04-06 10:21:03"
},
{
"phone": "123456789",
"response": "Param ID:2004 New Val:1234",
"received_at": "2017-04-06 10:25:59"
}
]
]
]
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "id" parameter |
| 2 | API key does not have any units associated |
GET https://mapon.com/api/v1/device/get_commands.json{
"data": {
"status": "ok",
"commands": [
{
"command": "command_name",
"params": {
"param1": null,
"param2": "test"
}
},
{
"command": "another_command_name",
"params": {
"param3": null,
"param4": "test"
}
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "device_id" parameter |
| 2 | API key does not have any units associated |
| 3 | Invalid or unknown "transport" parameter |
| 4 | SMS/TCP Commands not available |
POST https://mapon.com/api/v1/device/send_sms_command.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "device_id" parameter |
| 2 | Invalid or unknown "command" parameter |
| 3 | API key does not have any units associated |
| 4 | Device does not support this SMS command |
| 5 | Invalid "params" parameter |
| 6 | SMS Command not available |
| 7 | Could not execute command |
POST https://mapon.com/api/v1/device/send_tcp_command.json{
"data": {
"status": "ok",
"result": "Version 1.0.0"
}
}| Code | Description |
|---|---|
| 1 | Invalid or unknown "device_id" parameter |
| 2 | Invalid or unknown "command" parameter |
| 3 | API key does not have any units associated |
| 4 | Device does not support this SMS command |
| 5 | Invalid "params" parameter |
| 6 | SMS Command not available |
| 7 | Could not execute command |
GET https://mapon.com/api/v1/device/list.json0,1 If set to 1, only devices that are installed on vehicles will be returned{
"data": {
"devices": [
{
"box_id": 163129,
"unit_id": null,
"model": "G-BOX",
"model_ver": "",
"installed": false,
"imei": "",
"serial": "",
"phone": "12345678"
},
{
"box_id": 1219190,
"unit_id": 99799,
"model": "QUECLINK",
"model_ver": "GV500",
"installed": true,
"imei": "531207365827640",
"serial": "",
"phone": "12345678"
},
{
"box_id": 25166049,
"unit_id": 121651,
"model": "YEPZON",
"model_ver": "",
"installed": true,
"imei": "",
"serial": "DSGH-GIFR-FYP9",
"phone": "12345678"
},
{
"box_id": 26016924,
"unit_id": 116168,
"model": "RUPTELA",
"model_ver": "TCO4",
"installed": true,
"imei": "518992226807892",
"serial": "",
"phone": ""
},
{
"box_id": 26046442,
"unit_id": 117660,
"model": "TELTONIKA",
"model_ver": "FMB640",
"installed": true,
"imei": "518992226807892",
"serial": "1110863003",
"phone": ""
},
{
"box_id": 315355,
"unit_id": 118416,
"model": "G-BOX2_MINI",
"model_ver": "",
"installed": true,
"imei": "309964817321180",
"serial": "302571",
"phone": ""
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid "box_id" parameter (non-integer value) |
| 2 | Invalid "model" parameter (model not supported by system) |
| 3 | Parameter "model" is required with parameter "model_ver" |
| 4 | Invalid "model_ver" paramter (model version does not exist for selected model) |
| 5 | Invalid "imei" parameter |
| 6 | Invalid "serial" parameter |
GET https://mapon.com/api/v1/device/models.json1 and 0{
"data": {
"TELTONIKA": {
"model": "TELTONIKA",
"title": "TELTONIKA",
"display_id": "sn",
"versions": {
"FM6300": "FM63",
"FM6320": "FM6320",
"FM5300": "FM53",
"FM4200": "FM42",
"FM4100": "FM41",
"FM3600": "FM3600",
"FM3602": "FM3602",
"FM3612": "FM3612",
"FM36M1": "FM36M1",
"FM3622": "FM3622",
"FM3300": "FM33",
"FM3200": "FM32",
"FM3001": "FM3001",
"FM2200": "FM22",
"FM2100": "FM21",
"FM1200": "FM12",
"FM1100": "FM11",
"FM1000": "FM10",
"FMA110": "FMA110",
"FMA120": "FMA120",
"FMA202": "FMA202",
"FMA204": "FMA204",
"FMB001": "FMB001",
"FMB003": "FMB003",
"FMB010": "FMB010",
"FMB110": "FMB110",
"FMB120": "FMB120",
"FMB122": "FMB122",
"FMB125": "FMB125",
"FMB202": "FMB202",
"FMB204": "FMB204",
"FMB640": "FMB640",
"FMB920": "FMB920",
"FMB630": "FMB630",
"GH4000": "GH40",
"FMT100": "FMT100",
"CM2400": "CM2400",
"TMT250": "TMT250",
"TSM232": "TSM232",
"RUT850": "RUT850"
},
"required_fields": [
"imei",
"sn",
"model_ver"
],
"additional_fields": [
"firmware"
],
"custom_fields": [
{
"name": "drop_data_if_no_power",
"type": "select",
"model_ver": "",
"options": [
"no",
"yes"
],
"value": ""
},
{
"name": "password",
"type": "text",
"model_ver": "",
"options": [],
"value": ""
},
{
"name": "username",
"type": "text",
"model_ver": "",
"options": [],
"value": ""
}
]
},
"QUECLINK": {
"model": "QUECLINK",
"title": "QUECLINK",
"display_id": "imei",
"versions": {
"GV55": "GV55",
"GV65": "GV65",
"GV65PLUS": "GV65PLUS",
"GV75": "GV75",
"GV200": "GV200",
"GV300": "GV300",
"GL100": "GL100",
"GL200": "GL200",
"GL300": "GL300",
"GL300W": "GL300W",
"GL300M": "GL300M",
"GL500": "GL500",
"GL505": "GL505",
"GL520": "GL520",
"GL5053": "GL505-3",
"GV500": "GV500",
"GV600W": "GV600W",
"GMT100": "GMT100",
"GMT200": "GMT200",
"GS100": "GS100",
"GT200": "GT200",
"GT301": "GT301",
"GB100": "GB100"
},
"required_fields": [
"imei",
"model_ver"
],
"additional_fields": [],
"custom_fields": []
},
"WEBTECH": {
"model": "WEBTECH",
"title": "WEBTECH",
"display_id": "imei",
"versions": [],
"required_fields": [
"imei"
],
"additional_fields": [],
"custom_fields": []
},
"GOSAFE": {
"model": "GOSAFE",
"title": "Gosafe",
"display_id": "imei",
"versions": [],
"required_fields": [
"imei"
],
"additional_fields": [],
"custom_fields": []
},
"DMT": {
"model": "DMT",
"title": "DMT",
"display_id": "imei",
"versions": [],
"required_fields": [
"imei"
],
"additional_fields": [],
"custom_fields": []
},
"MOBILE": {
"model": "MOBILE",
"title": "Phone Tracking App",
"display_id": "imei",
"versions": [],
"required_fields": [],
"additional_fields": [],
"custom_fields": []
},
"RUPTELA": {
"model": "RUPTELA",
"title": "Ruptela",
"display_id": "imei",
"versions": {
"ECO3": "ECO3",
"ECO4": "ECO4",
"PRO3": "PRO3",
"TCO3": "TCO3",
"TCO4": "TCO4",
"PLUG4": "PLUG4"
},
"required_fields": [
"imei",
"model_ver"
],
"additional_fields": [],
"custom_fields": []
},
"MEITRACK": {
"model": "MEITRACK",
"title": "Meitrack",
"display_id": "imei",
"versions": {
"MVT100": "MVT100",
"MVT340": "MVT340",
"MVT380": "MVT380",
"MVT600": "MVT600",
"MVT800": "MVT800",
"T355G": "T355G",
"T366G": "T366G",
"TC68S": "TC68S",
"MT90": "MT90"
},
"required_fields": [
"imei",
"model_ver"
],
"additional_fields": [],
"custom_fields": [
{
"name": "password",
"type": "text",
"model_ver": "",
"options": [],
"value": ""
}
]
},
"CALAMP": {
"model": "CALAMP",
"title": "CalAmp",
"display_id": "id",
"versions": [],
"required_fields": [
"imei"
],
"additional_fields": [],
"custom_fields": []
},
"LEVEL": {
"model": "LEVEL",
"title": "Level",
"display_id": "sn",
"versions": {
"GC75": "GC 75",
"GC092034": "GC 092 034",
"GC092044": "GC 092 044",
"GC092232": "GC 092 232",
"GC092242": "GC 092 242",
"GC092245": "GC 092 245",
"GC092542": "GC 092 542",
"GC095253": "GC 095 253",
"GC095": "GC 095"
},
"required_fields": [
"sn",
"model_ver"
],
"additional_fields": [],
"custom_fields": [
{
"name": "ciphered",
"type": "text",
"model_ver": "",
"options": [],
"value": 0
},
{
"name": "enc_key",
"type": "text",
"model_ver": "",
"options": [],
"value": ""
},
{
"name": "packed_records",
"type": "text",
"model_ver": "",
"options": [],
"value": 1
}
]
},
"COBAN": {
"model": "COBAN",
"title": "Coban",
"display_id": "imei",
"versions": [],
"required_fields": [
"imei"
],
"additional_fields": [],
"custom_fields": []
},
"TKSTAR": {
"model": "TKSTAR",
"title": "TKStar",
"display_id": "id",
"versions": {
"TK1000": "TK1000"
},
"required_fields": [
"model_ver"
],
"additional_fields": [],
"custom_fields": []
},
"DEFENSTAR": {
"model": "DEFENSTAR",
"title": "Defenstar",
"display_id": "imei",
"versions": {
"GPS668": "GPS668"
},
"required_fields": [
"model_ver"
],
"additional_fields": [],
"custom_fields": []
},
"CONCOX": {
"model": "CONCOX",
"title": "Concox",
"display_id": "imei",
"versions": {
"MT200": "MT200",
"ET200": "ET200",
"GT710": "GT710",
"QBIT": "QBIT",
"AT3": "AT3",
"GV20": "GV20",
"AT4": "AT4"
},
"required_fields": [
"imei",
"model_ver"
],
"additional_fields": [],
"custom_fields": [
{
"name": "timezone",
"type": "select_timezone",
"model_ver": "",
"options": [],
"value": ""
}
]
},
"CELLOCATOR": {
"model": "CELLOCATOR",
"title": "Cellocator",
"display_id": "sn",
"versions": {
"IQ": "Cello IQ",
"CANIQ": "Cello CANiQ"
},
"required_fields": [
"model_ver"
],
"additional_fields": [],
"custom_fields": []
},
"TOPFLY_ORIGINAL": {
"model": "TOPFLY_ORIGINAL",
"title": "TopFly",
"display_id": "imei",
"versions": {
"T8603": "T8603",
"T8803-PRO": "T8803-PRO",
"T8803+": "T8803+",
"T8806": "T8806",
"T8808-A": "T8808-A",
"T8808-B": "T8808-B",
"T8808+": "T8808+",
"TLW1": "TLW1",
"TLD1": "TLD1",
"TLP1": "TLP1"
},
"required_fields": [
"imei",
"model_ver"
],
"additional_fields": [],
"custom_fields": [
{
"name": "password",
"type": "text",
"model_ver": "",
"options": [],
"value": ""
}
]
},
"DIGITAL_SYSTEMS": {
"model": "DIGITAL_SYSTEMS",
"title": "Digital Systems",
"display_id": "sn",
"versions": {
"DSF10": "DSF10",
"DSF21": "DSF21",
"DSF22": "DSF22"
},
"required_fields": [
"sn",
"model_ver"
],
"additional_fields": [],
"custom_fields": []
},
"HUABAO": {
"model": "HUABAO",
"title": "HUABAO",
"display_id": "imei",
"versions": {
"A5E": "A5E"
},
"required_fields": [
"imei",
"sn",
"model_ver"
],
"additional_fields": [],
"custom_fields": []
},
"SUNTECH": {
"model": "SUNTECH",
"title": "SUNTECH",
"display_id": "imei",
"versions": [],
"required_fields": [
"imei"
],
"additional_fields": [],
"custom_fields": []
},
"APLICOM": {
"model": "APLICOM",
"title": "Aplicom",
"display_id": "imei",
"versions": {
"A9": "A9"
},
"required_fields": [
"imei",
"model_ver"
],
"additional_fields": [],
"custom_fields": []
},
"HUA_SHENG": {
"model": "HUA_SHENG",
"title": "Hua Sheng Telematics",
"display_id": "imei",
"versions": [],
"required_fields": [],
"additional_fields": [],
"custom_fields": []
},
"ULBOTECH": {
"model": "ULBOTECH",
"title": "UlboTech",
"display_id": "id",
"versions": [],
"required_fields": [],
"additional_fields": [],
"custom_fields": []
},
"JOINTECH": {
"model": "JOINTECH",
"title": "Jointech",
"display_id": "sn",
"versions": {
"JT701": "JT701"
},
"required_fields": [
"model_ver"
],
"additional_fields": [],
"custom_fields": []
}
}
}POST https://mapon.com/api/v1/device/create.json{
"data": {
"status": "ok",
"box_id": 1
}
}| Code | Description |
|---|---|
| 1 | Failed to create box |
| 2 | Invalid or unknown "model" parameter |
| 3 | Invalid or unknown "model_ver" parameter |
| 4 | Missing a required field value |
| 5 | Invalid "imei" parameter |
| 6 | Invalid "sn" parameter |
| 7 | Invalid "sim" parameter |
| 8 | Unsupported field |
| 9 | Generic field validation error |
| 10 | Custom field validation error |
POST https://mapon.com/api/v1/driver/create.json1 and 0access_all_units is 1access_all_units is 11 and 0{
"id": 1,
"password": "password123"
}| Code | Description |
|---|---|
| 1 | Missing name parameter |
| 2 | Missing surname parameter |
| 3 | Email is already in use |
POST https://mapon.com/api/v1/driver/update.json1 and 01 and 01 and 0blocked is 11 and 0access_all_units is 1. Pass empty value to remove previously allowed units.access_all_units is 1. Pass empty value to remove previously allowed unit groups.{
"status": "successful"
}| Code | Description |
|---|---|
| 1 | Invalid driver_id parameter |
| 2 | Email is already in use |
| 3 | Invalid phone parameter |
POST https://mapon.com/api/v1/driver/change_password.json{
"status": "successful"
}| Code | Description |
|---|---|
| 1 | Invalid or unknown driver_id parameter |
| 2 | Password does not fulfill complexity requirements. Accompanied by a message that explains which rule check failed |
| 3 | Password is the same as the current drivers password |
| 4 | No access to driver with id driver_id |
POST https://mapon.com/api/v1/driver/delete.json{
"status": "successful"
}GET https://mapon.com/api/v1/driver/list.jsonfields - return driver custom field values{
"data": {
"drivers": [
{
"id": 19867,
"name": "Janis",
"surname": "Berzins",
"email": "test@test.lv",
"phone": "+37112345678",
"language": "en",
"ibutton": "",
"tacho": "",
"access_to_route_sheet": 1,
"blocked": false,
"blocked_text_fe": "",
"created": "2016-08-10 12:50:56",
"fields": {
"95451": "111"
},
"application_fields": [
{
"id": 1,
"application_id": 1,
"level": "driver",
"type": "text",
"title": "Text title",
"title_translation": null,
"unique_per_company": false,
"value": "xx",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T09:00:00Z"
}
]
}
]
}
}GET https://mapon.com/api/v1/driver/list_unit_groups.json{
"data": [
{
"id": 123,
"name": "Group 123",
"parent_id": 12
}
]
}| Code | Description |
|---|---|
| 1 | Invalid "id" parameter |
| 2 | Driver not found |
GET https://mapon.com/api/v1/driver/custom_fields.json{
"data": {
"drivers": [
{
"id": 5021,
"fields": [
{
"id": 1496512,
"label": "CF text",
"type": "text",
"settings": [],
"value": "John"
},
{
"id": 1500649,
"label": "CF date",
"type": "date",
"settings": [],
"value": 1609417794
},
{
"id": 1500650,
"label": "CF file",
"type": "file",
"settings": [],
"value": "https:\/\/example.com\/2574322"
},
{
"id": 1500651,
"label": "CF link",
"type": "hyperlink",
"settings": [],
"value": "https:\/\/www.lipsum.com\/",
"title": "Lorem"
},
{
"id": 1500652,
"label": "CF image",
"type": "image",
"settings": [],
"value": "https:\/\/example.com\/2574323"
},
{
"id": 1500653,
"label": "CF select",
"type": "select",
"settings": {
"options": {
"5ff6fe6bc6224": "true",
"5ff6fe6bc6227": "false"
}
},
"value": "5ff6fe6bc6224"
}
]
},
{
"id": 87359,
"fields": [
{
"id": 1496512,
"label": "CF text",
"type": "text",
"settings": [],
"value": "Gun"
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | Not specified ids parameter |
| 2 | API key does not have associated driver with specified parameters |
POST https://mapon.com/api/v1/driver/save_custom_fields.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Not specified "id" parameter |
| 2 | Driver not found |
| 3 | Missing "columns" parameter |
| 4 | Not specified "column id" parameter |
| 5 | Column with id "{column id}" not found |
| 6 | Missing "type" parameter. |
| 7 | Missing "label" parameter |
POST https://mapon.com/api/v1/driver/delete_custom_fields.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Not specified "id" parameter |
| 2 | Driver not found |
| 3 | Not specified "columnIds" parameter |
| 4 | Column with id "{columnId}" not found |
POST https://mapon.com/api/v1/driver/save_custom_fields_values.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Not specified "id" or/and "fields" parameter |
| 2 | Driver not found |
| 3 | Invalid value or incorrect format for parameter id (int) |
| 4 | Can't find fields with specified parameters |
| 5 | Fields with type hyperlink JSON string must contain title and value keys |
| 6 | Invalid field "{FIELD_NAME}" value. |
| 7 | File upload allowed only for fields with types: image, file |
| 8 | Fields with type {FIELD_TYPE} Allowed formats: {ALLOWED_FORMATS} |
GET https://mapon.com/api/v1/driver/daily_activities.jsonBETA VERSION This end-point is fully usable but there might be issues. Please contact client support if you encounter any problems.
YYYY-MM-DD 12:00:00 - YYYY-MM-DD 20:00:00, the data will be returned for period YYYY-MM-DD 00:00:00 - YYYY-MM-DD 23:59:59 instead. UTC datetime string in Y-m-dTH:i:sZ formatUTC datetime string in Y-m-dTH:i:sZ formatcard_events - include information about driver card insertion / removal eventswork_place_events - include information about events when driver has started / finished a work periodday - datetime value of the start of the daysummary - all values are total durations in secondsactivities - array of activity objectsactivity object structure:start - timestampend - timestampduration - secondsstatus - status value. Possible values: DRIVING, REST, WORK, AVAILABLE, CARD_INSERTED, CARD_REMOVED, WORK_PERIOD_STARTED, WORK_PERIOD_FINISHEDsource - activity source identifier. Possible values: ddd - driver tachograph file, can - data obtained via device CAN connection or unkn - unknown data source. Appears only when available data does not cover the whole selected time period. In such cases gaps are filled with REST activitiesunitId - id of the vehicle to which driver was assigned during the activity[
{
"day": "2023-07-02 00:00:00",
"summary": {
"shift": 0,
"driving": 0,
"rest": 86399
},
"activities": [
{
"start": 1688245200,
"end": 1688331599,
"duration": 86399,
"status": "REST",
"source": "ddd",
"unitId": 424168
}
]
},
{
"day": "2023-07-03 00:00:00",
"summary": {
"shift": 23160,
"driving": 14640,
"rest": 31080
},
"activities": [
{
"start": 1688331600,
"end": 1688356920,
"duration": 25320,
"status": "REST",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688356920,
"end": 1688356920,
"duration": 0,
"status": "CARD_INSERTED",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688356920,
"end": 1688357940,
"duration": 1020,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688357940,
"end": 1688358000,
"duration": 60,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688358000,
"end": 1688358420,
"duration": 420,
"status": "REST",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688358420,
"end": 1688358720,
"duration": 300,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688358720,
"end": 1688358900,
"duration": 180,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688358900,
"end": 1688359320,
"duration": 420,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688359320,
"end": 1688359380,
"duration": 60,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688359380,
"end": 1688359500,
"duration": 120,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688359500,
"end": 1688359620,
"duration": 120,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688359620,
"end": 1688360100,
"duration": 480,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688360100,
"end": 1688363460,
"duration": 3360,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688363460,
"end": 1688363640,
"duration": 180,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688363640,
"end": 1688363700,
"duration": 60,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688363700,
"end": 1688364660,
"duration": 960,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688364660,
"end": 1688364720,
"duration": 60,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688364720,
"end": 1688366580,
"duration": 1860,
"status": "REST",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688366580,
"end": 1688366700,
"duration": 120,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688366700,
"end": 1688367780,
"duration": 1080,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688367780,
"end": 1688371020,
"duration": 3240,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688371020,
"end": 1688371440,
"duration": 420,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688371440,
"end": 1688371500,
"duration": 60,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688371500,
"end": 1688371920,
"duration": 420,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688371920,
"end": 1688372040,
"duration": 120,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688372040,
"end": 1688372700,
"duration": 660,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688372700,
"end": 1688372760,
"duration": 60,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688372760,
"end": 1688372880,
"duration": 120,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688372880,
"end": 1688375460,
"duration": 2580,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688375460,
"end": 1688375640,
"duration": 180,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688375640,
"end": 1688376360,
"duration": 720,
"status": "REST",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688376360,
"end": 1688376960,
"duration": 600,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688376960,
"end": 1688377080,
"duration": 120,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688377080,
"end": 1688377320,
"duration": 240,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688377320,
"end": 1688378160,
"duration": 840,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688378160,
"end": 1688378220,
"duration": 60,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688378220,
"end": 1688380980,
"duration": 2760,
"status": "REST",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688380980,
"end": 1688381400,
"duration": 420,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688381400,
"end": 1688381520,
"duration": 120,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688381520,
"end": 1688384400,
"duration": 2880,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688384400,
"end": 1688384880,
"duration": 480,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688384880,
"end": 1688385060,
"duration": 180,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688385060,
"end": 1688385240,
"duration": 180,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688385240,
"end": 1688385300,
"duration": 60,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688385300,
"end": 1688385720,
"duration": 420,
"status": "WORK",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688385720,
"end": 1688385840,
"duration": 120,
"status": "DRIVING",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688385840,
"end": 1688385840,
"duration": 0,
"status": "CARD_REMOVED",
"source": "ddd",
"unitId": 424168
},
{
"start": 1688385840,
"end": 1688421599,
"duration": 0,
"status": "REST",
"source": "ddd",
"unitId": 424168
}
]
}
]| Code | Description |
|---|---|
| 1 | Invalid or missing driver parameter |
| 2 | Invalid parameter from |
| 3 | Invalid parameter till |
| 4 | Invalid period |
| 5 | Invalid period days |
| 6 | Invalid period length (max 31d) |
| 7 | Invalid include |
GET https://mapon.com/api/v1/reefer/alert_list.json{
"data": {
"alerts": [
{
"alert_id": 1,
"car_id": 1,
"settings": {
"runmode": "1",
"setpoint_temp": "5",
"over_setpoint_temp": "3",
"under_setpoint_temp": "3",
"gmt_from": "2016-03-31T09:27:00Z",
"gmt_to": "2016-04-30T09:27:00Z",
"user_id": "1",
"compartment": "0",
"cargo_cooling": 0,
"cargo_cooling_range": 0,
"channels": [
"sms"
],
"notes": ""
},
"last_data_gmt": "2016-04-11 10:29:10",
"current_flags": "1",
"current_flags_gmt": "2016-04-09 16:17:02",
"current_runmode": "1",
"current_runmode_gmt": "2016-04-09 16:01:54",
"current_setpoint_temp": 11.6,
"current_setpoint_temp_gmt": "2016-04-03 17:28:49",
"current_return_temp": 13.9,
"current_return_temp_gmt": "2016-04-09 16:16:42",
"current_compartment_state": "off",
"current_compartment_state_gmt": "2016-04-09 16:17:02"
}
]
}
}POST https://mapon.com/api/v1/reefer/set_alert.json{
"data": {
"status": "ok",
"alertId": 1
}
}| Code | Description |
|---|---|
| 1 | Incorrect "runmode" parameter. |
| 2 | Incorrect "setpoint" parameter. |
| 3 | Incorrect "under_setpoint" parameter. |
| 4 | Incorrect "over_setpoint" parameter. |
| 5 | Invalid or missing "from" parameter. Time example: 2013-02-13T12:17:21Z. |
| 6 | Invalid or missing "to" parameter. Time example: 2013-02-13T12:17:21Z. |
| 7 | Invalid or missing "user_id" parameter. |
| 8 | Invalid or missing "unit_id" parameter. |
| 9 | Invalid or missing "compartment" parameter. |
| 10 | Invalid or missing "channels" parameter. |
| 11 | Invalid "channels" parameter. |
| 12 | Invalid cargo cooling range. Range from 2-7 degrees C. |
POST https://mapon.com/api/v1/reefer/alert_delete.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 6 | Invalid or missing "alert_id" parameter. |
| 12 | Cannot find carrier alert with id. |
POST https://mapon.com/api/v1/reefer/alert_change_user.json{
"data": {
"status": "ok",
"alertId": 1
}
}| Code | Description |
|---|---|
| 6 | Invalid or missing "alert_id" parameter. |
| 7 | Invalid or missing "old_user" parameter. |
| 8 | Invalid or missing "new_user" parameter. |
| 12 | Cannot find carrier alert with defined parameters. |
POST https://mapon.com/api/v1/reefer/change_setpoint.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | API key does not have associated unit with specified parameters |
| 2 | Incorrect "setpoint" parameter. |
| 3 | Refrigerator does not support 2way communication |
| 4 | Cannot find sender for unit with specified parameters |
| 8 | Invalid or missing "unit_id" parameter. |
| 9 | Invalid or missing "compartment" parameter. |
GET https://mapon.com/api/v1/reefer/runmodes.json{
"data": {
"runmodes": [
{
"unit_id": "1",
"current": {
"id": 1,
"name": "Continuous"
},
"supported": [
{
"id": 1,
"name": "Continuous"
},
{
"id": 2,
"name": "Cycle Sentry"
}
]
}
]
}
}| Code | Description |
|---|---|
| 1 | API key does not have associated unit with specified parameters |
POST https://mapon.com/api/v1/reefer/change_runmode.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | API key does not have associated unit with specified parameters |
| 3 | Refrigerator does not support 2way communication |
| 4 | Cannot find sender for unit with specified parameters |
| 5 | Incorrect "runmode" parameter. |
| 8 | Invalid or missing "unit_id" parameter. |
GET https://mapon.com/api/v1/reefer/list_temperature_data.json{
"data": {
"units": [
{
"unit_id": 1,
"temperatures": {
"supply": {
"compartment_0": [
{
"temperature": 8.2,
"gmt": "2017-03-07 16:26:31"
},
{
"temperature": 7.4,
"gmt": "2017-03-07 16:27:55"
},
{
"temperature": 6,
"gmt": "2017-03-07 16:28:12"
},
{
"temperature": -0.8,
"gmt": "2017-03-07 16:29:43"
},
{
"temperature": -7.3,
"gmt": "2017-03-07 16:33:21"
},
{
"temperature": -0.8,
"gmt": "2017-03-07 16:35:50"
}
]
},
"return": {
"compartment_0": [
{
"temperature": 7.5,
"gmt": "2017-03-07 16:26:31"
},
{
"temperature": 7.6,
"gmt": "2017-03-07 16:27:55"
},
{
"temperature": 7.5,
"gmt": "2017-03-07 16:28:12"
},
{
"temperature": 6.4,
"gmt": "2017-03-07 16:29:43"
},
{
"temperature": 1.7,
"gmt": "2017-03-07 16:33:21"
},
{
"temperature": 1,
"gmt": "2017-03-07 16:35:50"
}
]
},
"setpoint": {
"compartment_0": [
{
"temperature": 2,
"gmt": "2017-03-07 16:28:12"
}
]
}
}
}
]
}
}| Code | Description |
|---|---|
| 1 | API key does not have associated unit with specified parameters |
| 2 | Invalid or missing "unit_id" parameter. |
| 3 | Invalid or missing "from" parameter. Time example: 2013-02-13T12:17:21Z. |
| 4 | Invalid or missing "till" parameter. Time example: 2013-02-13T12:17:21Z. |
| 5 | Invalid period |
| 6 | Period can not exceed 31 days |
GET https://mapon.com/api/v1/reefer/historic_point.json2020-05-26T15:00:00Zprevious,nearest. previous looks for the last data entry before the specified datetime. nearest looks for the nearest data entry (by time) to the specified datetime. In both cases ONLY values within 1 day of the specified datetime are returned.datetime, then the corresponding response key will contain an empty array. mode does not have a run sub-key, then there was no data for the sub-category at the selected datetime.state and temperature data are further grouped by compartment ID.{
"data": {
"refrigerator_type": "CARRIER",
"refrigerator_compartment_count": "1",
"refrigerator_communication_type": "1",
"flags": {
"value": 7,
"gmt": "2020-05-26T14:16:17Z"
},
"hours": {
"standby": {
"value": 17750,
"gmt": "2020-05-26T14:31:55Z"
},
"diesel": {
"value": 14236,
"gmt": "2020-05-26T13:27:22Z"
},
"electric": {
"value": 435,
"gmt": "2020-05-26T12:02:32Z"
}
},
"mode": {
"run": {
"value": 1,
"gmt": "2020-05-26T14:16:20Z"
},
"speed": {
"value": 1,
"gmt": "2020-05-26T14:21:28Z"
},
"power": {
"value": 1,
"gmt": "2020-05-26T14:20:39Z"
}
},
"state": {
"compartment_0": {
"value": "on",
"gmt": "2020-05-26T14:16:18Z"
}
},
"temperature": {
"compartment_0": {
"supply": {
"value": -18.9,
"gmt": "2020-05-26T14:59:56Z"
},
"return": {
"value": -11.3,
"gmt": "2020-05-26T14:59:56Z"
},
"setpoint": {
"value": -22,
"gmt": "2020-05-26T12:02:32Z"
},
"cargowatch_ambient": {
"value": 30.1,
"gmt": "2020-05-26T14:59:56Z"
},
"cargowatch_rear": {
"value": 8.6,
"gmt": "2020-05-26T14:59:56Z"
},
"cargowatch_return": {
"value": 9.5,
"gmt": "2020-05-26T14:59:56Z"
}
}
}
}
}| Code | Description |
|---|---|
| 1 | API key does not have associated unit with specified parameters |
| 2 | Invalid or missing "unit_id" parameter. |
| 3 | Parameter "datetime" is missing or is not a valid datetime. |
| 4 | Invalid or missing "select" parameter. Allowed values: previous, nearest |
GET https://mapon.com/api/v1/reefer/historic_period.json2020-05-26T15:00:00Z2020-05-26T15:00:00Z. Maximum period: 30 daysmode does not have a run sub-key, then there was no data for the sub-category at the selected period.state and temperature data are further grouped by compartment ID.{
"data": {
"refrigerator_type": "CARRIER",
"refrigerator_compartment_count": "1",
"refrigerator_communication_type": "1",
"flags": [
{
"value": 1,
"gmt": "2020-05-27T13:02:16Z"
}
],
"hours": {
"diesel": [
{
"value": 14237,
"gmt": "2020-05-26T15:13:01Z"
},
{
"value": 14238,
"gmt": "2020-05-26T16:13:09Z"
},
{
"value": 14239,
"gmt": "2020-05-26T17:13:07Z"
}
],
"standby": [
{
"value": 17751,
"gmt": "2020-05-26T15:32:02Z"
},
{
"value": 17752,
"gmt": "2020-05-26T16:32:06Z"
},
{
"value": 17753,
"gmt": "2020-05-26T17:32:16Z"
}
],
"electric": [
{
"value": 456,
"gmt": "2020-05-26T15:23:17Z"
}
]
},
"mode": {
"run": [
{
"value": 0,
"gmt": "2020-05-26T16:27:01Z"
}
],
"speed": [
{
"value": 0,
"gmt": "2020-05-26T17:18:34Z"
},
{
"value": 1,
"gmt": "2020-05-26T17:18:44Z"
}
],
"power": [
{
"value": 1,
"gmt": "2020-05-26T17:18:34Z"
}
]
},
"state": {
"compartment_0": [
{
"value": "on",
"gmt": "2020-05-27T09:41:16Z"
},
{
"value": "off",
"gmt": "2020-05-27T13:02:16Z"
}
]
},
"temperature": {
"compartment_0": {
"supply": [
{
"value": -13.8,
"gmt": "2020-05-26T14:35:56Z"
},
{
"value": -14.5,
"gmt": "2020-05-26T14:37:56Z"
},
{
"value": -15.1,
"gmt": "2020-05-26T14:39:56Z"
}
],
"return": [
{
"value": -6.7,
"gmt": "2020-05-26T14:35:56Z"
},
{
"value": -6.8,
"gmt": "2020-05-26T14:37:56Z"
}
],
"setpoint": [
{
"value": -7,
"gmt": "2020-05-26T14:35:56Z"
}
],
"cargowatch_rear": [
{
"value": 7.8,
"gmt": "2020-05-26T14:35:56Z"
}
],
"cargowatch_return": [
{
"value": 9.4,
"gmt": "2020-05-26T14:35:56Z"
}
],
"cargowatch_ambient": [
{
"value": 23.8,
"gmt": "2020-05-26T14:35:56Z"
},
{
"value": 25,
"gmt": "2020-05-26T14:37:56Z"
},
{
"value": 25.3,
"gmt": "2020-05-26T14:39:56Z"
}
]
}
}
}
}| Code | Description |
|---|---|
| 1 | API key does not have associated unit with specified parameters |
| 2 | Invalid or missing "unit_id" parameter. |
| 3 | Parameter "till"|"from" is missing or is not a valid datetime. |
| 4 | Invalid period. Unable to parse period parameters. |
| 5 | Invalid period. Period end date must be greater than start date. |
| 6 | Period too large. Maximum allowed period is 30 days. |
GET https://mapon.com/api/v1/tachograph/list_ddd_driver.json{
"data": {
"files": [
{
"id": 1,
"car_id": 1,
"card_number": "UAD000000000001",
"card_name": "John",
"card_surname": "Doe",
"card_birthday": "1966-07-17",
"created": "2018-01-01 00:09:03",
"filename": "1_00_20180101_1.ddd"
}
]
}
}GET https://mapon.com/api/v1/tachograph/download_ddd_driver.jsonGET https://mapon.com/api/v1/tachograph/list_ddd_vehicle.json{
"data": {
"files": [
{
"id": 1,
"car_id": 1,
"registration_number": "XX 1234",
"period_start": "2017-12-19",
"period_end": "2017-12-29",
"next_calibration": "2018-06-23",
"created": "2017-12-30 00:53:24",
"filename": "1_merged.ddd"
}
]
}
}GET https://mapon.com/api/v1/tachograph/download_ddd_vehicle.jsonGET https://mapon.com/api/v1/tracking/list.json{
"data": [
{
"id": "48249",
"gmt": "2017-07-07 11:16:23",
"car_id": [
"42218"
],
"from": "1499374800",
"till": "1499461199",
"routes": false,
"comment": "Note for tracking link",
"hash": "379573ba19b5e84110d60ff2e1c85544",
"deleted": "N",
"deactive_object_id": "0",
"additional_data": [],
"user_name": "Test user",
"user_id": "19047",
"restrict_routes_period": [],
"comment_visibility": true
}
]
}POST https://mapon.com/api/v1/tracking/edit.json0 to disable or 1 to allow see routes in periodtime_from - Specific time from (Example: 09:00)time_to - Specific time to (Example: 15:00)d1d2d3d4d5d6d7
0 - not visible, 1 - visible. Default value is 0carrier_temp - []
carrier_temp":[{"comp_id":1,"types":["supply","defrost","return","setpoint"]}
{
"data": {
"status": "ok"
}
}POST https://mapon.com/api/v1/tracking/create.json0 to disable or 1 to allow see routes in periodtime_from - Specific time from (Example: 09:00)time_to - Specific time to (Example: 15:00)d1d2d3d4d5d6d7
0 - not visible, 1 - visible. Default value is 0carrier_temp - []
carrier_temp":[{"comp_id":1,"types":["supply","defrost","return","setpoint"]}
{
"data": {
"status": "ok",
"tracking_id": "fd0ca1ae382c15fa18cd4cde4435d93a"
}
}POST https://mapon.com/api/v1/tracking/delete.json{
"data": {
"status": "ok"
}
}GET https://mapon.com/api/v1/messaging_channels/list.jsonlast_message_at,
last_message,
last_message.text,
last_message.gps,
last_message.attachmentslast_message.status possible values: sent,delivered,read,unreadlast_message.attachments.size size in bytes
{
"data": [
{
"id": 1,
"name": "Documents",
"is_admin": true,
"is_muted": false,
"last_message_at": "1970-01-01T00:00:02+00:00",
"last_message": {
"id": 1,
"status": "read",
"created_at": "1970-01-01T00:00:02+00:00",
"text": "Lorem ipsum",
"gps": {
"lat": 0,
"lng": 0,
"address": "Address"
},
"attachments": [
{
"id": 1,
"name": "sample.jpg",
"mime": "image\/jpeg",
"url": "https:\/\/url-to-image.example?23424324323423",
"thumb_url": "https:\/\/url-to-image-thumb.example?23424324323423",
"size": 234324
}
],
"sender": {
"id": 1,
"unit_id": null,
"user_id": 1,
"title": "John Smith"
}
},
"unread_total": 1,
"user_count": 2
}
]
}POST https://mapon.com/api/v1/messaging_conversations/create.jsongeneral, sms, garminindividual, groupuser, carmessage_gps, message_attachmentsmessage_text, message_attachmentsmessage_text, message_gpsremoved_at,
joined_at,
last_message_at,
last_message,
last_message.text,
last_message.gps,
last_message.attachments,
conversation_withtype possible values: individual,groupconversation_with - null in group conversationslast_message.status possible values: sent,delivered,read,unreadlast_message.attachments.size size in bytes
{
"data": [
{
"id": "1",
"title": "John Smith (AAAA0000)",
"type": "individual",
"unread_total": 0,
"removed_at": null,
"is_favorite": false,
"is_admin": false,
"joined_at": "1970-01-01T00:00:01+00:00",
"last_message_at": "1970-01-01T00:00:02+00:00",
"last_message": {
"id": 1,
"status": "read",
"created_at": "1970-01-01T00:00:02+00:00",
"text": "Lorem ipsum",
"gps": {
"lat": 0,
"lng": 0,
"address": "Address"
},
"attachments": [
{
"id": 1,
"name": "sample.jpg",
"mime": "image\/jpeg",
"url": "https:\/\/url-to-image.example?23424324323423",
"thumb_url": "https:\/\/url-to-image-thumb.example?23424324323423",
"size": 234324
}
],
"sender": {
"id": 1,
"unit_id": null,
"user_id": 1,
"title": "John Smith"
}
},
"conversation_with": {
"id": 1,
"unit_id": null,
"user_id": 1,
"title": "John Smith"
}
}
]
}| Code | Description |
|---|---|
| 1 | Invalid parameter |
| 2 | user_id required |
| 3 | Invalid user |
| 4 | Invalid medium |
| 5 | No sms feature |
| 6 | Only individual conversations in channels |
| 7 | Group title required |
| 8 | Empty message |
| 9 | Invalid receivers |
| 10 | Invalid channel |
| 11 | Invalid receiver user |
| 12 | Invalid receiver unit |
| 13 | Invalid message attachment |
| 14 | Invalid type |
GET https://mapon.com/api/v1/messaging_conversations/list.json0,1 If 1 returns conversations which belongs to channels. Default value: 0removed_at,
joined_at,
last_message_at,
last_message,
last_message.text,
last_message.gps,
last_message.attachments,
conversation_withtype possible values: individual,groupconversation_with - null in group conversationslast_message.status possible values: sent,delivered,read,unreadlast_message.attachments.size size in bytes
{
"data": [
{
"id": "1",
"title": "John Smith (AAAA0000)",
"type": "individual",
"unread_total": 0,
"removed_at": null,
"is_favorite": false,
"is_admin": false,
"joined_at": "1970-01-01T00:00:01+00:00",
"last_message_at": "1970-01-01T00:00:02+00:00",
"last_message": {
"id": 1,
"status": "read",
"created_at": "1970-01-01T00:00:02+00:00",
"text": "Lorem ipsum",
"gps": {
"lat": 0,
"lng": 0,
"address": "Address"
},
"attachments": [
{
"id": 1,
"name": "sample.jpg",
"mime": "image\/jpeg",
"url": "https:\/\/url-to-image.example?23424324323423",
"thumb_url": "https:\/\/url-to-image-thumb.example?23424324323423",
"size": 234324
}
],
"sender": {
"id": 1,
"unit_id": null,
"user_id": 1,
"title": "John Smith"
}
},
"conversation_with": {
"id": 1,
"unit_id": null,
"user_id": 1,
"title": "John Smith"
}
}
]
}| Code | Description |
|---|---|
| 1 | Invalid parameter |
| 2 | user_id required |
| 3 | Invalid user |
| 4 | Invalid medium |
| 5 | Invalid type |
POST https://mapon.com/api/v1/messaging_messages/send.jsonmessage_gps, message_attachmentsmessage_text, message_attachmentsmessage_text, message_gpstext,
gps,
attachmentsstatus possible values: sent,delivered,read,unreadattachments.size size in bytes
{
"data": [
{
"id": 1,
"status": "read",
"created_at": "1970-01-01T00:00:02+00:00",
"text": "Lorem ipsum",
"gps": {
"lat": 0,
"lng": 0,
"address": "Address"
},
"attachments": [
{
"id": 1,
"name": "sample.jpg",
"mime": "image\/jpeg",
"url": "https:\/\/url-to-image.example?23424324323423",
"thumb_url": "https:\/\/url-to-image-thumb.example?23424324323423",
"size": 234324
}
],
"sender": {
"id": 1,
"unit_id": null,
"user_id": 1,
"title": "John Smith"
}
}
]
}| Code | Description |
|---|---|
| 1 | Invalid parameter |
| 2 | user_id required |
| 3 | Invalid user |
| 4 | Invalid conversation |
| 5 | No sms feature |
| 6 | Empty message |
GET https://mapon.com/api/v1/messaging_messages/list.jsonprev,next. If direction prev return messages with id less then given cursor, otherwise greater. Default value: prev1 Max 100 Default: 20text,
gps,
attachmentsstatus possible values: sent,delivered,read,unreadattachments.size size in bytes
{
"data": [
{
"id": 1,
"status": "read",
"created_at": "1970-01-01T00:00:02+00:00",
"text": "Lorem ipsum",
"gps": {
"lat": 0,
"lng": 0,
"address": "Address"
},
"attachments": [
{
"id": 1,
"name": "sample.jpg",
"mime": "image\/jpeg",
"url": "https:\/\/url-to-image.example?23424324323423",
"thumb_url": "https:\/\/url-to-image-thumb.example?23424324323423",
"size": 234324
}
],
"sender": {
"id": 1,
"unit_id": null,
"user_id": 1,
"title": "John Smith"
}
}
]
}| Code | Description |
|---|---|
| 1 | Invalid parameter |
| 2 | user_id required |
| 3 | Invalid user |
| 4 | Invalid conversation |
GET https://mapon.com/api/v1/driver_behaviour/report_units.jsoneffective_speed,excessive_idling,
cruise_control,coasting,harsh_braking,
harsh_acceleration,harsh_cornering,green_rpm,speeding1000fuel_avg_consumption_measure value is kg/100km then all fuel values are returned in KG, not in L
{
"data": [
{
"unit_id": 1,
"title": "AAA000",
"driven_user_ids": [],
"overall": {
"grade": "F",
"score": 20.37
},
"effective_speed": {
"grade": "F",
"score": 71.15,
"distance": 1405.305,
"duration": 92509
},
"excessive_idling": {
"grade": "D",
"score": 11.24,
"duration": 14617
},
"cruise_control": {
"grade": "D",
"score": 57.42,
"distance": 1043.321,
"duration": 42964
},
"coasting": {
"grade": "C",
"score": 10.42,
"distance": 382.856,
"duration": 14831
},
"harsh_braking": {
"grade": "D",
"score": 33.89,
"count": 51
},
"harsh_acceleration": {
"grade": "F",
"score": 51.83,
"count": 78
},
"harsh_cornering": {
"grade": "G",
"score": 366.12,
"count": 551
},
"green_rpm": {
"grade": "G",
"score": 12.96,
"distance": 361.543,
"duration": 16848
},
"speeding": {
"grade": "E",
"score": 16.36,
"distance": 108.241,
"duration": 4641
},
"distance_gps": 2357.729,
"distance_can": 512,
"driving_duration": 130028,
"excessive_idling_pto_duration": null,
"fuel_avg_consumption": 3.91,
"fuel_avg_consumption_measure": "l\/100km",
"fuel_avg_consumption_by_norm": null,
"fuel_avg_consumption_ratio": null,
"fuel_consumption": null,
"fuel_consumption_can": 20,
"excessive_idling_consumption_can": 6,
"pto_idle_fuel_consumption_can": null,
"stop_count": 111,
"stop_duration": 1165972,
"avg_speed": 14.18
}
],
"_meta": {
"total": 25,
"totalPages": 25,
"perPage": 1,
"page": 1
}
}| Code | Description |
|---|---|
| 1 | Invalid or missing date_from parameter |
| 2 | Invalid or missing date_till parameter |
| 3 | Invalid page parameter |
| 4 | Invalid per_page parameter |
| 5 | Invalid depot parameter |
| 6 | Invalid group parameter |
| 7 | Invalid metrics parameter |
| 8 | Invalid period |
| 9 | Period can not exceed 31 days |
| 11 | Invalid unit_ids parameter |
GET https://mapon.com/api/v1/driver_behaviour/report_drivers.jsoneffective_speed,excessive_idling,
cruise_control,coasting,harsh_braking,
harsh_acceleration,harsh_cornering,green_rpm, speeding1000fuel_avg_consumption_measure value is kg/100km then all fuel values are returned in KG, not in L
{
"data": [
{
"user_id": 1,
"title": "John Smith",
"driven_units_ids": [
1
],
"overall": {
"grade": "D",
"score": 48.75
},
"effective_speed": {
"grade": "G",
"score": 64.73,
"distance": 698.22,
"duration": 62451
},
"excessive_idling": {
"grade": "F",
"score": 25.84,
"duration": 24930
},
"cruise_control": {
"grade": "D",
"score": 57.42,
"distance": 1043.321,
"duration": 42964
},
"coasting": {
"grade": "C",
"score": 10.42,
"distance": 382.856,
"duration": 14831
},
"harsh_braking": {
"grade": "B",
"score": 8.96,
"count": 10
},
"harsh_acceleration": {
"grade": "B",
"score": 9.85,
"count": 11
},
"harsh_cornering": {
"grade": "B",
"score": 8.96,
"count": 10
},
"green_rpm": {
"grade": "G",
"score": 55.08,
"distance": 626.837,
"duration": 53137
},
"speeding": {
"grade": "F",
"score": 20.51,
"distance": 88.052,
"duration": 3486
},
"distance_gps": 1609.468,
"distance_can": 1564,
"driving_duration": 96478,
"excessive_idling_pto_duration": null,
"fuel_avg_consumption": 13.75,
"fuel_avg_consumption_measure": "l\/100km",
"fuel_avg_consumption_by_norm": 0,
"fuel_avg_consumption_ratio": null,
"fuel_consumption": null,
"fuel_consumption_can": 215,
"excessive_idling_consumption_can": 27,
"pto_idle_fuel_consumption_can": null,
"stop_count": 98,
"stop_duration": 1199522,
"avg_speed": 58.36
}
],
"_meta": {
"total": 3,
"totalPages": 3,
"perPage": 1,
"page": 1
}
}| Code | Description |
|---|---|
| 1 | Invalid or missing date_from parameter |
| 2 | Invalid or missing date_till parameter |
| 3 | Invalid page parameter |
| 4 | Invalid per_page parameter |
| 5 | Invalid depot parameter |
| 6 | Invalid group parameter |
| 7 | Invalid metrics parameter |
| 8 | Invalid period |
| 9 | Period can not exceed 31 days |
| 11 | Invalid driver_ids parameter |
GET https://mapon.com/api/v1/vehicle_inspections/list.json1 - Delayed2 - Pass3 - Failed4 - Resolved-1 for ungrouped units0 - return only units with devices;1 - return all. Default:01;Max:250;Default:50items filled inspection dataarray data
int idstring titleint unit_idfloat latfloat lngstring addressint status 1-delayed;2-pass;3-failed;4-resolvedstring|null status_at Datetime in GMT. Formatted date Y-m-d H:i:s. e.g. 1970-01-01 00:00:00string numberstring|null inspected_at Datetime in GMT. Formatted date Y-m-d H:i:s. e.g. 1970-01-01 00:00:00int odometer (km)string|null performer_full_namestring|null performer_signature_image_file_urlint|null total_time_spent (s)array items
int idstring namestring notesint status 0-fail;1-passint time_spent (seconds)array|null historical_damage_items
int idstring notesint status 0-open;1-ongoing;2-awaiting_approval;3-repairedarray|null attachments
int idstring urlarray|null attachments
int idstring url{
"data": [
{
"id": 1,
"title": "Daily inspection",
"unit_id": "2",
"lat": 1.12345,
"lng": 2.54321,
"address": "Sample street 123",
"status": 1,
"status_at": "1970-01-01 00:00:01",
"number": "ABC123456",
"inspected_at": "1970-01-01 00:00:02",
"odometer": "123456",
"performer_full_name": "John Smith",
"performer_signature_image_file_url": "https:\/\/sample.org\/file.php?hash=12345",
"total_time_spent": 600,
"items": [
{
"id": 1,
"name": "Tyre check",
"notes": "Some notes",
"status": 1,
"time_spent": 30,
"historical_damage_items": [
{
"id": 1,
"notes": "Some more notes",
"status": 3,
"attachments": [
{
"id": 1,
"url": "https:\/\/sample.org\/file.php?hash=65432"
}
]
}
],
"attachments": [
{
"id": 1,
"url": "https:\/\/sample.org\/file.php?hash=54321"
}
]
}
]
}
],
"_meta": {
"total": 25,
"totalPages": 25,
"perPage": 1,
"page": 1
}
}| Code | Description |
|---|---|
| 1 | invalid status parameter |
| 2 | invalid unit_ids parameter |
| 3 | invalid depot_id parameter |
| 4 | invalid group_id parameter |
| 5 | invalid page parameter |
| 6 | invalid per_page parameter |
| 7 | invalid inspection_date_from parameter |
| 8 | invalid inspection_date_to parameter |
| 9 | inspection_date_from/inspection_date_to parameter required with inspection_date_to/inspection_date_from parameter |
| 10 | invalid includes parameter |
POST https://mapon.com/api/v1/routeplanning_orders/create.jsonlow,medium,high. Default value: medium300m. Limits: [10; 900]frozenfrozenfrozenfrom parameter must be less or equal to to parameter. Timezone will be discovered from provided place address.Y-m-d format (e.g. 2021-05-30).Y-m-d format (e.g. 2021-05-30).00:00, to:23:59} is saved.00-23. Allowed minutes range: 00-59.00-23. Allowed minutes range: 00-59.delivery_dates parameter is set, and dates are not equal. If NOT set, multiple consecutive delivery times for each day within set range will be considered. Allowed values 0;1. Default: 0.300m. Limits: [10; 900]frozenfrozenfrozenfrom parameter must be less or equal to to parameter. Timezone will be discovered from provided place address.Y-m-d format (e.g. 2021-05-30).Y-m-d format (e.g. 2021-05-30).00:00, to:23:59} is saved.00-23. Allowed minutes range: 00-59.00-23. Allowed minutes range: 00-59.delivery_dates parameter is set, and dates are not equal. If NOT set, multiple consecutive delivery times for each day within set range will be considered. Allowed values 0;1. Default: 0.order_id created order idplace_ids created places idroute_id created route id
{
"data": {
"order_id": 1,
"place_ids": [
1,
2,
3
],
"route_id": null
}
}| Code | Description |
|---|---|
| 1 | order_no must be unique |
| 2 | assignee_driver_id only with communication with driver |
| 3 | invalid assignee_driver_id |
| 4 | assignee_driver_id required with assignee_driver_unit_id |
| 5 | invalid assignee_driver_unit_id parameter |
| 6 | assignee_unit_id only with communication with car |
| 7 | invalid assignee_unit_id parameter |
| 8 | assignee_unit_id/assignee_driver_id required with route_name |
| 9 | invalid priority parameter |
| 10 | invalid pickup_places parameter |
| 11 | max pickup_place limit exceeded |
| 12 | invalid or missing places parameter |
| 13 | max places per order exceeded |
| 14 | order total capacity exceeded unit max capacity |
| 15 | order total capacity weight we exceeded unit max capacity weight |
| 16 | invalid cargo_type parameter |
| 17 | optimal_temperature_from only for frozen cargo |
| 18 | optimal_temperature_to only for frozen cargo |
| 19 | invalid client_id parameter |
| 20 | invalid or missing address parameter |
| 21 | invalid email parameter |
| 22 | invalid delivery_dates item from parameter |
| 23 | invalid delivery_dates item to parameter |
| 24 | delivery_dates item from parameter must be less or equal to delivery_dates item to parameter |
| 25 | invalid phone parameter |
| 26 | invalid route_id parameter |
| 27 | given route is finished |
| 28 | route calculation is in progress |
| 111 | invalid sort_no parameter |
| 112 | invalid geofence parameter |
| 113 | invalid delivery_times item from parameter |
| 114 | invalid delivery_times item to parameter |
| 115 | delivery_times parameters must be different |
POST https://mapon.com/api/v1/routeplanning_orders/add_places.json300m. Limits: [10; 900]frozenfrozenfrozenfrom parameter must be less or equal to to parameter. Timezone will be discovered from provided place address.Y-m-d format (e.g. 2021-05-30).Y-m-d format (e.g. 2021-05-30).00:00, to:23:59} is saved.00-23. Allowed minutes range: 00-59.00-23. Allowed minutes range: 00-59.delivery_dates parameter is set, and dates are not equal. If NOT set, multiple consecutive delivery times for each day within set range will be considered. Allowed values 0;1. Default: 0.300m. Limits: [10; 900]frozenfrozenfrozenfrom parameter must be less or equal to to parameter. Timezone will be discovered from provided place address.Y-m-d format (e.g. 2021-05-30).Y-m-d format (e.g. 2021-05-30).00:00, to:23:59} is saved.00-23. Allowed minutes range: 00-59.00-23. Allowed minutes range: 00-59.delivery_dates parameter is set, and dates are not equal. If NOT set, multiple consecutive delivery times for each day within set range will be considered. Allowed values 0;1. Default: 0.place_ids created places id{
"data": {
"place_ids": [
1,
2,
3
]
}
}| Code | Description |
|---|---|
| 1 | missing id parameter |
| 2 | invalid id parameter |
| 3 | max places limit exceeded |
| 4 | pick-up places are only allowed for pick-up and delivery order |
| 5 | invalid pickup_places parameter |
| 6 | invalid places parameter |
| 7 | invalid places sort |
| 8 | order total capacity exceeded unit max capacity |
| 9 | order total capacity weight we exceeded unit max capacity weight |
| 101 | invalid cargo_type parameter |
| 102 | optimal_temperature_from only for frozen cargo |
| 103 | optimal_temperature_to only for frozen cargo |
| 104 | invalid client_id parameter |
| 105 | invalid or missing address parameter |
| 106 | invalid email parameter |
| 107 | invalid delivery_dates item from parameter |
| 108 | invalid delivery_dates item to parameter |
| 109 | delivery_dates item from parameter must be less or equal to delivery_dates item to parameter |
| 110 | invalid phone parameter |
| 111 | invalid sort_no parameter |
| 112 | invalid geofence parameter |
| 113 | invalid delivery_times item from parameter |
| 114 | invalid delivery_times item to parameter |
| 115 | delivery_times parameters must be different |
GET https://mapon.com/api/v1/routeplanning_orders/get.jsonpolylineobject data
int idstring order_nostring type Values: visit;pickup_deliveryfloat price (in company currency)int distance (meters)int duration (seconds)int|null route_idstring|null polyline{
"data": {
"id": 1,
"order_no": "ORDER-1",
"type": "visit",
"price": 123,
"distance": 456,
"duration": 1234567,
"route_id": 1,
"poyline": "IL&TGQKF"
}
}| Code | Description |
|---|---|
| 1 | Invalid or missing id parameter |
| 2 | invalid order |
| 3 | invalid includes parameter |
GET https://mapon.com/api/v1/routeplanning_orders/list.json1; Max: 200; Default: 150polylinearray data
int idstring order_nostring type Values: visit;pickup_deliveryfloat price (in company currency)int distance (meters)int duration (seconds)int|null route_idstring|null polylineobject _meta
int totalint total_pagesint per_pagesint page{
"data": [
{
"id": 1,
"order_no": "ORDER-1",
"type": "visit",
"price": 123,
"distance": 456,
"duration": 1234567,
"route_id": 1,
"poyline": "IL&TGQKF"
}
],
"_meta": {
"total": 25,
"totalPages": 25,
"perPage": 1,
"page": 1
}
}| Code | Description |
|---|---|
| 1 | invalid delivery_date parameter |
| 2 | invalid page parameter |
| 3 | invalid per_page parameter |
| 4 | invalid includes parameter |
POST https://mapon.com/api/v1/routeplanning_orders/delete.jsonobject data
bool deleted{
"data": {
"deleted": true
}
}| Code | Description |
|---|---|
| 1 | missing ids parameter |
| 2 | invalid ids parameter |
| 3 | invalid order |
GET https://mapon.com/api/v1/routeplanning_places/get.jsonpolyline_to;filesobject data
int idint order_idint|null route_idint|null client_idint sort_nostring addressfloat address_latfloat address_lngstring address_timezoneint geofence radius (meters)string type Values:visit;pickupdeliverystring status Value:not_started;started;loading;completed;declinedstring|null status_changed_atstring|null phonestring|null emailstring|null cargo_type Values:frozenobject delivery_dates
string|null fromstring|null toobject delivery_times
string from 24hour timestring to 24hour timebool delivery_intervalint|null optimal_temperature_fromint|null optimal_temperature_toint capacity_weight (kg)int capacity (volume,pallets,loading meters,others units)int stop_off_time (minutes)string notesstring|null finished_atint distance_to (meters)int duration_to (seconds)string|null planned_arrival_timestring|null arrival_timeint|null distance_left (meters)string polyline_toarray files
int idstring namestring urlstring|null thumb_urlstring mimeint size (bytes)int|null widthint|null heightstring|null orientation Value:landscape;portraitint|null thumb_widthint|null thumb_heightstring|null thumb_orientation Value:landscape;portrait{
"data": {
"id": 1,
"order_id": 1,
"route_id": 1,
"client_id": 1,
"sort_no": 0,
"address": "Sample street 123",
"address_lat": 1.12345,
"address_lng": 2.54321,
"address_timezone": "Europe\/Riga",
"geofence": 300,
"type": "visit",
"status": "not_started",
"status_changed_at": "1970-01-01 00:00:01",
"phone": "1234567890",
"email": "example@example.net",
"cargo_type": null,
"delivery_dates": {
"from": "2021-08-20",
"to": "2021-08-25"
},
"delivery_times": {
"from": "09:00",
"to": "18:00"
},
"delivery_interval": true,
"optimal_temperature_from": -6,
"optimal_temperature_to": 6,
"capacity_weight": 1234,
"capacity": 22,
"stop_off_time": 30,
"notes": "some notes",
"finished_at": "1970-01-01 00:00:03",
"distance_to": 2144,
"duration_to": 45352,
"planned_arrival_time": "1970-01-01 00:00:02",
"arrival_time": "1970-01-01 00:00:02",
"distance_left": 0,
"polyline_to": "SDFHGS@#FIYD",
"files": [
{
"id": 1,
"name": "sample.jpeg",
"url": "http:\/\/example.com\/files.php\/?32432432",
"thumb_url": "http:\/\/example.com\/files.php\/?32432432&thumb=true",
"mime": "image\/jpeg",
"size": 32434,
"width": 1000,
"height": 800,
"orientation": "landscape",
"thumb_width": 150,
"thumb_height": 100,
"thumb_orientation": "landscape"
}
]
}
}| Code | Description |
|---|---|
| 1 | missing id parameter |
| 2 | invalid id parameter |
| 3 | invalid includes parameter |
GET https://mapon.com/api/v1/routeplanning_places/list.json11; Max: 250; Default: 150polyline_to;filesarray data
int idint order_idint|null route_idint|null client_idint sort_nostring addressfloat address_latfloat address_lngstring address_timezoneint geofence radius (meters)string type Values:visit;pickupdeliverystring status Value:not_started;started;loading;completed;declinedstring|null status_changed_atstring|null phonestring|null emailstring|null cargo_type Values:frozenobject delivery_dates
string|null fromstring|null toobject delivery_times
string from 24hour timestring to 24hour timebool delivery_intervalint|null optimal_temperature_fromint|null optimal_temperature_toint capacity_weight (kg)int capacity (volume,pallets,loading meters,others units)int stop_off_time (minutes)string notesstring|null finished_atint distance_to (meters)int duration_to (seconds)string|null planned_arrival_timestring|null arrival_timeint|null distance_left (meters)string polyline_toarray files
int idstring namestring urlstring|null thumb_urlstring mimeint size (bytes)int|null widthint|null heightstring|null orientation Value:landscape;portraitint|null thumb_widthint|null thumb_heightstring|null thumb_orientation Value:landscape;portraitobject _meta
int totalint total_pagesint per_pagesint page{
"data": [
{
"id": 1,
"order_id": 1,
"route_id": 1,
"client_id": 1,
"sort_no": 0,
"address": "Sample street 123",
"address_lat": 1.12345,
"address_lng": 2.54321,
"address_timezone": "Europe\/Riga",
"geofence": 300,
"type": "visit",
"status": "not_started",
"status_changed_at": "1970-01-01 00:00:01",
"phone": "1234567890",
"email": "example@example.net",
"cargo_type": null,
"delivery_dates": {
"from": "2021-08-20",
"to": "2021-08-25"
},
"delivery_times": {
"from": "09:00",
"to": "18:00"
},
"delivery_interval": true,
"optimal_temperature_from": -6,
"optimal_temperature_to": 6,
"capacity_weight": 1234,
"capacity": 22,
"stop_off_time": 30,
"notes": "some notes",
"finished_at": "1970-01-01 00:00:03",
"distance_to": 2144,
"duration_to": 45352,
"planned_arrival_time": "1970-01-01 00:00:02",
"arrival_time": "1970-01-01 00:00:02",
"distance_left": 0,
"polyline_to": "SDFHGS@#FIYD",
"files": [
{
"id": 1,
"name": "sample.jpeg",
"url": "http:\/\/example.com\/files.php\/?32432432",
"thumb_url": "http:\/\/example.com\/files.php\/?32432432&thumb=true",
"mime": "image\/jpeg",
"size": 32434,
"width": 1000,
"height": 800,
"orientation": "landscape",
"thumb_width": 150,
"thumb_height": 100,
"thumb_orientation": "landscape"
}
]
}
],
"_meta": {
"total": 25,
"totalPages": 25,
"perPage": 1,
"page": 1
}
}| Code | Description |
|---|---|
| 1 | invalid or missing route_ids parameter |
| 2 | invalid route id |
| 3 | invalid page parameter |
| 4 | invalid per_page parameter |
| 5 | invalid includes parameter |
POST https://mapon.com/api/v1/routeplanning_places/delete.jsonobject data
bool deleted{
"data": {
"deleted": true
}
}| Code | Description |
|---|---|
| 1 | missing ids parameter |
| 2 | invalid ids parameter |
| 3 | invalid place |
POST https://mapon.com/api/v1/routeplanning_routes/save.jsonobject data
int id. Route id{
"data": {
"id": 1
}
}| Code | Description |
|---|---|
| 1 | invalid id parameter |
| 2 | optimization in progress |
| 3 | invalid assignee_driver_id parameter |
| 4 | assignee_driver_id required with assignee_driver_unit_id |
| 5 | invalid assignee_driver_unit_id parameter |
| 6 | invalid assignee_unit_id parameter |
| 7 | invalid departure_at parameter |
| 8 | invalid start_address parameter |
| 9 | invalid end_address parameter |
GET https://mapon.com/api/v1/routeplanning_routes/get.jsonpolylineobject data
int idstring nameint|null unit_id. If communication type with vehicleint|null driver_id. If communication type with driverint|null driver_unit_id. If communication type with driverstring|null start_addressfloat|null start_latfloat|null start_lngstring|null start_timezonestring|null end_addressfloat|null end_latfloat|null end_lngstring|null end_timezonestring|null departure_atstring|null planned_atbool is_in_progressint places_totalint places_completedint distance (meters)int duration (seconds)float costs_per_km (EURO cents)float costs_per_h (EURO cents)array toll_costs
string namestring country_codefloat amount (EURO cents)string polyline{
"data": {
"id": 1,
"name": "ROUTE #123",
"unit_id": 1,
"driver_id": null,
"driver_unit_id": null,
"start_address": "Sample street 123",
"start_lat": 1.12345,
"start_lng": 2.54321,
"start_timezone": "Europe\/Riga",
"end_address": "Sample street 321",
"end_lat": 3.12345,
"end_lng": 4.54321,
"end_timezone": "Europe\/Helsinki",
"departure_at": "1970-01-01 00:00:05",
"planned_at": "1970-01-01 00:00:02",
"is_in_progress": true,
"places_total": 10,
"places_completed": 1,
"distance": 234,
"duration": 34235,
"costs_per_km": 0.05,
"cost_per_h": 24,
"toll_costs": [
{
"name": "TOLL",
"country": "GB",
"amount": "24"
}
],
"polyline": "HJH#4JH!@#"
}
}| Code | Description |
|---|---|
| 1 | missing id parameter |
| 2 | invalid route |
| 3 | invalid includes parameter |
GET https://mapon.com/api/v1/routeplanning_routes/list.json0;111; Max: 250; Default: 150polylinearray data
int idstring nameint|null unit_id. If communication type with vehicleint|null driver_id. If communication type with driverint|null driver_unit_id. If communication type with driverstring|null start_addressfloat|null start_latfloat|null start_lngstring|null start_timezonestring|null end_addressfloat|null end_latfloat|null end_lngstring|null end_timezonestring|null departure_atstring|null planned_atbool is_in_progressint places_totalint places_completedint distance (meters)int duration (seconds)float costs_per_km (EURO cents)float costs_per_h (EURO cents)array toll_costs
string namestring country_codefloat amount (EURO cents)string polylineobject _meta
int totalint total_pagesint per_pagesint page{
"data": [
{
"id": 1,
"name": "ROUTE #123",
"unit_id": 1,
"driver_id": null,
"driver_unit_id": null,
"start_address": "Sample street 123",
"start_lat": 1.12345,
"start_lng": 2.54321,
"start_timezone": "Europe\/Riga",
"end_address": "Sample street 321",
"end_lat": 3.12345,
"end_lng": 4.54321,
"end_timezone": "Europe\/Helsinki",
"departure_at": "1970-01-01 00:00:05",
"planned_at": "1970-01-01 00:00:02",
"is_in_progress": true,
"places_total": 10,
"places_completed": 1,
"distance": 234,
"duration": 34235,
"costs_per_km": 0.05,
"cost_per_h": 24,
"toll_costs": [
{
"name": "TOLL",
"country": "GB",
"amount": "24"
}
],
"polyline": "HJH#4JH!@#"
}
],
"_meta": {
"total": 25,
"totalPages": 25,
"perPage": 1,
"page": 1
}
}| Code | Description |
|---|---|
| 1 | unit_ids parameter only with communication with vehicle |
| 2 | invalid or missing unit_ids parameter |
| 3 | driver_ids parameter only with communication with driver |
| 4 | invalid or missing driver_ids parameter |
| 5 | invalid page parameter |
| 6 | invalid per_page parameter |
| 7 | invalid includes parameter |
POST https://mapon.com/api/v1/routeplanning_routes/send_to_assignee.jsonobject data
bool sent{
"data": {
"sent": true
}
}| Code | Description |
|---|---|
| 1 | invalid or missing id parameter |
| 2 | invalid route |
| 3 | route already planned |
POST https://mapon.com/api/v1/routeplanning_routes/set_start_address.jsonobject data
string status Values: ok;failed{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | invalid or missing id parameter |
| 2 | invalid route |
| 3 | route optimization in progress |
| 4 | route last place already is started |
| 5 | invalid address parameter |
POST https://mapon.com/api/v1/routeplanning_routes/set_end_address.jsonobject data
string status Values: ok;failed{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | invalid or missing id parameter |
| 2 | invalid route |
| 3 | route optimization in progress |
| 4 | route already started |
| 5 | invalid departure_at parameter |
| 6 | invalid or missing address parameter |
POST https://mapon.com/api/v1/routeplanning_routes/optimize.json0;1object data
string status Possible values: failed,waiting(optimization has been queued)int|null optimization_id Optimization id to use in the "Check optimization progress" endpoint{
"data": {
"status": "waiting",
"optimization_id": 1
}
}| Code | Description |
|---|---|
| 1 | Invalid or missing id parameter |
| 2 | There is nothing to optimize. The route has already been completed |
| 3 | Optimization already in progress |
GET https://mapon.com/api/v1/routeplanning_routes/optimize_check_progress.jsonobject data
string status Possible values: waiting,running,finished,canceled,failed,no_solution,unreachable_points,nothing_to_optimizeint progress (%){
"data": {
"status": "running",
"progress": 50
}
}| Code | Description |
|---|---|
| 1 | Invalid or missing optimization_id parameter |
POST https://mapon.com/api/v1/routeplanning_routes/delete.jsonobject data
bool deleted{
"data": {
"deleted": true
}
}| Code | Description |
|---|---|
| 1 | missing ids parameter |
| 2 | invalid ids parameter |
| 3 | invalid route |
GET https://mapon.com/api/v1/ble_tags/list.jsonbeacon_id, name, radius, first_scan_gmt, last_scan_gmt, scan_count, location_updated_at, created_atYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Zlocation_precision_radius field value is in meters.name,location_precision_radius,first_scan,last_scan,location_changed and fields from location can be null.location_precision_radius (by default 50m if empty) determines the radius of approximated tag location circle. If the tag is scanned outside this location, a new location will be registered.{
"data": {
"tags": [
{
"id": 3,
"beacon_id": "142516384b514e87f34f0bab15d480f1245e71ec",
"serial_nr": "00145673",
"name": "Marcellus Crooks",
"location_precision_radius": 156,
"first_scan": "2020-12-18T09:47:33Z",
"last_scan": "2020-12-31T07:54:47Z",
"created_at": "2020-12-11T14:23:37Z",
"scan_count": 2287,
"location_changed": "2020-12-31T07:54:47Z",
"location": {
"lat": 48.199444,
"lng": 13.918659,
"address": "Steinpichl 5, 4632 Steinpichl, Austria"
}
},
{
"id": 28,
"beacon_id": "559e47f53ba1bf5e7701205e7b1873abe555654d",
"serial_nr": "00326684",
"name": "Benton Ortiz DVM",
"location_precision_radius": 182,
"first_scan": "2020-12-11T03:37:14Z",
"last_scan": "2020-12-25T20:53:02Z",
"created_at": "2020-12-10T19:57:04Z",
"scan_count": 7556,
"location_changed": "2020-12-25T20:53:02Z",
"location": {
"lat": 56.96795963,
"lng": 24.12399726,
"address": "Grostonas iela 6B, Vidzemes priek\u0161pils\u0113ta, R\u012bga, LV-1013, Latvia"
}
},
{
"id": 36,
"beacon_id": "755b4febe32949b4b08f9bc1df1c61610fe73e3d",
"serial_nr": "15777443",
"name": "Prof. Whitney Kozey Jr.",
"location_precision_radius": 132,
"first_scan": "2020-12-23T10:33:32Z",
"last_scan": "2020-12-23T10:40:38Z",
"created_at": "2020-12-12T04:33:06Z",
"scan_count": 733,
"location_changed": "2020-12-23T10:40:38Z",
"location": {
"lat": 55.788878,
"lng": 24.002434,
"address": "Unnamed Road, 38384, Lithuania"
}
},
{
"id": 38,
"beacon_id": "7db40b0287d327f687ffef224a492d0cd7943896",
"serial_nr": "96542674",
"name": "Prof. Nestor Donnelly DDS",
"location_precision_radius": 159,
"first_scan": "2020-12-28T03:53:56Z",
"last_scan": "2021-01-02T11:36:35Z",
"created_at": "2020-12-20T06:44:56Z",
"scan_count": 5050,
"location_changed": "2021-01-02T11:36:35Z",
"location": {
"lat": 56.178055,
"lng": 25.449808,
"address": "Unnamed Road, Rites pagasts, LV-5228, Latvia"
}
},
{
"id": 51,
"beacon_id": "829118e8c9bed05dc589d0d7b5731ca2627e747b",
"serial_nr": "3355667743",
"name": "Dr. Antoinette VonRueden III",
"location_precision_radius": 241,
"first_scan": null,
"last_scan": null,
"created_at": "2021-01-07T11:07:54Z",
"scan_count": 0,
"location_changed": null,
"location": {
"lat": null,
"lng": null,
"address": null
}
},
{
"id": 40,
"beacon_id": "886ab681d6426778cd4c2156b6482396047ff5e2",
"serial_nr": "7478935568",
"name": "Alena Mann",
"location_precision_radius": 245,
"first_scan": "2020-12-07T07:39:23Z",
"last_scan": "2020-12-29T12:25:46Z",
"created_at": "2020-12-06T16:39:36Z",
"scan_count": 8848,
"location_changed": "2020-12-29T12:25:46Z",
"location": {
"lat": 46.851812,
"lng": 24.229142,
"address": "Unnamed Road, Bude\u015fti-F\u00e2na\u0163e 427021, Romania"
}
},
{
"id": 47,
"beacon_id": "90abfe6ea4b82fc65c8ef8fc5ed0b53dea616e10",
"serial_nr": "765323248",
"name": "Rod Kautzer Jr.",
"location_precision_radius": 237,
"first_scan": "2020-12-23T17:47:24Z",
"last_scan": "2021-01-02T19:31:03Z",
"created_at": "2020-12-12T03:00:30Z",
"scan_count": 2830,
"location_changed": "2021-01-02T19:31:03Z",
"location": {
"lat": 46.371671,
"lng": 23.622825,
"address": "DJ107M 91, Poiana Aiudului 517392, Romania"
}
},
{
"id": 19,
"beacon_id": "a1b364d0c700e763d774a94d6336347671ab6968",
"serial_nr": "4647211885",
"name": "Anastasia Hintz",
"location_precision_radius": 167,
"first_scan": "2020-12-18T04:18:49Z",
"last_scan": "2021-01-03T13:56:07Z",
"created_at": "2020-12-14T18:12:28Z",
"scan_count": 7514,
"location_changed": "2021-01-03T13:56:07Z",
"location": {
"lat": 52.210084,
"lng": 17.980257,
"address": "Raty\u0144 101, 62-406, Poland"
}
},
{
"id": 5,
"beacon_id": "c9abec0dca3dea02f28597e41503f10bf574338e",
"serial_nr": "1144758758",
"name": "Theron Beer",
"location_precision_radius": 228,
"first_scan": "2020-12-18T09:22:30Z",
"last_scan": "2021-01-02T16:03:31Z",
"created_at": "2020-12-17T08:07:58Z",
"scan_count": 7566,
"location_changed": "2021-01-02T16:03:31Z",
"location": {
"lat": 46.371671,
"lng": 23.622825,
"address": "DJ107M 91, Poiana Aiudului 517392, Romania"
}
},
{
"id": 22,
"beacon_id": "e6628b1b7afe817b6ab02962289689ac8524e2c7",
"serial_nr": "00345632",
"name": "Angel Rice",
"location_precision_radius": 183,
"first_scan": "2020-12-25T15:08:07Z",
"last_scan": "2020-12-29T08:04:12Z",
"created_at": "2020-12-20T04:23:28Z",
"scan_count": 3476,
"location_changed": "2020-12-29T08:04:12Z",
"location": {
"lat": 56.512517,
"lng": 22.689062,
"address": "Unnamed Road, Zv\u0101rdes pagasts, LV-3883, Latvia"
}
}
],
"_meta": {
"total": 12,
"pages": 2,
"per_page": 10,
"page": 1
}
}
}GET https://mapon.com/api/v1/ble_tags/history_point.jsonid or beacon_id parameter is required. id takes precedence if both are providedid or beacon_id parameter is required. id takes precedence if both are providedYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Z. Datetime must be in GMT timezonescan - returns data for the closest tag scan.location - returns data for the closest tag locationYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Zcar_id, rssi, voltage, temperature and humidity fields can be null.voltage returns values in mV (microvolts).temperature returns values in Celsius.humidity returns relative humidity value as percent.location.lat and location.lng represent the center of the approximated tag location. The approximated location is a circle with radius as specified by the tag location precision radius (or 50m default radius).location.bounds - outer border for the location circle polygon. Returned as array of coords (lat, lng).{
"data": {
"scan": {
"gmt": "2020-12-31T07:54:47Z",
"car_id": 141116,
"car_state": "ignition",
"lat": 48.19944,
"lng": 13.91866,
"address": "Steinpichl 5, 4632 Steinpichl, Austria",
"rssi": -52,
"voltage": 523,
"temperature": 17,
"humidity": 52
},
"location": {
"gmt_from": "2020-12-31T07:54:47Z",
"gmt_till": null,
"lat": 48.199444,
"lng": 13.918659,
"address": "Steinpichl 5, 4632 Steinpichl, Austria",
"bounds": [
[
48.197884,
13.917099
],
[
48.199444,
13.915539
],
[
48.201004,
13.917099
],
[
48.201004,
13.920219
],
[
48.199444,
13.921779
],
[
48.197884,
13.920219
],
[
48.197884,
13.917099
]
]
}
}
}| Code | Description |
|---|---|
| 1 | Missing "id" or "beacon_id" parameters |
| 2 | Requested tag does not exist |
| 3 | Missing "datetime" parameter |
| 4 | Invalid "datetime" parameter |
| 5 | Missing "include" parameter |
| 6 | Invalid "include" parameter. Available values: scan, location |
GET https://mapon.com/api/v1/ble_tags/scans.jsonid or beacon_id parameter is required. id takes precedence if both are providedid or beacon_id parameter is required. id takes precedence if both are providedYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Z. Datetime must be in GMT timezoneYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Z. Datetime must be in GMT timezoneYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Zcar_id, rssi, voltage, temperature and humidity fields can be null.voltage returns values in mV (microvolts).temperature returns values in Celsius.humidity returns relative humidity value as percent.{
"data": {
"scans": [
{
"gmt": "2020-12-31T07:54:47Z",
"car_id": 141116,
"car_state": "ignition",
"lat": 48.19944,
"lng": 13.91866,
"address": "Steinpichl 5, 4632 Steinpichl, Austria",
"rssi": -52,
"voltage": 523,
"temperature": 17,
"humidity": 52
}
],
"_meta": {
"total": 1,
"pages": 1,
"per_page": 10,
"page": 1
}
}
}| Code | Description |
|---|---|
| 1 | Missing "id" or "beacon_id" parameters |
| 2 | Requested tag does not exist |
| 3 | Missing "from" parameter |
| 4 | Missing "till" parameter |
| 5 | Parameter "from" is not a valid datetime |
| 6 | Parameter "till" is not a valid datetime |
| 7 | Invalid period. Period end date must be greater than start date. |
| 8 | Period too large. Maximum allowed period is 31 days. |
GET https://mapon.com/api/v1/ble_tags/locations.jsonid or beacon_id parameter is required. id takes precedence if both are providedid or beacon_id parameter is required. id takes precedence if both are providedYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Z. Datetime must be in GMT timezoneYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Z. Datetime must be in GMT timezoneYYYY-MM-DDTHH:II:SSZ format. Example: 2019-04-08T12:00:00Zlat and lng represent the center of the approximated tag location. The approximated location is a circle with radius as specified by the tag location precision radius (or 50m default radius).bounds - outer border for the location circle polygon. Returned as array of coords (lat, lng).gmt_till can be null if location has not changed{
"data": {
"locations": [
{
"gmt_from": "2020-12-31T07:54:47Z",
"gmt_till": null,
"lat": 48.199444,
"lng": 13.918659,
"address": "Steinpichl 5, 4632 Steinpichl, Austria",
"bounds": [
[
48.197884,
13.917099
],
[
48.199444,
13.915539
],
[
48.201004,
13.917099
],
[
48.201004,
13.920219
],
[
48.199444,
13.921779
],
[
48.197884,
13.920219
],
[
48.197884,
13.917099
]
]
}
],
"_meta": {
"total": 1,
"pages": 1,
"per_page": 10,
"page": 1
}
}
}| Code | Description |
|---|---|
| 1 | Missing "id" or "beacon_id" parameters |
| 2 | Requested tag does not exist |
| 3 | Missing "from" parameter |
| 4 | Missing "till" parameter |
| 5 | Parameter "from" is not a valid datetime |
| 6 | Parameter "till" is not a valid datetime |
| 7 | Invalid period. Period end date must be greater than start date. |
| 8 | Period too large. Maximum allowed period is 31 days. |
Extended information about endpoints and data packs can be found here.
GET https://mapon.com/api/v1/data_forward/list.json{
"data": {
"endpoints": [
{
"id": 1,
"type": "http",
"unit_ids": [
1,
2,
3
],
"data": {
"url": "http:\/\/example.com"
},
"packs": [
1
],
"created_at": "2016-06-17T10:17:16Z",
"queue_length": 0,
"length_updated": "2020-02-27T13:13:27Z",
"dl_queue_length": 0,
"dl_length_updated": "2020-02-27T13:13:27Z"
}
]
}
}| Code | Description |
|---|---|
| 12 | Api key does not have access to all units. All vehicles api key access required |
POST https://mapon.com/api/v1/data_forward/save.json{
"data": {
"status": "ok",
"id": 1
}
}| Code | Description |
|---|---|
| 1 | Invalid data parameter |
| 2 | Invalid packs parameter |
| 3 | Invalid packs parameter. Mixing packs from different types in single endpoint is not allowed. |
| 4 | Invalid unit_ids parameter |
| 5 | Unit already added |
| 6 | Invalid id parameter |
| 7 | Invalid unit_id parameter |
| 8 | Endpoint not found |
| 9 | Error. Save failed |
| 10 | Invalid "data" parameter, "url" not specified |
| 11 | Invalid "url" specified. Please check if url corresponds to the RFC 2396 |
| 12 | Api key does not have access to all units. All vehicles api key access required |
POST https://mapon.com/api/v1/data_forward/add_unit.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 5 | Unit already added |
| 6 | Invalid id parameter |
| 7 | Invalid unit_id parameter |
| 8 | Endpoint not found |
| 9 | Error. Save failed |
| 12 | Api key does not have access to all units. All vehicles api key access required |
POST https://mapon.com/api/v1/data_forward/remove_unit.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 6 | Invalid id parameter |
| 7 | Invalid unit_id parameter |
| 8 | Endpoint not found |
| 12 | Api key does not have access to all units. All vehicles api key access required |
POST https://mapon.com/api/v1/data_forward/delete.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 6 | Invalid id parameter |
| 8 | Endpoint not found |
| 12 | Api key does not have access to all units. All vehicles api key access required |
POST https://mapon.com/api/v1/data_forward/purge.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 6 | Invalid id parameter |
| 8 | Endpoint not found |
| 12 | Api key does not have access to all units. All vehicles api key access required |
GET https://mapon.com/api/v1/data_forward/list_packs.jsonList endpoint all available data packs
Extended information about data packs can be found here.
{
"data": {
"packs": [
{
"id": 1,
"object_type": "car",
"title": "Position",
"description": "Includes: GPS position, speed, direction, time"
}
]
}
}| Code | Description |
|---|---|
| 12 | Api key does not have access to all units. All vehicles api key access required |
POST https://mapon.com/api/v1/report_make/vid1.json{
"data": {
"status": "ok",
"process_id": 1
}
}POST https://mapon.com/api/v1/report_make/reefer_temperature.jsonsetpoint, supply, return, sensors, cargowatch_rear, cargowatch_return, ambient15, 20, 30, 60{
"data": {
"status": "ok",
"process_id": 1
}
}POST https://mapon.com/api/v1/report_make/activity.json{
"data": {
"status": "ok",
"process_id": 1
}
}GET https://mapon.com/api/v1/report/status.json{
"data": {
"status": "finished",
"process_id": "1",
"file_name": "report.xlsx",
"file_url": "https://mapon.com/api/v1\/file.php?1"
}
}GET https://mapon.com/api/v1/report/ely.jsonY-m-dY-m-dH:i. Optional parameter. By default set to 00:00H:i. Optional parameter. By default set to 23:59id for required period.step,lat,lng date - Date. Enabled by default.time - Time. Enabled by default.step - Steplat - Latitudelng - Longitudetemp_left - Temp left (°C)temp_mid - Temp mid (°C)temp_right - Temp right (°C)temp_reserve - Temp reserve (°C)screed_width - Screed width (m)screed_selector - Screed selectorscreed_left_volt - Screed left (mV)screed_right_volt - Screed right (mV)ambient_temp - Ambient Temperature (°C)ambient_humidity - Ambient Humidity (%)screed_left - Screed left (mm)screed_right - Screed right (mm)columns, rows, nextCursor:columns - Selected columns, rows - Data according to selected columns, nextCursor - Date time of the item in the next page.{
"data": {
"columns": [
"date",
"time",
"step",
"lat",
"lng",
"temp_left",
"temp_mid",
"temp_right",
"temp_reserve",
"screed_width",
"screed_selector",
"screed_left_volt",
"screed_right_volt",
"ambient_temp",
"ambient_humidity",
"screed_left",
"screed_right"
],
"rows": [
[
[
"2022-12-13"
],
[
"02:06:50"
],
[
"ON"
],
[
"41.5373"
],
[
"2.237"
],
[
"0,0"
],
[
"0,0"
],
[
"0,0"
],
[
"0,0"
],
[
"2,500"
],
[
"2,50 m"
],
[
"0"
],
[
"0"
],
[
"0,0"
],
[
0
],
[
"0"
],
[
"0"
]
],
[
[
"2022-12-13"
],
[
"02:14:50"
],
[
"ON"
],
[
"41.5373"
],
[
"2.237"
],
[
"0,0"
],
[
"0,0"
],
[
"0,0"
],
[
"0,0"
],
[
"2,500"
],
[
"2,50 m"
],
[
"0"
],
[
"0"
],
[
"0,0"
],
[
0
],
[
"0"
],
[
"0"
]
]
],
"nextCursor": "2022-12-13 01:26:51"
}
}| Code | Description |
|---|---|
| 1 | Access denied! - Invalid user |
| 2 | Missing or invalid date_from parameter! |
| 3 | Missing or invalid date_to parameter! |
| 4 | Missing or invalid time_from format! |
| 5 | Missing or invalid time_till format! |
| 6 | Invalid next_cursor format! |
| 7 | Missing unit_id parameter! |
| 8 | Unit not found! |
| 9 | limit limit exceeded! |
| 10 | Requested time period must not exceed 31 days! |
POST https://mapon.com/api/v1/application/user_auth_by_token.json{
"data": {
"users": [
{
"id": 1,
"company_id": 1,
"user_api_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"email": "info@example.com",
"name": "Janis",
"surname": "Berzins",
"timezone": "Europe\/Riga",
"language": "lv",
"phone": null,
"type": "admin",
"distributor_id": 1,
"distributor_name": "Distributor name",
"distributor_url": "https:\/\/distributor_url.com",
"distributor_logo": "https:\/\/distributor_url.com\/path_to_logo"
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid user_token parameter |
| 2 | Company has not authorized this application |
| 3 | User not found |
| 4 | Too many requests |
POST https://mapon.com/api/v1/application/company_auth_by_token.jsonWhen system administrator from CRM enables application for specific company, there will be
a POST request to 3rd party application's end point with field company_token.
Application must call application/company_auth_by_token together with
company_token to request company_id and company_api_key
which can be stored in 3rd party applications side for later use.
End point for company_token is provided by 3rd party application's developer. In
response to this request, we expect to get the following JSON response:
{"status":"ok"}
In case of an error, application will not be enabled for the company and system administrator can retry this process later.
{
"data": {
"companies": [
{
"company_id": "1",
"company_api_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
]
}
}| Code | Description |
|---|---|
| 1 | Invalid company_token parameter |
| 2 | Not found company_token |
GET https://mapon.com/api/v1/application_fields/list.jsonList all available fields by providing entity type
{
"data": {
"items": [
{
"id": 1,
"type": "select",
"title": "My field name",
"title_translation": "",
"attributes": "{\"options_per_company\":true,\"readOnlyEdit\":true}",
"validation_rules": "[{\"regex\":\"\/.+\/\",\"error\":\"field is mandatory\"}]",
"default_value": "10"
}
]
}
}| Code | Description |
|---|---|
| 1 | Application not found |
| 4 | Invalid entity parameter |
POST https://mapon.com/api/v1/application_fields/updatevalue.jsonUpdate field value by providing field id, entity type and entity id.
{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Application not found |
| 2 | Invalid field_id parameter |
| 3 | Field not found |
| 4 | Invalid entity parameter |
| 5 | Can`t access entity with specified id |
| 6 | Field validation error (With validation error message) |
POST https://mapon.com/api/v1/application_fields/updateoptions.jsonFor field type = select. Options must be valid JSON string. Example: {"Canada":{"AB":"ALBERTA","BC":"BRITISH COLUMBIA"},"Mexico":{"AG":"AGUASCALIENTES"}} or {"1":"Canada","2":"USA"}
If field is configured to have options defined per company, provide company_id
{"Canada":{"AB":"ALBERTA","BC":"BRITISH COLUMBIA"},"Mexico":{"AG":"AGUASCALIENTES"}}{"1":"Canada","2":"USA"}{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Application not found |
| 2 | Invalid field_id parameter |
| 3 | Field not found |
| 4 | Options only supported for field type select |
| 5 | Options must be valid json string |
| 6 | There was an unknown error. Contact support. |
GET https://mapon.com/api/v1/application_menu/list.json{
"data": {
"items": [
{
"id": 1,
"parent_id": 0,
"title": "My App",
"path": ""
}
]
}
}POST https://mapon.com/api/v1/application_menu/save.jsonInsert/Update menu item. Edited menu items will be available after 5 minutes frontend cache expire.
You can also update first level menu item by passing parent_id = 0.
Iframe url will be formatted after this structure app_base_url + path + ?user_token=
{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Application not found |
| 2 | Menu item not found |
| 3 | Invalid parent_id parameter |
| 4 | Invalid title parameter |
POST https://mapon.com/api/v1/application_menu/delete.json{
"data": {
"status": "ok"
}
}| Code | Description |
|---|---|
| 1 | Application not found |
| 2 | Menu item not found |
| 3 | Invalid id parameter |
| 4 | Menu items with parent_id = 0 can't be deleted |