1 of 100

Navixy API

General information

Navixy Developer Documentation

Getting started with Navixy API

is a comprehensive GPS/Vehicle telematics platform developed by . This documentation provides detailed information on integrating third-party solutions with the Navixy platform, including API and technical documentation tailored for developers and partners.

How to use this documentation

The documentation is organized into sections, each addressing a specific aspect of the Navixy platform:

API automation tools

In today's fast-paced development landscape, automation is key to efficiency. Whether you're testing API endpoints, integrating services, or building custom workflows, the right tools can make the process seamless. This section introduces powerful automation solutions that help developers interact with Navixy’s API more efficiently.

Here, you'll find guides on how to use industry-standard tools to streamline API requests, automate interactions, and enhance system integrations with Navixy. As we continue expanding, more tools will be added to this collection, providing you with a growing set of resources to optimize your API-driven workflows.

Tools in this section:

A popular API client for testing and interacting with Navixy’s endpoints. Learn how to send requests, authenticate, and explore the full potential of Navixy’s API in a controlled environment.
A no-code automation platform that connects Navixy with thousands of apps. Set up triggers and actions to automate workflows without writing a single line of code.

Using Postman with Navixy

Testing API with Postman

When working with API requests, developers have a wide range of tools at their disposal, from simple browser inputs to advanced software solutions. One of the preferred tools among developers is Postman, a robust platform for API development. Postman excels in various tasks, including simple request testing, API creation, and ongoing maintenance.

Navixy streamlines API integration by offering ready-made Postman collections. These collections allow developers to quickly import, test, and modify API requests without manual setup, enhancing efficiency and simplifying the process of interacting with Navixy's platform.

Navixy Postman Collections URL:

Navixy API Sandbox in Postman URL:

For this guide, we will focus on using Postman as an API client.

Translate Navixy

Instructions to add localizations for Navixy Platform

Navixy is dedicated to global accessibility, offering support for a wide range of languages to cater to users worldwide. The platform is designed to be versatile, accommodating both left-to-right and right-to-left languages. We continually expand our language support through contributions from our vibrant community of translators. If the language you need isn't yet supported, we invite you to join us and help expand our multilingual capabilities.

Currently Supported Languages

Navixy currently supports dozens of languages, with more being added regularly. For the most up-to-date list of supported languages, visit our regional settings documentation.

How to Become a Contributor

We welcome and appreciate all contributions. By joining our community of translators, you help make Navixy more accessible and user-friendly for people around the world. Start translating today and become part of a global effort to enhance the Navixy platform.

Step 1: Get Access to Crowdin

To start contributing, you will need access to our Crowdin project. is an online translation service developed specifically for team-based translation projects. Contact your Navixy representative and provide your Crowdin account details to be associated with the Navixy Crowdin project.

Step 2: Choose Your Translation Method

There are two primary methods to localize the Navixy platform:

Crowdin In-context Translation (Web UI Only)
Crowdin UI Translation

Crowdin In-context Translation (Web UI Only)

This method is the most convenient way to translate the Navixy Web UI. Use the following link to launch the Crowdin In-context service:

<https://demo.navixy.com/?locale=ach#/login>

After logging in, the standard Navixy UI will appear in a special translation mode. Click on the small icon next to each text item to open the translation dialog and make your edits.

Crowdin UI Translation

For a more comprehensive translation experience, use the Crowdin UI. This method is essential for translating backend components and mobile apps. Translations in Crowdin are organized into several directories:

Common Server properties, API server properties, Tracking server properties, SMS server properties: Translation strings for backend (mainly for reports, SMS, and email notifications).
Future Web UI, Legacy Web UI: Translation strings for Navixy Web UI.
android-client, android-tracker, navixy-tracker-ios, navixy-viewer-ios: Translation strings for mobile apps.

Each directory contains specific strings for translation, which you can edit directly in the Crowdin interface.

Contributing to New or Existing Languages

Adding a New Language

If you want to add a new language:

Obtain a Crowdin account by contacting your manager.
Use either the In-context translation method or the Crowdin UI to start translating.
Notify your manager once the translation is complete. The development team will then add the new language to the platform.

Improving Existing Translations

To improve existing translations, follow the same steps as above, but focus on refining and enhancing the current language packs. Your contributions will be reviewed and, once approved, will be automatically deployed to the production environment.

Translation Delivery

Deploying translations to the production environment typically takes about a week. For on-premise installations and mobile apps, this timing depends on their respective release schedules. Once your translation work is complete, notify your Navixy representative to ensure your contributions are integrated into the platform.

Contact Us

Contact Navixy Team

Need Assistance?

If you have any questions or need support, our team is here to help. Reach out to us through any of the following methods:

Phone:

Platform API

Navixy platform API

Welcome to the Navixy User Interface API documentation. This section contains all the sections for requesting information that users have access to in the user interface.

Here are the following sections:

: In this section, you will learn how to access raw data from trackers received by the platform.
: In this section, you will find API calls that allow you to retrieve all the information available to users on the platform. This includes data and actions related to trackers, their trips, sensor and counter data, reports, vehicles, drivers and employees, tasks, and much more information that your integrations may need.

Guides and Examples

The "Guides and Examples" section of the Navixy API documentation is designed to provide you with practical, step-by-step instructions for common tasks you can perform with the Navixy API. Whether you're managing devices, tracking data, setting up geofences, or handling notifications, these guides will help you make the most of the Navixy platform.

Device Management

Learn how to activate a device on the Navixy platform to start tracking and monitoring.

Data retrieval

Device management

Sending Commands to a GPS Tracker via IP protocol (OTA)

Most modern GPS tracking devices can be reconfigured remotely using IP commands sent over-the-air (OTA). With the Navixy API, you can easily change device configurations or develop applications that allow users to send commands directly from the UI. These commands can also be integrated into automation rules, status changes, or parameter triggers, offering extensive flexibility and customization for managing your telematics solutions.

Sending a Command

To send a command to a device, you only need the following parameters:

tracker_id: The ID of the device to which you want to send the command.
command: The text or hexadecimal representation of the command in a protocol-dependent manner.

Example: Reconfiguring a Teltonika FMB140 Device

Suppose you have a Teltonika FMB140 device with an ID of 231402 on the platform, and you want to reconfigure its IP address to 52.57.1.136. According to the protocol, the command should be:

setparam 2004:52.57.1.136

API Request

To send this command, use the API request :

Upon successful execution, the platform will confirm that the command has been sent.

This method provides a reliable and efficient way to manage and control your GPS tracking devices via IP, ensuring seamless and real-time updates to device configurations.

Field service management

Changing Employee Statuses

Employee statuses track the current activity of employees via their tracking devices. Examples include "busy" and "not busy." Each tracker can have a different status list assigned.

Create

To manage employee activities effectively, create working status lists and assign them to devices. For instance, a status list for a delivery service allows drivers and supervisors to change their working status using the X-GPS app or the UI.

To create a working status list, use the status/listing/create method. You need to provide the listing parameter, which is a status_listing object without the "id" and "entries" fields.

Example Request to Create a Working Status List

Example Response

Next, add individual working statuses to the list. For example, you might have the following statuses: "Free," "Break," "Pick up the goods from storage," and "Deliver goods."

Example Request to Add a Working Status

Example Response

Repeat the above request for each working status you need to add to the list.

Assign

To assign the working status list to devices, use the tracker_id and listing_id.

Example Request to Assign a Status List to a Tracker

Example Response

Usage

Once assigned, drivers and supervisors can change working statuses. Here are some use cases:

Automated Task Assignment: Create a script to assign a new task to a driver with the working status "Free." After assigning the task, the script changes the working status to "Pick up the goods from storage."
Task Completion: When a task is completed, a script changes the working status to "Free" and retrieves fields from the ERP system to create a new task and assign it to the driver.

This flexible system allows for efficient management of employee activities and can be integrated with various business processes for automation.

Fleet management

Using Driver Journals

Driver Journals log all trips made by an employee within a selected period, categorizing them by status: business, private, or other. Users can view a summary of all trips, highlighting their statuses, or filter to show only specific types. This data can be exported as PDF/Excel files or printed directly.

Driver Journals provide detailed trip information, including mileage, location, date, and time, enabling clients to differentiate between business and personal miles accurately. This helps in deducting business-related expenses. For ambiguous cases, trips can be marked as "other" and later reviewed for proper categorization.

All trip data is securely stored digitally, eliminating the need for physical paperwork. However, supporting receipts for expenses like fuel should be kept for verification.

For example, to generate a bill for fuel payment, you may need to categorize all trips of a device for the previous day. These records include important trip details such as driver, start/end dates, locations, trip length, and odometer readings, which can be used in your CRM.

Places

Managing Geofences

Geofences are virtual perimeters for real geographic areas. The Navixy platform can monitor whether an object equipped with a GPS tracker crosses a geofence border (either entering or exiting). All such events are logged, enabling users to obtain geofence reports and receive alerts. Furthermore, various rules can be assigned to events related to specific geofences. For instance, you might want to receive speeding alerts only within a certain area, such as a city or along a specific route.

Geofence Creation

To create a geofence, use the API call. There are several types of geofences, and the creation process varies between them.

Rules and notifications

Receiving Push Notifications in Your App

Push notifications enable your app to receive new events instantly without requiring continuous polling via API calls. These notifications can be leveraged to trigger actions such as updates to trackers, configurations, tasks, or even to send alerts to platforms like Telegram.

Whether your app is mobile or web-based, the subscription process for push notifications varies. Below, we outline the specific steps for each case.

Mobile Apps

The Navixy platform supports Firebase Cloud Messaging (FCM).

To get push notifications on mobile devices, follow these steps to obtain the app's push token:

Working with Notifications

Notifications are a crucial part of tracking. A created rule tracks the triggering of specified conditions and sends events to emails and phones. Notifications alert users when a condition is triggered. Sometimes, it is necessary to store these notifications and history entries for special reports or for use in scripts built on APIs. This guide will show you how to work with them using the Navixy API.

Obtain a List of History Entries

All Unread Events of a User

Use the call to get all unread events.

This call contains only two optional parameters:

limit: An integer specifying the maximum count of entries in the response.
from: A string containing the start for the search. Without this parameter, you will get all unread entries for the last 30 days.

Example: To obtain no more than 100 entries for the last month (assuming today's date is 2021-01-26), the API request will be:

The response will contain a list of history entries with that can be used for various purposes:

Events for Specific Trackers and Time Period

Use the call to get all events for specific trackers over a specified time period. This call can also return specific event types sorted by time if necessary.

Required Parameters

trackers: An array of integers. A for which events will be searched.
from: A string containing the start for the search.
to: A string containing the end for the search. Must be after the from date.

Optional Parameters

events: An array of strings with the necessary event types. All other events will be ignored. Default is all. To get a list of events, use the call.
limit: An integer specifying the maximum count of entries in the result.
ascending: A boolean that sorts the results in ascending order by time when true and descending when false

Example: To obtain no more than 100 entries for December for one device, sorted in descending order by time, and to know only when the device entered and exited the geofence, the API request will be:

The response will contain the that match the request.

All Events of a User for a Specific Time Period

To obtain a list of all tracker events for a user received between the specified "from" and "to" dates, use the method. You can also filter the results to include only the necessary event types.

Required Parameters

from: A string containing the start for the search.
to: A string containing the end for the search. Must be after the from date.

Optional Parameters

events: An array of strings with the necessary event types. All other events will be ignored. Default is all. To get a list of events, use the call.
limit: An integer specifying the maximum number of entries in the result.
ascending: A boolean that sorts the results in ascending order by time when true and descending when false

Example: To get state field events for the last five minutes on all trackers of a user, use to=CURRTIME and from=CURRTIME-5 minutes. Filter by state_field_control events.

The response will contain the that match the request.

Resources

Welcome to the Navixy API resources section. Here you'll find detailed information about all available resources.

Tracking

Beacon

Route

Getting route

API call for getting the route to destination point.

API actions

API path: /route.

get

Gets route points via specified route provider.

Parameters

name

description

type

location object described in .

Example

cURL

Response

distance - int. Length in meters.
time - int. Duration in seconds.
list - list of route points. Location objects.

Errors

215 - External service error.
218 - Malformed external service parameters.
236 - Feature unavailable due to tariff restrictions – if there is at least one tracker without "routing" tariff feature.

Getting route with Progorod

API call for getting the route to destination point using .

API actions

API path: /route/progorod.

Status

Listing

Tracker's working status list

Contains API call which link together trackers and working status lists.

Contains api call which link together trackers and working status lists.

API actions

API base path: /status/listing/tracker.

Track

Waybill

Waybill settings

Contains API call to get the last waybill number.

Contains API call to get the last waybill number. Waybill number saved when new waybill had downloaded. If it had only digits, then it was incremented before saving.

API actions

API base path: track/waybill/settings/.

read

Gets last waybill number.

Examples

Response

Errors

201 - Not found in the database – if user have never downloaded a waybill.

Alarm mode for tracker

Contains API calls to read and set alarm mode of device.

API actions

API base path: /tracker/alarm_mode.

read

Gets the state of alarm mode of device.

Parameters

name

description

type

format

Examples

Response

enabled - true if alarm mode enabled.

Errors

204 – Entity not found - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
214 – Requested operation or parameters are not supported by the device - if device does not support alarm mode.

set

Changes the state of alarm mode of device. The device must be online.

Parameters

name

description

type

format

Examples

Response

Errors

204 – Entity not found - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
213 – Cannot perform action: the device is offline - if corresponding tracker is not connected to the server.
214 – Requested operation or parameters are not supported by the device - if device does not support alarm mode.

APN settings by tracker ID

Contains API call to get APN settings by tracker ID.

This resource contains API call to get APN settings by tracker ID. APN is short of Access Point Name and provides a device with the information needed to connect to wireless service.

API actions

API base path: /tracker/apn_settings.

Avatar for the tracker

Contains API call to upload avatar for the tracker.

API actions

API base path: /tracker/avatar.

upload

Contact

API call to get user's trackers with special grouping by "contacts"

Deprecated! This API action deprecated and should not be used.

API actions

API base path: /tracker/contact

Datalogger

API call for uploading datalogger information.

API actions

API base path: /tracker/datalogger.

upload

Engine immobilizer

API requests to read the state of immobilizer and to set the new state.

API calls to read the state of immobilizer and to set the new state. Engine immobilizer is an electronic security device fitted to a motor vehicle that prevents the engine from running unless it must run. This prevents the vehicle from being "hot wired" after entry has been achieved and thus reduces motor vehicle theft. This API call allows manipulating with immobilizer state.

API actions

API base path: /tracker/engine_immobilizer.

Mobile app register

API call to register a mobile application. Deprecated.

Deprecated! This API action deprecated and should not be used.

API call to register a mobile application. Use with plugin_id 35.

Trusted number

API calls to interact with list of trusted numbers for trackers.

API actions

API base path: /tracker/trusted_number.

list

Command

Unconfirmed commands

API calls for to interact with unconfirmed SMS commands in the queue of the specified tracker.

API actions

API path: /tracker/command/unconfirmed.

count

Gets number of commands in queue for the specified tracker.

Parameters

name

description

type

format

Examples

Response

count - int. Number of unconfirmed commands in a queue.

Errors

204 – Entity not found - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

reset

Removes all pending SMS commands from the queue for the specified tracker.

required sub-user rights: tracker_update.

Parameters

name

description

type

format

Examples

Response

Errors

204 – Entity not found - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

Rules

Sensor

Settings

Tracker settings actions

API calls to get and change tracker's label and group.

API actions

API base path: /tracker/settings.

read

LBS settings

API calls for reading and changing LBS settings.

Contains API calls for reading and changing LBS settings. It is responsible for the LBS detection radius portlet in devices and settings tab in the UI. LBS (Location-based service) technology allows to determine the tracker's location without using standard location services such as GPS, GLONASS, Galileo or Beidou. LBS locates the position using cellular base stations or Wi-Fi access points.

API actions

API base path: /tracker/settings/lbs.

Special

Stats

Backend functionality

Getting started with Navixy Backend API

Introduction

Welcome to the Navixy Backend API documentation. This guide is designed to help developers integrate third-party solutions with the Navixy platform. Here, you will find comprehensive information on API calls, workflows, and best practices.

Overview

The Navixy API provides a set of RESTful endpoints that allow you to interact with various entities such as geofences, rules, objects, and more. The API calls for CRUD and other operations with these entities follow a consistent naming convention, making it easier to understand and use.

Standard Workflow

To give you a clear idea of how to work with the Navixy API, let's go through a standard workflow using a common example – requesting track points data.

Determine the URL to API calls:
- Depending on the physical location of the platform, the base URL will be:
  - https://api.eu.navixy.com/v2 for European Navixy platform;

API Base URL

Depending on the physical location of the platform, use one of the following base URLs:

European Navixy platform:https://api.eu.navixy.com/v2
North American Navixy platform:https://api.us.navixy.com/v2
Self-hosted (On-Premise) installations:https://api.your_domain

For example, to make a user/auth API call on the European Navixy ServerMate platform, you should use the URLhttps://api.eu.navixy.com/v2/user/auth

API Calls Format

API calls follow a consistent notation: /resource/sub_resource/action(parameter1, parameter2, [parameter3])

Parameters can be passed in different ways:

HTTP POST application/json: Recommended
HTTP POST application/x-www-form-urlencoded: Parameters in the request body
HTTP GET: Not recommended, should be used only for idempotent requests with small parameter size

Examples

HTTP POST application/json

HTTP POST application/x-www-form-urlencoded

HTTP GET

Request and Response Format

To make an API call, send a POST request to:[api_base_url]/resource/action/

The response will be given with application/json content type, even for errors. Response fields and object structure are specific to the API call.

Ensuring Compatibility

Our API evolves over time, and new methods and JSON object fields are added. We strive to maintain backward compatibility with legacy API clients. However, you must ensure that any unsupported JSON object fields by your app are ignored, and that your application can handle new JSON fields without breaking. Also, to reduce response size, JSON fields that are NULL are omitted. Your JSON parser should handle missing JSON fields as if they were NULL.

Authorization and Access Levels

Unless otherwise noted, every API call requires a valid API Key hash. This hash can be passed in one of the following ways:

As a hash parameter of the request body (root-level property for application/json).
As a hash parameter of the HTTP query string.
As a value of the HTTP header

Data Types

Type

Description

String Validation Rules

This validation ensures that the provided string adheres to specific content rules. The rules may vary depending on the particular field being validated. The string is checked for the following criteria:

Empty strings or null values: may be allowed or restricted depending on the specific field.
Character types:
- Regular spaces are always allowed (Unicode category "Zs").
- Other whitespace characters (tabs, line breaks, etc.): may be allowed or restricted depending on the specific field.

Date/Time Formats

Date/time type can be represented with the following formats:

yyyy-MM-dd HH:mm:ss format (in user's timezone), default
yyyy-MM-dd'T'HH:mm:ssZZ

To use ISO 8601 date/time format, pass true to:

iso_datetime parameter of the request body (root-level property for application/json).
iso_datetime parameter of the HTTP query string.
HTTP header NVX-ISO-DateTime.

Example

JSON request body parameter

Form request parameter

HTTP Header

Response Example with Fixed Offset Date/Time

Response Example with UTC Date/Time

Next Steps

: Learn how to authenticate and obtain a user key
: Understand how to handle errors in the Navixy API

Platform authentication

The Navixy platform API supports two authentication methods:

User session hash: The basic, mandatory authentication method obtained through user login
API key: The recommended, more secure method for ongoing API access and integrations

1. User session hash (basic authentication)

A session hash is the basic authentication token in the Navixy system and serves as the starting point for authentication workflows.

Use session hashes for:

Initial system access
User interface operations
Short-term scripts

Session hash limitations:
Expires after periods of inactivity (30 days)
Invalidated when logging out or changing password
Requires periodic renewal for longer sessions
Less secure for automated processes

Obtaining a session hash

To get a session hash, send a POST request to the user authentication endpoint {baseURL}/v2/user/auth providing your account's login and password as parameters:

Successful response:

Copy the hash parameter value and save it, you will use it for authenticating your further requests.

2. API keys (recommended authentication)

API keys are a more stable and secure authentication method, it is recommended for long-term use with all production integrations and automated systems. Here's a comparison with session hash to highlight API key advantages:

Feature

API Keys

Session Hashes

API key limitations:
Every user account may have up to 20 API keys
Only account Owners have access to API keys functionality

Creating API keys

API keys should be created through the Navixy web interface:

Login to the Web Interface:
- Access the Navixy user interface via the web.
- Use your credentials to log in.
Navigate to the API Key Section:

Using authentication in API requests

You can include your authentication credentials in requests trough three different methods. Each method has specific use cases and security considerations.

1. As a request header (recommended)

Include the hash in the Authorization header

This is the most secure method and follows API best practices. It keeps authentication separate from request data and works well with all HTTP methods.

2. In the request body

Include your authentication directly in the JSON body of your request as hash parameter:

This method works only with POST requests and mixes authentication with request parameters. It can be useful for testing but is less ideal for production use.

3. As a query parameter (testing only)

Append your authentication hash to the URL as a query parameter:

This method is for testing purposes only as it exposes your authentication credentials in URLs, server logs, and browser history. Never use this method in production environments.

Managing API keys

These endpoints allow you to manage your API keys through the API itself using a valid session hash.

Listing API keys

Get a complete list of all API keys associated with your account:

This endpoint returns all your active API keys with their labels and creation dates, helping you manage and audit your integrations.

Deleting an API key

Immediately revoke an API key when it's no longer needed or if it may have been compromised:

Any application using this key will immediately lose access and need to be reconfigured with a new key.

Recommended authentication flow

After understanding the available authentication methods, follow this recommended progression for integrating with Navixy platform API:

Initial authentication
- Log in to the needed user account in Navixy UI with username/password
- Make sure that you hace Owner role in the account
- Now you are ready to create API keys

Authentication errors

Understanding authentication errors helps you troubleshoot issues and implement proper error handling in your integration:

Common authentication error codes:

Code 3: Wrong hash - Your API key or session hash is invalid or has been revoked
Code 4: User or API key not found or session ended - User or session hash don't exist or expired
Code 7: Invalid parameters - Inserted request parameters are incorrect

Your integration should handle these errors appropriately, possibly by prompting for re-authentication or alerting administrators about potential issues.

Best practices

Follow these guidelines to ensure secure and effective authentication:

Log in to the needed Navixy account to access the system initially - Owner account role is needed
Create and use API keys for all ongoing integration needs - they provide more stable, secure access
Use separate keys for different integrations for better management and security isolation
Add descriptive labels to easily identify the purpose of each key when viewing your key list

Tracking Stationary Objects with BLE Tags

Integrating objects into the Internet of Things (IoT) is simplified with the Navixy platform, which supports tracking both movable and stationary objects. Examples of stationary objects include heavy equipment, agricultural machinery, cargo, goods, and security equipment. Installing GPS devices on each of these objects can be very expensive. A more cost-effective solution is to install one device on a vehicle or site and track the rest using inexpensive Bluetooth Low Energy (BLE) tags.

In this tutorial, we will guide you through the process of tracking stationary objects. We will discuss the following:

How to organize tracking for stationary objects
Which GPS devices and BLE tags to use for data collection
Step-by-step setup instructions, using truck trailers as an example
How to obtain information about trips and usage for subsequent service work
The API calls needed to retrieve information about the tags
Additional use cases based on real-world scenarios

Additionally, you can read more about configuration examples in our .

What you need to track stationary objects

Various devices are able to read data from BLE beacons: Galileosky, Quecklink, Ruptela, Teltonika, TopFlyTech. In this example, we will use the Teltonika FMB920 model and the BLE beacon Eye Sensor. To begin tracking stationary objects, you'll need the following:

A GPS device that can read BLE tags and is supported by the platform.
BLE tags that are compatible with the GPS device. Many BLE tags can transmit information about temperature, humidity, and their battery charge, enhancing their tracking capabilities. For our purposes, we will focus on stationary objects specifically.
Platform APIs that provide information about which GPS device a particular tag is near. To create custom solutions for your users using these APIs, you will need developers. Clients typically hire their own developers or contract third-party teams.

Now let's examine the procedure for implementing a real-world case study: tracking truck trailers for trip and usage information and subsequent service work.

How to get information about BLE beacons near the GPS device

You can read information from it:

tracker_id - int. The ID of the tracker (also known as “object_id”).
hardware_id - string. The ID of the beacon.
rssi - int. RSSI stands for received signal strength indicator and represents the power of the received signal on a device. This value helps determine the distance between the beacon and the tracker.

API calls to get information about BLE tags

There are two API calls that allow you to get all the necessary information about BLE beacons:

Historical data from BLE tags

The first call retrieves . You can set the from and to parameters for obtaining data during a specific period about connected BLE beacons. Since we need the information from the BLE tags' point of view, i.e., the trailers, let's request the information using the beacons parameter.

Request example:

This will show which devices were in the vicinity of this BLE beacon during period

Last data from BLE tags

The second call retrieves information about to a specific device. For example, if you want to know which trailer is currently near the device, use the following request:

Request example:

This will provide information that there is a trailer with the identifier 7cf9501df3d6924e423cabcde4c924ff located next to the device.

Obtaining information on trip details and usage time

We've already gathered historical data using the first of the presented API calls, which showed on which devices the trailer was displayed at a specific time. To get information about the journeys and usage time of this trailer, we simply need to use one of the two API calls:

Overall trip info

API call to get trip information for the period. This will provide general information about the trips, such as where and when they started and ended, maximum speed, mileage, and more.

Request example:

Response:

From this data, we can see that the trip lasted nearly 35 minutes (end_date - start_date), with an average speed of 49 km/h and a maximum speed of 62 km/h. The trip length was 18.91 km. This information allows us to determine how much to pay the driver for transporting the cargo, whether the contractual speed was exceeded, and other details. Additionally, the trip length can be used in the future to calculate the number of kilometers until the next maintenance of the trailer.

Detailed trip info

If you want a detailed track record of the trailer where the beacon is installed for displaying it in a report, for example, you can use the track/read request. This will give us data on all the points received by the platform during the journey.

Request example:

Response:

You can use these points together with your preferred maps API to display them on a map.

Other examples of using BLE tags

Here are some other examples of how to use BLE tags with a short algorithm to get the necessary results need:

Child seats

Child seats are mandatory for passengers traveling with children. If you or the user operates a passenger transportation service, knowing whether a child seat is available in a vehicle can help you quickly determine which drivers are suitable for certain passengers and avoid wasting time and fuel. You can also find out which driver currently has a child seat installed in their vehicle. Additionally, it's important to consider passengers with two or more children and identify cars equipped with more than one child seat.

To address this, you'll need to install a BLE beacon on each child seat. Next, let's say your transport booking app needs to request information from all drivers who have a child seat installed. To do this, use the beacon/last_values API call to gather information about which drivers can be assigned to a particular order.

You can also use the RSSI parameter to determine if the seat is located inside the vehicle or in the trunk. To accomplish this, you'll need to conduct a few tests. For example, if the RSSI value is lower in the passenger compartment than in the trunk, the seat is likely in the trunk. As a result, you can prioritize your search for vehicles – first, those with a child seat in the passenger compartment, and then those with a child seat in the trunk. This approach ensures that you efficiently match passengers with appropriate vehicles and drivers.

Agricultural machinery

Suppose your client has agricultural machinery that can be connected to various equipment. How can you track which tractor is using a seeder and which has a plow? This information will help you understand the frequency and extent of tool usage, and also determine their current location. This way, workers can spend more time working in the field rather than searching for equipment. To achieve this, install devices on tractors and combines, as well as in tool storage areas. Place one BLE beacon on each tool in a secure spot where it is difficult to remove, preventing it from getting lost during work. Next, to determine how long the tools have been in use, query the beacon/read API call. The information from the response will be helpful, just like with the trailers in our detailed example. To determine the location of a specific tool, query beacon/last_values with a search for beacons to identify where and on which device the tool is installed. This approach ensures efficient tracking and utilization of your agricultural equipment, ultimately increasing productivity.

Use on construction sites

Construction sites often have numerous tools and expensive equipment. While installing a beacon for tracking purposes is beneficial, another concern arises – how can you ensure that the equipment is tracked frequently, and that the GPS tracker doesn't run out of power? To monitor the usage and location of the equipment, BLE beacons can also come in handy.

The solution for construction sites can be similar to that of agricultural machinery – install devices on the machinery as well as on storage sites. This approach allows you to effectively track your valuable equipment, ensuring that it's being used efficiently and minimizing the risk of loss or misplacement. By keeping a close eye on your tools and machinery, you can optimize productivity at the construction site.

Indoor tracking

You can effectively track items indoors using the platform and BLE tags. All you need to do is install GPS devices in different parts of the warehouse or building and tag the objects you want to track. Here are a few examples:

Tracking employees in various areas of a warehouse or store: This allows you to know which area an employee is in or how many sales assistants are near the information desk. Having this information helps improve efficiency and ensures that staff members are where they need to be.
Tracking goods or machinery in different areas of the warehouse: Knowing the location of goods or equipment saves time, as you don't have to search for them throughout the warehouse. This streamlines the retrieval process, making your operations more efficient.

Tracking goods with BLE beacons

Utilizing BLE beacons for tracking can greatly benefit transport companies by allowing them to determine which truck is carrying a specific pallet of goods at any given moment. This method not only enables the tracking of goods' paths but also helps calculate transport costs more accurately.

By adopting this innovative approach, transport companies can enhance their operations, making them more efficient and precise. This ultimately leads to better service for clients and more streamlined business processes.

Rule

API calls to interact with tracker's rules. Rules used to set up conditions according to which the system logs the events and sends notifications to user.

Contains API calls to interact with tracker's rules. Rules used to set up conditions according to which the system logs the events and sends notifications to user.

Described creation and using rules step-by-step in the guide.

Rule object

id - int. An ID of a rule.
name - string. Name of a rule.
type - enum. One of pre-defined types of rules. See .
description - string. Rule's description.
zone_ids - int array. List of geofence IDs.
trackers - int array. List of bound tracker IDs.
primary_text - string. Primary text of rule notification.
secondary_text - string. Secondary text of rule notification.
param - int. A common parameter. See .
alerts - object with destinations for notifications.
- sms_phones - string array. Phones for SMS notifications.
- phones - string array. Phones for voice calls.
suspended - boolean. true if the rule suspended.
auto_created - optional, boolean. true means that the rule created automatically.
shedule - optional object. The rule will work in specified period.
extended_params - optional. An object specified for concrete rule type. See .
schedule_interval is one of:
- weekly_schedule_interval
- fixed_schedule_interval
date/time and local_time types described at the .

API actions

API base path: /tracker/rule.

bind

Binds rule with rule_id to trackers list.

required sub-user rights: tracker_rule_update.

Parameters

name

description

type

Example

cURL

Response

Errors

201 - Not found in the database – if rule with rule_id does not exist or owned by other user.

create

Creates rule and scheduled intervals.

required sub-user rights: tracker_rule_update.

Parameters

Presented parameters are common for all rule types. However, there are specific parameters primary_text and secondary_text that are described for every rule type if exist in .

name

description

type

Example

cURL

Response

id - int. An ID of created rule.

Errors

204 - Entity not found – when associated zone is not exist.

delete

Deletes rule with rule_id and all related objects from the database.

required sub-user rights: tracker_rule_update.

Parameters

name

description

type

Examples

Response

Errors

201 - Not found in the database – if rule with rule_id does not exist or owned by other user.

list

List tracker rules bound to tracker with an ID=tracker_id or all users' tracker rules if tracker_id not passed.

Examples

Response

list - list of rules

unbind

Unbinds trackers from rule with rule_id.

required sub-user rights: tracker_rule_update.

Parameters

name

description

type

Examples

cURL

Response

Errors

201 - Not found in the database – if rule with rule_id does not exist or owned by other user.

update

Updates rule and scheduled intervals.

required sub-user rights: tracker_rule_update.

Parameters

Presented parameters are common for all rules, but there are specific parameters that can be found in .

name

description

type

Example

cURL

Response

Errors

201 - Not found in the database – if rule is not exists or owned by other user.
204 - Entity not found – when new associated zone is not exists.

Track

Contains API calls to interact with tracks and for getting all track points.

This section includes API calls that allow you to interact with tracks and retrieve track points.

Learn more about the track API by following our instructions.

API actions

API path: /track.

download

This method allows you to download track points as a KML/KMZ file which can be used in other apps to show tracks.

Parameters

name

description

type

format

Example

Let's consider an example, where we're looking for a KML file for a tracker with ID 1683258 that doesn't break down by stops. The data should cover trips starting from 3:24 AM to 6:24 AM on November 19, 2023, according to the user's local time.

cURL

Response

In case the available storage period is not exceeded, you will get the file.

For example, if the device's plan has maximum available storage period 3 months (default value) and we request data from 6 months, the response will contain JSON with the next information:

Errors

201 - Not found in database – the tracker ID in your request may not match any trackers linked to the user account with this session hash. Ensure the correct tracker_id and hash of an appropriate user are used.
208 - Device blocked – if a tracker exists under this user account but is currently inactive due to tariff plan restrictions or any other reason.
211 - Requested time span is too big – If the interval between the "from" and "to" dates is too large, it may exceed the maximum value defined in the API configuration.

list

This method retrieves a list of tracks for a given tracker within a specified time period.

Parameters

name

description

type

format

Example

For example, if we need to retrieve all trips for tracker 1683258 in November, without applying smart filter, including LBS points recorded, without clustering, separated by parkings, while also counting the number of events that occur during each trip, we only need to specify the "filter" and "count_events" from optional parameters. This is because the other optional settings will provide us with necessary info by default.

cURL

Response

limit_exceeded - boolean. It will be true if the requested time period surpasses the limit set in the tracker's tariff. For instance, if the device's plan has a maximum storage period of three months (the default value), and we request trips for six months.
list - an array of JSON objects containing track information. It consists of zero or more JSON objects. Zero objects indicates that there were no trips based on the track options or the device didn't supply any points to the platform.

where track_info is either regular, single_report, merged or cluster:

regular object:

id - int. Track id.
start_date - . Track start date, in user's timezone.
start_address - string. Track start address.

single_report object is returned when the device operates in "interval" mode or only one point per track is provided (for example, an M7 tracker operating in interval mode):

id - int. Track id.
start_date - . Date when the tracker registered the point, in user's timezone.
start_address - string. Point address.

merged object. Only returned if "split" is set to false:

start_date - . Track start date, in user's timezone. It signifies the initial point identified as a track for a specified time period.
start_address - string. Track start address.
max_speed - int. Maximum speed registered during period in km/h.

cluster object. Can be returned only if "split" is set to true:

start_date - . Track start date, in user's timezone.
start_address - string. Track start address.
end_date - . Track end date, in user's timezone.

Errors

201 - Not found in database – the tracker ID in your request may not match any trackers linked to the user account with this session hash. Ensure the correct tracker_id and hash of an appropriate user are used.
208 - Device blocked – if a tracker exists under this user account but is currently inactive due to tariff plan restrictions or any other reason.
211 - Requested time span is too big – If the interval between the "from" and "to" dates is too large, it may exceed the maximum value defined in the API configuration.

read

This method fetches all track points that a GPS tracker has recorded and sent to the platform within a specified time frame. The timestamp for each point corresponds to when the tracker recorded the point, adjusted to the user's time zone.

Parameters

name

description

type

format

Example

For instance, if we need to obtain track points for tracker 1683258 that fall within November 1, and are solely part of track ID 923150, without applying a smart filter, LBS points and simplifier. Since these optional parameters by default are true, we should list them in our request.

cURL

Response

limit_exceeded - boolean. It will be true if the requested time period surpasses the limit set in the tracker's tariff. For instance, if the device's plan has a maximum storage period of three months (the default value), and we request trips for six months.
list - array of JSON objects. A list of .

point info

lat - float. Represents latitude.
lng - float. Represents longitude.
alt - int. Indicates the altitude in meters.

Errors

201 - Not found in database – the tracker ID in your request may not match any trackers linked to the user account with this session hash. Ensure the correct tracker_id and hash of an appropriate user are used.
208 - Device blocked – if a tracker exists under this user account but is currently inactive due to tariff plan restrictions or any other reason.
211 - Requested time span is too big – If the interval between the "from" and "to" dates is too large, it may exceed the maximum value defined in the API configuration.

visit/list

This method fetches IDs of zones and places that contain at least one track point.

Parameters

name

description

type

format

Example

For instance, if we need to obtain IDs of zones and places that contain at least one track point related to tracker 1683258 in January.

cURL

Response

zones - int array. List of zones IDs.
places - int array. List of places IDs.

Errors

204 - Entity not found – the tracker ID in your request may not match any trackers linked to the user account with this session hash. Ensure the correct tracker_id and hash of an appropriate user are used.

About special settings

About special settings. Some trackers provide additional specific kind of control which is defined with `special_control` field of tracker model.

About special settings

Some trackers provide additional specific kind of control which is defined with special_control field of tracker model. This field contains type, which identifies a certain kind of settings. (For example "pwr_off_key" or "sos_key", which you can see below)special_control = "none" means that tracker doesn't have specific kind of control. In other cases you can:

read special settings with ,
update special settings with ,
perform special control with .

Such control assumes tracker special settings

API actions

API base path: /tracker/settings/special.

read

Gets special settings for the specified tracker.

Parameters

name

description

type

format

Examples

Responses

If parameter type is present:

value - settings object.

If parameter type omitted:

list - array of objects. Settings object array.

Settings object structures by type:

electronic_lock_password

password - string. Nullable.

hhd_lock_password

password - string. Nullable. 8 digits.

jointech_lock_password

password - string. Nullable. 6 non-space, non-comma symbols.

vg_lock_password

password - string. Nullable. 6 digits.

autofon_sms_alerts

low_battery_mode - . Can be "enable" | "disable".
ext_input_mode - . Can be "enable" | "disable".
sos_button_mode - . Can be "enable" | "disable".

auto_geofence_telfm

mode - . Can be "enable" | "disable".
activation_timeout - int. 0-65535 seconds.
radius - int. 50 - 10000 meters.

bce_tacho_control

function - . Can be "slot1" | "slot2" | "vu_activities" | "vu_no_activities"

call_button

items - Array of phone numbers (10-15 digits) represented as strings.
- phone - string. Phone number in the international format without "+" sign.

call_buttons_v40

items - Array of phone numbers (10-15 digits) represented as strings.
- phone - string. Phone number in the international format without "+" sign.

careu_psm

sleep_when_ignition_off - boolean.
sleep_when_no_motion - boolean.
sleep_when_no_communication - boolean.

castel_alarms

report - boolean. If true will send notification to server upon an event.
beep - boolean. If true will sound upon an event.
threshold - double. Normal values range where event does not occur. Each unit equals 1 g.

castel_obd

enable_pid_reports - boolean.
pid_data_records_per_message - int. Count of records per one message. Can be 1 - 20.
pid_data_collect_interval - int. Data collect interval in seconds. Can be 30 - 600.

charging_gmt100

mode - . Can be "on_need" | "ign_on_only" | "ign_on" | "low_charge".

ddd_emails

emails - string array. Valid emails. Maximum size 5.

digital_password

password - string. 6 digits.

fcc_telfm

fuel_type - . Can be "gasoline" | "diesel" | "lpg".
engine_volume - double. Can be 0.0 - 10.0.
multiplier - double. Can be 0.0 - 10.0.

galileo_tacho_control

galileo_hds

mode - . Can be "enable" | "disable".
max_acceleration_force - double. It is a max allowed acceleration force which can be reached while accelerating without triggering harsh acceleration event.Can be 0 - 2.55.
max_braking_force - double. It is a max allowed braking force which can be reached while braking without triggering harsh braking event. Can be 0 - 2.55.

harsh_behavior_hua_sheng

mode - . Can be "enable" | "disable".
max_acceleration_force - double. It is a max allowed acceleration force which can be reached while accelerating without triggering harsh acceleration event.Can be 0.1 - 1.0.
max_braking_force - double. It is a max allowed braking force which can be reached while braking without triggering harsh braking event. Can be 0.1 - 1.0.

hbm_telfm

mode - . Can be "enable" | "disable".
max_acceleration_force - double. It is a max allowed acceleration force which can be reached while accelerating without triggering harsh acceleration event. Can be 0.25 - 0.85 g.
max_braking_force - double. It is a max allowed braking force which can be reached while braking without triggering harsh braking event. Can be 0.25 - 0.85 g.

hbm_telfm5x

max_acceleration_force – double. It is a max allowed acceleration force which can be reached while accelerating without triggering harsh acceleration event. Can be 0.5 - 10.0 g.
max_braking_force – double. It is a max allowed braking force which can be reached while braking without triggering harsh braking event. Can be 0.5 - 10.0 g.
max_angular_velocity – double. It is a max allowed cornering angle which can be reached while cornering without triggering harsh cornering event. Can be 0.5 - 10.0 rad/s.

hbm_ql

mode - . Can be "enable" | "disable".
high_speed - int. Can be 100 - 400.
high_speed_braking_delta - int. Can be 0 - 100.

hbm_ms_ql

mode - . Can be "disable" | "gps_only" | "motion_sensor_only" | "gps_and_motion_sensor".
high_speed - int. Can be 100 - 400.
high_speed_braking_delta - int. Can be 0 - 100.

harsh_behavior_bce

is_switched_off - boolean.
acceleration_limit - double. Can be 0.04 - 3.
braking_limit - double. Can be 0.04 - 3.

harsh_behavior_concox_x1

acc_speed - int. Can be 0 - 100.
acc_detection_time - int. Can be 0 - 10.
braking_speed - int. Can be 0 - 100.

harsh_behavior_tramigo

mode - . Can be "enable" | "disable".
max_acceleration_force - double. Can be 0.1 - 8.
max_braking_force - double. Can be 0.1 - 8.

harsh_behavior_ruptela

braking_limit - int. Can be 0 - 100.
acceleration_limit - int. Can be 0 - 100.

nimbelink_accel

mode - . Can be "enable" | "disable".
x - double. Can be 0 - 2.55.
y - double. Can be 0 - 2.55.

hua_sheng_vibration_sensitivity

sensitivity - . Can be "easy" | "normal" | "hard" | "hardest".

ign_ruptela

For Ruptela devices. Represents configuration parameters related to ignition detection ("Engine detection" and "Custom ignition", as Ruptela documentation calls them).

ign_src_suntech

mode - . Can be "power_voltage" | "din1" | "movement".
power_voltage_low_level - int. Can be 0 - 30000.
power_voltage_high_level - int. Can be 0 - 30000.

ign_src_telfm

mode - . Can be "power_voltage" | "din1" | "movement".
power_voltage_low_level - int. Can be 0 - 30000.
power_voltage_high_level - int. Can be 0 - 30000.

locus_sec

signature - string. Length 1 - 32.
sms_password - string. Length 1 - 32.
reset - boolean.

phonebook_gt300

items - array of contacts.
- name - string. Contact name.
- phone - string. Phone number in the international format without "+" sign.

phonebook_pt100

items - array of contacts.
- name - string. Contact name.
- phone - string. Phone number in the international format without "+" sign.

pwr_off_key

mode - . Can be "enable" | "disable".

scat_mayak_bt_control

function - . Can be "bt_disable" | "bt_enable" | "bt_clear" | "bt_write".
bt_state - boolean.

sos_key

mode - . Can be "report" | "call_report".
phone - string. SOS phone to call. Phone number in the international format without "+" sign.

starcom_impact

strong_duration - int. Required impact duration to trigger strong impact event. Each unit equals 2.5 milliseconds. Can be 0 - 14.
strong_force - int. Required impact force triggering strong impact event. Each unit equals about 1.1g. Can be 1 - 7.
strong_impact_enabled - boolean.

tacho_company_card

company_card_number - string. 16 HEX digits (0-9A-F).

tacho_remote_download

company_card_number - string. 16 HEX digits (0-9A-F).
vu_download_interval - int. Min = 0.
card_download_interval - int. Min = 0.

teltonika_tacho_request

data_type - . Can be "overview" | "activities" | "eventsAndFaults" | "detailedSpeed" | "technicalData" | "card1Download" | "card2Download".
activities_start_time - string date. Format = "YYYY-MM-DD", not null only if data_type = "activities".
activities_end_time - string date. Format = "YYYY-MM-DD", not null only if data_type = "activities".

temporary_digital_password

password - string. 6 digits.
duration_in_min - int. Can be 10 - 255.

time_shift

offset - double. Can be -24.0 - 24.0 hours.

tow_detection_ql

mode - . Can be "enable" | "disable".
engine_off_to_tow - int. A time parameter to judge whether the device considered towed after the engine off. If the motion sensor doesn't detect stillness within the specified time after the engine off the device is being towed. Can be 0 - 900 seconds.
fake_tow_delay - int. After the engine off and stillness detected, if motion sensor detects moving again, the device turns into a state called fake tow. If the device keeps in fake tow after a period defined by this parameter, it is considered towed. Can be 0 - 600 seconds.

tow_detection_ql2

mode - . Can be "enable" | "disable".
engine_off_to_tow - int. A time parameter to judge whether the device considered towed after the engine off. If the motion sensor doesn't detect stillness within the specified time after the engine off the device is being towed. Can be 0 - 900 seconds.
fake_tow_delay - int. After the engine off and stillness detected, if motion sensor detects moving again, the device turns into a state called fake tow. If the device keeps in fake tow after a period defined by this parameter, it is considered towed. Can be 0 - 600 seconds.

tow_detection_telfm

mode - . Can be "enable" | "disable".
activation_timeout - int. Can be 0 - 65535 minutes.
threshold - double. Can be 0.10 - 5.00.

video_stream_howen

virtual_ign_ql

mode - . Can be "disabled" | "power_voltage" | "motion_sensor".
ign_on_voltage - int. Can be 250 - 28000.
rest_duration_to_off – int. A time parameter to make sure the device enters stillness status, i.e. the status of the device will be changed to stillness if the motion sensor detects stillness and maintains for a period of time defined by this parameter. Can be 1 - 255.

no_movement_alarm

timeout - int. Can be 30 - 65500. A time parameter when the device doesn't move.
pre_alarm_duration - int. Can be 0 - 65500. A time parameter when the device continues not to move after timeout.

Errors

201 – Not found in the database (if there is no tracker with such ID belonging to authorized user).
208 – Device blocked (if tracker exists but was blocked due to tariff restrictions or some other reason).
214 – Requested operation or parameters are not supported by the device.

update

Sets special settings for a specified tracker with the new one.

required sub-user rights: tracker_configure.

Parameters

name

description

type

Examples

cURL

Response

Errors

201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
214 – Requested operation or parameters are not supported by the device.

{
  "list": [
    {
      "input_name": "acceleration",
      "description": "Acceleration"
    },
    {
      "input_name": "air_pressure",
      "description": "Air pressure"
    },
    {
      "input_name": "alt_large_assign",
      "description": "ALT large assign [N]"
    },
    {
      "input_name": "alt_medium_assign",
      "description": "ALT medium assign [N]"
    },
    {
      "input_name": "alt_small_assign",
      "description": "ALT small assign [N]"
    },
    {
      "input_name": "analog",
      "description": "Analog sensor [N]"
    },
    {
      "input_name": "avl_io",
      "description": "AVL IO [N]"
    },
    {
      "input_name": "axis_x",
      "description": "Acceleration by X axis"
    },
    {
      "input_name": "axis_y",
      "description": "Acceleration by Y axis"
    },
    {
      "input_name": "axis_z",
      "description": "Acceleration by Z axis"
    },
    {
      "input_name": "battery_current",
      "description": "Battery current"
    },
    {
      "input_name": "battery_level",
      "description": "Battery level"
    },
    {
      "input_name": "battery_level_of",
      "description": "Battery level [N]"
    },
    {
      "input_name": "battery_voltage",
      "description": "Battery voltage"
    },
    {
      "input_name": "ble_analog",
      "description": "BLE: Analog [N]"
    },
    {
      "input_name": "ble_battery_level",
      "description": "BLE: Battery level [N]"
    },
    {
      "input_name": "ble_battery_voltage",
      "description": "BLE: Battery voltage [N]"
    },
    {
      "input_name": "ble_frequency",
      "description": "BLE: LLS frequency [N]"
    },
    {
      "input_name": "ble_humidity",
      "description": "BLE: Humidity sensor [N]"
    },
    {
      "input_name": "ble_input_status",
      "description": "BLE: Input status [N]"
    },
    {
      "input_name": "ble_lls_height",
      "description": "BLE: LLS height [N]"
    },
    {
      "input_name": "ble_lls_level",
      "description": "BLE: LLS level [N]"
    },
    {
      "input_name": "ble_lls_level_raw",
      "description": "BLE: LLS level raw [N]"
    },
    {
      "input_name": "ble_lls_pressure",
      "description": "BLE: LLS pressure [N]"
    },
    {
      "input_name": "ble_lls_temperature",
      "description": "BLE: LLS temperature [N]"
    },
    {
      "input_name": "ble_luminosity",
      "description": "BLE: Luminosity [N]"
    },
    {
      "input_name": "ble_output_status",
      "description": "BLE: Output status [N]"
    },
    {
      "input_name": "ble_pitch",
      "description": "BLE: Pitch angle [N]"
    },
    {
      "input_name": "ble_roll",
      "description": "BLE: Roll angle [N]"
    },
    {
      "input_name": "ble_signal_strength",
      "description": "BLE: Signal strength [N]"
    },
    {
      "input_name": "ble_temp_sensor",
      "description": "BLE: Temperature sensor [N]"
    },
    {
      "input_name": "ble_tire_pressure",
      "description": "BLE: Tire pressure [N]"
    },
    {
      "input_name": "ble_tire_temperature",
      "description": "BLE: Tire air temperature [N]"
    },
    {
      "input_name": "ble_user_data",
      "description": "BLE: Custom user data [N]"
    },
    {
      "input_name": "board_voltage",
      "description": "Board voltage"
    },
    {
      "input_name": "braking",
      "description": "Braking"
    },
    {
      "input_name": "calamp_accum",
      "description": "CalAmp Accumulator [N]"
    },
    {
      "input_name": "can_16bit_r",
      "description": "CAN16BITR [N]"
    },
    {
      "input_name": "can_32bit_r",
      "description": "CAN32BITR [N]"
    },
    {
      "input_name": "can_8bit_r",
      "description": "CAN8BITR [N]"
    },
    {
      "input_name": "can_adblue_level",
      "description": "CAN: Level of AdBlue fluid"
    },
    {
      "input_name": "can_alternator_current",
      "description": "CAN: Alternator current"
    },
    {
      "input_name": "can_alternator_voltage",
      "description": "CAN: Alternator voltage"
    },
    {
      "input_name": "can_ambient_air_temp",
      "description": "CAN: Ambient air temperature"
    },
    {
      "input_name": "can_avg_fuel_economy",
      "description": "CAN: Average fuel economy"
    },
    {
      "input_name": "can_axle_load",
      "description": "CAN: Axle load [N]"
    },
    {
      "input_name": "can_barometric_pressure",
      "description": "CAN: Barometric pressure"
    },
    {
      "input_name": "can_battery_level",
      "description": "CAN: Battery level (SoC)"
    },
    {
      "input_name": "can_battery_potential",
      "description": "CAN: Battery potential"
    },
    {
      "input_name": "can_battery_temperature",
      "description": "CAN: Battery temperature"
    },
    {
      "input_name": "can_battery_voltage",
      "description": "CAN: Battery voltage"
    },
    {
      "input_name": "can_bellow_press_front_left",
      "description": "CAN: Bellow pressure front left"
    },
    {
      "input_name": "can_bellow_press_front_right",
      "description": "CAN: Bellow pressure front right"
    },
    {
      "input_name": "can_bellow_press_rear_left",
      "description": "CAN: Bellow pressure rear left"
    },
    {
      "input_name": "can_bellow_press_rear_right",
      "description": "CAN: Bellow pressure rear right"
    },
    {
      "input_name": "can_brake_pedal_position",
      "description": "CAN: Brake pedal position"
    },
    {
      "input_name": "can_cab_interior_temp",
      "description": "CAN: Cab interior temperature"
    },
    {
      "input_name": "can_cargo_ambient_temp",
      "description": "CAN: Cargo ambient temperature"
    },
    {
      "input_name": "can_charging_system_voltage",
      "description": "CAN: Charging system potential (voltage)"
    },
    {
      "input_name": "can_consumption",
      "description": "CAN: Total fuel used"
    },
    {
      "input_name": "can_consumption_relative",
      "description": "CAN: Fuel consumed (counter)"
    },
    {
      "input_name": "can_coolant_level",
      "description": "CAN: Coolant level"
    },
    {
      "input_name": "can_coolant_t",
      "description": "CAN: Coolant temperature"
    },
    {
      "input_name": "can_e_battery_health",
      "description": "CAN: Battery health (SoH)"
    },
    {
      "input_name": "can_e_charger_current",
      "description": "CAN: Charger current"
    },
    {
      "input_name": "can_e_charger_current_actual",
      "description": "CAN: Charger current actual"
    },
    {
      "input_name": "can_e_charger_energy",
      "description": "CAN: Charger energy"
    },
    {
      "input_name": "can_e_charger_voltage",
      "description": "CAN: Charger voltage"
    },
    {
      "input_name": "can_e_charger_voltage_actual",
      "description": "CAN: Charger voltage actual"
    },
    {
      "input_name": "can_e_current_range",
      "description": "CAN: Current Range"
    },
    {
      "input_name": "can_e_electric_consumption",
      "description": "CAN: Power Consumption"
    },
    {
      "input_name": "can_e_full_battery_capacity",
      "description": "CAN: Full battery capacity"
    },
    {
      "input_name": "can_e_remain_battery_capacity",
      "description": "CAN: Remaining battery capacity"
    },
    {
      "input_name": "can_e_remaining_charge_time",
      "description": "CAN: Remaining charge time"
    },
    {
      "input_name": "can_eco_duration",
      "description": "CAN: ECO duration"
    },
    {
      "input_name": "can_eco_score",
      "description": "CAN: ECO score"
    },
    {
      "input_name": "can_engine_hours",
      "description": "CAN: Engine hours"
    },
    {
      "input_name": "can_engine_hours_relative",
      "description": "CAN: Relative engine hours"
    },
    {
      "input_name": "can_engine_load",
      "description": "CAN: Engine load"
    },
    {
      "input_name": "can_engine_manifold_pressure",
      "description": "CAN: Engine intake manifold pressure"
    },
    {
      "input_name": "can_engine_manifold_temp",
      "description": "CAN: Engine intake manifold temperature"
    },
    {
      "input_name": "can_engine_oil_level",
      "description": "CAN: Engine oil level"
    },
    {
      "input_name": "can_engine_percent_torque",
      "description": "CAN: Actual engine percent torque"
    },
    {
      "input_name": "can_engine_revolutions",
      "description": "CAN: Total engine revolutions"
    },
    {
      "input_name": "can_engine_temp",
      "description": "CAN: Engine temp."
    },
    {
      "input_name": "can_fuel",
      "description": "CAN: Fuel level [N]"
    },
    {
      "input_name": "can_fuel_economy",
      "description": "CAN: Fuel economy"
    },
    {
      "input_name": "can_fuel_litres",
      "description": "CAN: Fuel (litres)"
    },
    {
      "input_name": "can_fuel_rate",
      "description": "CAN: Instant fuel rate"
    },
    {
      "input_name": "can_fuel_temperature",
      "description": "CAN: Fuel temperature"
    },
    {
      "input_name": "can_gross_combo_vehicle_weight",
      "description": "CAN: Gross combination vehicle weight"
    },
    {
      "input_name": "can_idle_consumption",
      "description": "CAN: Total fuel used in idle"
    },
    {
      "input_name": "can_idle_engine_hours",
      "description": "CAN: Idle engine hours"
    },
    {
      "input_name": "can_intake_air_t",
      "description": "CAN: Intake air temp."
    },
    {
      "input_name": "can_intercooler_temperature",
      "description": "CAN: Intercooler temperature"
    },
    {
      "input_name": "can_mileage",
      "description": "CAN: Mileage"
    },
    {
      "input_name": "can_mileage_relative",
      "description": "CAN: Relative mileage"
    },
    {
      "input_name": "can_oil_pressure",
      "description": "CAN: Engine oil pressure"
    },
    {
      "input_name": "can_oil_temperature",
      "description": "CAN: Engine oil temperature"
    },
    {
      "input_name": "can_param",
      "description": "CAN [N]"
    },
    {
      "input_name": "can_pto_duration",
      "description": "CAN: Total duration of PTO when stand still"
    },
    {
      "input_name": "can_pto_fuel_used",
      "description": "CAN: Total fuel used during PTO when stand still"
    },
    {
      "input_name": "can_pto_oil_temperature",
      "description": "CAN: PTO oil temperature"
    },
    {
      "input_name": "can_r_prefix",
      "description": "CAN: R-prefix"
    },
    {
      "input_name": "can_road_surface_temp",
      "description": "CAN: Road surface temperature"
    },
    {
      "input_name": "can_rpm",
      "description": "CAN: RPM"
    },
    {
      "input_name": "can_service_brake_pressure",
      "description": "CAN: The pneumatic pressure in the service brake circuit or reservoir [N]"
    },
    {
      "input_name": "can_service_distance",
      "description": "CAN: Service distance"
    },
    {
      "input_name": "can_sli_battery_net_current",
      "description": "CAN: SLI battery net current [N]"
    },
    {
      "input_name": "can_speed",
      "description": "CAN: Speed"
    },
    {
      "input_name": "can_tacho_performance",
      "description": "CAN: Tachograph performance"
    },
    {
      "input_name": "can_throttle",
      "description": "CAN: Throttle"
    },
    {
      "input_name": "can_total_fuel_used",
      "description": "CAN: Engine total fuel used"
    },
    {
      "input_name": "can_total_fuel_used_gas",
      "description": "CAN: Total fuel used (gas)"
    },
    {
      "input_name": "can_total_power_takeoff_hours",
      "description": "CAN: Total power takeoff hours"
    },
    {
      "input_name": "can_transmission_oil_level",
      "description": "CAN: Transmission oil level"
    },
    {
      "input_name": "can_transmission_oil_pressure",
      "description": "CAN: Transmission oil pressure"
    },
    {
      "input_name": "can_transmission_oil_temp",
      "description": "CAN: Transmission oil temperature"
    },
    {
      "input_name": "can_trip_fuel_used",
      "description": "CAN: Engine trip fuel"
    },
    {
      "input_name": "can_trip_fuel_used_gas",
      "description": "CAN: Trip fuel (gaseous)"
    },
    {
      "input_name": "can_turbo_oil_temperature",
      "description": "CAN: Turbo oil temperature"
    },
    {
      "input_name": "can_washer_fluid_level",
      "description": "CAN: Washer fluid level"
    },
    {
      "input_name": "cornering",
      "description": "Cornering"
    },
    {
      "input_name": "cornering_rad",
      "description": "Cornering"
    },
    {
      "input_name": "counter",
      "description": "Counter [N]"
    },
    {
      "input_name": "custom_param",
      "description": "Custom [N]"
    },
    {
      "input_name": "ext_battery_voltage",
      "description": "External battery voltage"
    },
    {
      "input_name": "ext_temp_sensor",
      "description": "External temperature [N]"
    },
    {
      "input_name": "field",
      "description": "Field [N]"
    },
    {
      "input_name": "flex_id",
      "description": "Flex ID [N]"
    },
    {
      "input_name": "flex_id_signed",
      "description": "Flex ID (signed) [N]"
    },
    {
      "input_name": "freq",
      "description": "Frequency sensor [N]"
    },
    {
      "input_name": "fuel_consumption",
      "description": "Fuel consumption"
    },
    {
      "input_name": "fuel_frequency",
      "description": "LLS: Frequency"
    },
    {
      "input_name": "fuel_level",
      "description": "LLS: Level"
    },
    {
      "input_name": "fuel_temperature",
      "description": "LLS: Temperature"
    },
    {
      "input_name": "humidity",
      "description": "Relative humidity sensor [N]"
    },
    {
      "input_name": "humidity_internal",
      "description": "Relative humidity"
    },
    {
      "input_name": "hw_mileage",
      "description": "Mileage"
    },
    {
      "input_name": "illuminance_internal",
      "description": "Illuminance"
    },
    {
      "input_name": "impulse_counter",
      "description": "Impulse counter [N]"
    },
    {
      "input_name": "io_port",
      "description": "I/O port [N]"
    },
    {
      "input_name": "lls_level",
      "description": "LLS: Level [N]"
    },
    {
      "input_name": "lls_level_raw",
      "description": "LLS: Level (raw) [N]"
    },
    {
      "input_name": "lls_temperature",
      "description": "LLS: Temperature [N]"
    },
    {
      "input_name": "modbus",
      "description": "Modbus [N]"
    },
    {
      "input_name": "obd_absolute_load_value",
      "description": "OBD: Absolute load value"
    },
    {
      "input_name": "obd_barometric_pressure",
      "description": "OBD: Barometric pressure"
    },
    {
      "input_name": "obd_consumption",
      "description": "OBD: Fuel consumption"
    },
    {
      "input_name": "obd_control_module_voltage",
      "description": "OBD: Control module voltage"
    },
    {
      "input_name": "obd_coolant_t",
      "description": "OBD: Coolant temperature"
    },
    {
      "input_name": "obd_custom_fuel_litres",
      "description": "OBD: Real Fuel (litres)"
    },
    {
      "input_name": "obd_custom_odometer",
      "description": "OBD: Odometer"
    },
    {
      "input_name": "obd_engine_load",
      "description": "OBD: Engine load"
    },
    {
      "input_name": "obd_fuel",
      "description": "OBD: Fuel"
    },
    {
      "input_name": "obd_intake_air_pressure",
      "description": "OBD: Intake air pressure"
    },
    {
      "input_name": "obd_intake_air_t",
      "description": "OBD: Intake air temp."
    },
    {
      "input_name": "obd_mil_run_time",
      "description": "OBD: Time run with MIL on"
    },
    {
      "input_name": "obd_oil_temperature",
      "description": "OBD: Oil temperature"
    },
    {
      "input_name": "obd_rpm",
      "description": "OBD: RPM"
    },
    {
      "input_name": "obd_speed",
      "description": "OBD: Speed"
    },
    {
      "input_name": "obd_throttle",
      "description": "OBD: Throttle"
    },
    {
      "input_name": "obd_time_since_engine_start",
      "description": "OBD: Run time since engine start"
    },
    {
      "input_name": "passengers_entered",
      "description": "Passenger counter: Entry [N]"
    },
    {
      "input_name": "passengers_exit",
      "description": "Passenger counter: Exit [N]"
    },
    {
      "input_name": "passengers_remaining",
      "description": "Passenger counter: Remaining"
    },
    {
      "input_name": "pdop",
      "description": "PDOP"
    },
    {
      "input_name": "physiologic_blood_pressure_dt",
      "description": "Diastolic blood pressure"
    },
    {
      "input_name": "physiologic_blood_pressure_st",
      "description": "Systolic blood pressure"
    },
    {
      "input_name": "physiologic_heart_rate",
      "description": "Heart rate"
    },
    {
      "input_name": "raw_can",
      "description": "CAN: Raw data [N]"
    },
    {
      "input_name": "raw_obd",
      "description": "OBD: Raw data [N]"
    },
    {
      "input_name": "rs232",
      "description": "RS-232 [N]"
    },
    {
      "input_name": "rs485",
      "description": "RS-485 [N]"
    },
    {
      "input_name": "stt_large_assign",
      "description": "STT large assign [N]"
    },
    {
      "input_name": "stt_medium_assign",
      "description": "STT medium assign [N]"
    },
    {
      "input_name": "stt_small_assign",
      "description": "STT small assign [N]"
    },
    {
      "input_name": "tacho_mileage",
      "description": "TACHO: Mileage"
    },
    {
      "input_name": "tacho_speed",
      "description": "TACHO: Speed"
    },
    {
      "input_name": "temp_sensor",
      "description": "Temperature"
    },
    {
      "input_name": "tire_pressure",
      "description": "Tire pressure [N]"
    },
    {
      "input_name": "tire_sensor_battery_voltage",
      "description": "Tire sensor voltage [N]"
    },
    {
      "input_name": "tire_sensor_status",
      "description": "Tire sensor status [N]"
    },
    {
      "input_name": "tire_temperature",
      "description": "Tire air temperature [N]"
    },
    {
      "input_name": "total_passengers_entered",
      "description": "Passenger counter: Entry total [N]"
    },
    {
      "input_name": "total_passengers_exit",
      "description": "Passenger counter: Exit total [N]"
    },
    {
      "input_name": "uds_adblue_tanklevel_absolut",
      "description": "UDS: Level of AdBlue fluid"
    },
    {
      "input_name": "uds_adblue_tanklevel_percent",
      "description": "UDS: Level of AdBlue fluid (percent)"
    },
    {
      "input_name": "uds_ambient_air_temp",
      "description": "UDS: Ambient air temperature"
    },
    {
      "input_name": "uds_battery_state_percent",
      "description": "UDS: Battery level"
    },
    {
      "input_name": "uds_battery_voltage",
      "description": "UDS: Battery voltage"
    },
    {
      "input_name": "uds_consumption",
      "description": "UDS: Fuel consumption"
    },
    {
      "input_name": "uds_consumption_average",
      "description": "UDS: Average fuel consumption"
    },
    {
      "input_name": "uds_consumption_average_high",
      "description": "UDS: Average high fuel consumption"
    },
    {
      "input_name": "uds_consumption_average_low",
      "description": "UDS: Average low fuel consumption"
    },
    {
      "input_name": "uds_consumption_since_reset",
      "description": "UDS: Fuel consumption since reset"
    },
    {
      "input_name": "uds_eco_co2_score",
      "description": "UDS: Environmental score"
    },
    {
      "input_name": "uds_engine_coolant_temp",
      "description": "UDS: Coolant temperature"
    },
    {
      "input_name": "uds_engine_oil_temperature",
      "description": "UDS: Oil temperature"
    },
    {
      "input_name": "uds_fuel_tank_level_absolute",
      "description": "UDS: Fuel level"
    },
    {
      "input_name": "uds_fuel_tank_level_percent",
      "description": "UDS: Fuel level (percent)"
    },
    {
      "input_name": "uds_odometer",
      "description": "UDS: Odometer"
    },
    {
      "input_name": "uds_rpm",
      "description": "UDS: RPM"
    },
    {
      "input_name": "uds_service_days_since_last",
      "description": "UDS: Days since last service"
    },
    {
      "input_name": "uds_service_distance_snc_lst",
      "description": "UDS: Km since last service"
    },
    {
      "input_name": "uds_service_interval_days",
      "description": "UDS: Days till next service"
    },
    {
      "input_name": "uds_service_interval_distance",
      "description": "UDS: Distance to drive till next service"
    },
    {
      "input_name": "uds_service_max_days",
      "description": "UDS: Max days of service interval"
    },
    {
      "input_name": "uds_service_max_distance",
      "description": "UDS: Max km of service interval"
    },
    {
      "input_name": "uds_speed",
      "description": "UDS: Speed"
    },
    {
      "input_name": "uds_steer_angle",
      "description": "UDS: Steer angle"
    },
    {
      "input_name": "uds_tank_level_cng_percent",
      "description": "UDS: Cng fuel tank level (percent)"
    },
    {
      "input_name": "uds_throttle",
      "description": "UDS: Throttle"
    },
    {
      "input_name": "uds_time_since_engine_start",
      "description": "UDS: Run time since engine start"
    },
    {
      "input_name": "uds_tire_pressure_front_left",
      "description": "UDS: Tire pressure front left"
    },
    {
      "input_name": "uds_tire_pressure_front_right",
      "description": "UDS: Tire pressure front right"
    },
    {
      "input_name": "uds_tire_pressure_rear_left",
      "description": "UDS: Tire pressure rear left"
    },
    {
      "input_name": "uds_tire_pressure_rear_right",
      "description": "UDS: Tire pressure rear right"
    },
    {
      "input_name": "user_data",
      "description": "Custom user data [N]"
    },
    {
      "input_name": "val",
      "description": "VAL [N]"
    },
    {
      "input_name": "vdop",
      "description": "VDOP"
    },
    {
      "input_name": "remote_ip",
      "description": "remote_ip",
      "value_type": "String"
    },
    {
      "input_name": "chat_availability",
      "description": "chat_availability",
      "value_type": "Boolean"
    },
    {
      "input_name": "stt_mode",
      "description": "STT mode",
      "value_type": "Integer"
    },
    {
      "input_name": "alt_mode",
      "description": "ALT mode",
      "value_type": "Integer"
    },
    {
      "input_name": "event_code",
      "description": "Event code",
      "value_type": "String"
    },
    {
      "input_name": "sub_event_code",
      "description": "Subevent code",
      "value_type": "String"
    },
    {
      "input_name": "event_id",
      "description": "Event ID",
      "value_type": "Integer"
    },
    {
      "input_name": "status",
      "description": "Status (state)",
      "value_type": "String"
    },
    {
      "input_name": "ext_status",
      "description": "Extended status (state)",
      "value_type": "String"
    },
    {
      "input_name": "hardware_key",
      "description": "Hardware key",
      "value_type": "String"
    },
    {
      "input_name": "new_driver_name",
      "description": "Driver name",
      "value_type": "String"
    },
    {
      "input_name": "driver_ident_state",
      "description": "Driver identified",
      "value_type": "Boolean"
    },
    {
      "input_name": "driver_code",
      "description": "driver_code",
      "value_type": "Boolean"
    },
    {
      "input_name": "moving",
      "description": "Moving",
      "value_type": "Boolean"
    },
    {
      "input_name": "strap_bolt_cut",
      "description": "Seal opened",
      "value_type": "Boolean"
    },
    {
      "input_name": "external_power_state",
      "description": "External power state",
      "value_type": "Boolean"
    },
    {
      "input_name": "charging_status",
      "description": "Charging status",
      "value_type": "Integer"
    },
    {
      "input_name": "gps_status",
      "description": "GPS status",
      "value_type": "Boolean"
    },
    {
      "input_name": "battery_health_1",
      "description": "Battery health 1",
      "value_type": "Boolean"
    },
    {
      "input_name": "battery_health_2",
      "description": "Battery health 2",
      "value_type": "Boolean"
    },
    {
      "input_name": "battery_health_3",
      "description": "Battery health 3",
      "value_type": "Boolean"
    },
    {
      "input_name": "battery_health_4",
      "description": "Battery health 4",
      "value_type": "Boolean"
    },
    {
      "input_name": "backup_battery_health",
      "description": "Backup battery health",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_beacon_id",
      "description": "BLE: ID",
      "value_type": "String"
    },
    {
      "input_name": "ble_mac",
      "description": "BLE: MAC address",
      "value_type": "String"
    },
    {
      "input_name": "ble_magnet_sensor_1",
      "description": "Magnetic Bluetooth sensor 1",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_2",
      "description": "Magnetic Bluetooth sensor 2",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_3",
      "description": "Magnetic Bluetooth sensor 3",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_4",
      "description": "Magnetic Bluetooth sensor 4",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_5",
      "description": "Magnetic Bluetooth sensor 5",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_6",
      "description": "Magnetic Bluetooth sensor 6",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_7",
      "description": "Magnetic Bluetooth sensor 7",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_8",
      "description": "Magnetic Bluetooth sensor 8",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_9",
      "description": "Magnetic Bluetooth sensor 9",
      "value_type": "Boolean"
    },
    {
      "input_name": "ble_magnet_sensor_10",
      "description": "Magnetic Bluetooth sensor 10",
      "value_type": "Boolean"
    },
    {
      "input_name": "lock_state",
      "description": "Lock state",
      "value_type": "String"
    },
    {
      "input_name": "lock_status",
      "description": "Lock status",
      "value_type": "String"
    },
    {
      "input_name": "lock_state_raw",
      "description": "Raw lock status: Raw data",
      "value_type": "Integer"
    },
    {
      "input_name": "lock_command_result",
      "description": "Lock/unlock command result",
      "value_type": "String"
    },
    {
      "input_name": "door_state_1",
      "description": "Door state 1",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_2",
      "description": "Door state 2",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_3",
      "description": "Door state 3",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_4",
      "description": "Door state 4",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_5",
      "description": "Door state 5",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_6",
      "description": "Door state 6",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_7",
      "description": "Door state 7",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_8",
      "description": "Door state 8",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_9",
      "description": "Door state 9",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_10",
      "description": "Door state 10",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_11",
      "description": "Door state 11",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_12",
      "description": "Door state 12",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_13",
      "description": "Door state 13",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_14",
      "description": "Door state 14",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_15",
      "description": "Door state 15",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_state_16",
      "description": "Door state 16",
      "value_type": "Boolean"
    },
    {
      "input_name": "door_status_1",
      "description": "Door status 1",
      "value_type": "Integer"
    },
    {
      "input_name": "door_status_2",
      "description": "Door status 2",
      "value_type": "Integer"
    },
    {
      "input_name": "door_status_3",
      "description": "Door status 3",
      "value_type": "Integer"
    },
    {
      "input_name": "door_status_4",
      "description": "Door status 4",
      "value_type": "Integer"
    },
    {
      "input_name": "light_state_1",
      "description": "Light sensor status 1",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_2",
      "description": "Light sensor status 2",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_3",
      "description": "Light sensor status 3",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_4",
      "description": "Light sensor status 4",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_5",
      "description": "Light sensor status 5",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_6",
      "description": "Light sensor status 6",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_7",
      "description": "Light sensor status 7",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_8",
      "description": "Light sensor status 8",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_9",
      "description": "Light sensor status 9",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_10",
      "description": "Light sensor status 10",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_11",
      "description": "Light sensor status 11",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_12",
      "description": "Light sensor status 12",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_13",
      "description": "Light sensor status 13",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_14",
      "description": "Light sensor status 14",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_15",
      "description": "Light sensor status 15",
      "value_type": "Boolean"
    },
    {
      "input_name": "light_state_16",
      "description": "Light sensor status 16",
      "value_type": "Boolean"
    },
    {
      "input_name": "tacho_vin",
      "description": "TACHO: VIN",
      "value_type": "String"
    },
    {
      "input_name": "tacho_card1_sn",
      "description": "TACHO: Card 1 number",
      "value_type": "String"
    },
    {
      "input_name": "tacho_card2_sn",
      "description": "TACHO: Card 2 number",
      "value_type": "String"
    },
    {
      "input_name": "tacho_vin_last_download",
      "description": "tacho_vin_last_download",
      "value_type": "String"
    },
    {
      "input_name": "tacho_card1_last_download",
      "description": "tacho_card1_last_download",
      "value_type": "String"
    },
    {
      "input_name": "tacho_card2_last_download",
      "description": "tacho_card2_last_download",
      "value_type": "String"
    },
    {
      "input_name": "obd_vin",
      "description": "VIN",
      "value_type": "String"
    },
    {
      "input_name": "obd_mil_status",
      "description": "OBD: MIL status (check engine)",
      "value_type": "Boolean"
    },
    {
      "input_name": "obd_dtc_number",
      "description": "Errors",
      "value_type": "Integer"
    },
    {
      "input_name": "obd_dtc_codes",
      "description": "DTC",
      "value_type": "String"
    },
    {
      "input_name": "obd_dtc_cleared_distance",
      "description": "OBD: Mileage after DTC reset",
      "value_type": "Double"
    },
    {
      "input_name": "obd_mil_activated_distance",
      "description": "OBD: Distance with MIL on",
      "value_type": "Double"
    },
    {
      "input_name": "obd_four_wheel_drive",
      "description": "OBD: 4x4",
      "value_type": "Boolean"
    },
    {
      "input_name": "obd_electronic_lock_status",
      "description": "OBD: Electronic lock status",
      "value_type": "Integer"
    },
    {
      "input_name": "can_hand_brake_state",
      "description": "Car is on handbrake",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_hood_state",
      "description": "Hood",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Closed",
        "1": "Opened"
      }
    },
    {
      "input_name": "can_airbag_state",
      "description": "Airbag",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Not used",
        "1": "Fired"
      }
    },
    {
      "input_name": "can_trunk_state",
      "description": "Trunk",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Closed",
        "1": "Opened"
      }
    },
    {
      "input_name": "can_seat_belt_driver_state",
      "description": "Driver seat belt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Locked",
        "1": "Unlocked"
      }
    },
    {
      "input_name": "can_seat_belt_passenger_state",
      "description": "Passenger seat belt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Locked",
        "1": "Unlocked"
      }
    },
    {
      "input_name": "can_door_state",
      "description": "Door",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Closed",
        "1": "Opened"
      }
    },
    {
      "input_name": "can_door_driver_state",
      "description": "Driver door",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Closed",
        "1": "Opened"
      }
    },
    {
      "input_name": "can_door_passenger_state",
      "description": "Passenger door",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Closed",
        "1": "Opened"
      }
    },
    {
      "input_name": "can_cruise_control",
      "description": "CAN: Cruise Control",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_brake_state",
      "description": "CAN: Brake pedal",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_selected_gear",
      "description": "CAN: Selected Gear",
      "value_type": "Integer"
    },
    {
      "input_name": "can_retarder_location",
      "description": "CAN: Retarder location",
      "value_type": "Integer"
    },
    {
      "input_name": "can_e_fast_charge",
      "description": "CAN: Fast charge",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_active_charge_mode",
      "description": "CAN: Active charge mode",
      "value_type": "Integer"
    },
    {
      "input_name": "can_e_charger_control_mode",
      "description": "CAN: Charger control mode",
      "value_type": "Integer"
    },
    {
      "input_name": "can_e_charger_status",
      "description": "CAN: Charger status",
      "value_type": "Integer"
    },
    {
      "input_name": "can_e_charger_internal_fault",
      "description": "CAN: Charger internal fault",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_charger_plugged",
      "description": "CAN: Charger plugged",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_powertrain_state",
      "description": "CAN: Powertrain state",
      "value_type": "Integer"
    },
    {
      "input_name": "can_e_charging_active",
      "description": "CAN: Charging active",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_park_brake",
      "description": "CAN: Park brake active",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_helmet_status",
      "description": "CAN: Helmet status",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_top_case_sensor",
      "description": "CAN: Top case sensor",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_driving_direction",
      "description": "CAN: Driving direction",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_ignition_state",
      "description": "CAN: Ignition state",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_engine_state",
      "description": "CAN: Engine state",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_footbrake_state",
      "description": "CAN: Footbrake state",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_webasto_state",
      "description": "CAN: Webasto",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_roof_state",
      "description": "CAN: Roof",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_front_left_door",
      "description": "CAN: Front left door",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_front_right_door",
      "description": "CAN: Front right door",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_rear_left_door",
      "description": "CAN: Rear left door",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_rear_right_door",
      "description": "CAN: Rear right door",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_oil_pressure_or_level",
      "description": "CAN: Oil pressure/level",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_coolant_temp_or_level",
      "description": "CAN: Coolant liquid temperature/level",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_eps_state",
      "description": "CAN: EPS state",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_lights_failure",
      "description": "CAN: Lights failure",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_low_tire_pressure",
      "description": "CAN: Low tire pressure",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_brake_pad_wear",
      "description": "CAN: Wear of brake pads",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_warning",
      "description": "CAN: Warning",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_abs_state",
      "description": "CAN: ABS state",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_low_fuel",
      "description": "CAN: Low fuel",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_glow_plug_indicator",
      "description": "CAN: Glow plug indicator",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_electronics_power_control",
      "description": "CAN: Electronic Power Control",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_parking_lights",
      "description": "CAN: Parking lights",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_dipped_headlights",
      "description": "CAN: Dipped headlights",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_full_beam_headlights",
      "description": "CAN: Full beam headlights",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_ready_to_drive",
      "description": "CAN: Ready to drive",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_automatic_retarder",
      "description": "CAN: Automatic retarder",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_manual_retarder",
      "description": "CAN: Manual retarder",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_air_conditioning",
      "description": "CAN: Air conditioning",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_rear_fog_lights",
      "description": "CAN: Rear fog lights",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_front_fog_lights",
      "description": "CAN: Front fog lights",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_additional_front_fog_lights",
      "description": "CAN: Additional front fog lights",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_additional_rear_lights",
      "description": "CAN: Additional rear lights",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_light_signal",
      "description": "CAN: Light signal",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_rear_left_seat_belt_state",
      "description": "Rear left passenger belt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Locked",
        "1": "Unlocked"
      }
    },
    {
      "input_name": "can_rear_right_seat_belt_state",
      "description": "Rear right passenger belt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Locked",
        "1": "Unlocked"
      }
    },
    {
      "input_name": "can_rear_centre_seat_belt_state",
      "description": "Rear center passenger belt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "Locked",
        "1": "Unlocked"
      }
    },
    {
      "input_name": "can_front_passenger_presence",
      "description": "CAN: Front passenger presence",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_front_diff_locked",
      "description": "CAN: Front differential locked",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_rear_diff_locked",
      "description": "CAN: Rear differential locked",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_central_diff_4hi_locked",
      "description": "CAN: Central differential (4HI) locked",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_central_diff_4lo_locked",
      "description": "CAN: Central differential with reductor (4LO) locked",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_trailer_axle_lift_active_1",
      "description": "CAN: Trailer axle lift 1",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_trailer_axle_lift_active_2",
      "description": "CAN: Trailer axle lift 2",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_clutch_state",
      "description": "CAN: Clutch state",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_pto_drive_engagement",
      "description": "CAN: PTO drive engagement",
      "value_type": "String"
    },
    {
      "input_name": "can_adblue_status",
      "description": "CAN: AdBlue status",
      "value_type": "String"
    },
    {
      "input_name": "can_mil_indicator",
      "description": "CAN: MIL indicator",
      "value_type": "String"
    },
    {
      "input_name": "can_current_gear",
      "description": "CAN: Current gear",
      "value_type": "Integer"
    },
    {
      "input_name": "can_pto_state",
      "description": "CAN: PTO state",
      "value_type": "String"
    },
    {
      "input_name": "can_j1939_fault_codes",
      "description": "CAN: J1939 DTC",
      "value_type": "String"
    },
    {
      "input_name": "can_j1708_fault_codes",
      "description": "can_j1708_fault_codes",
      "value_type": "String"
    },
    {
      "input_name": "can_e_charger_bms_com_timeout",
      "description": "CAN: Charger BMS COM timeout",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_charger_crc_violation",
      "description": "CAN: Charger CRC violation",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_charger_mc_violation",
      "description": "CAN: Charger MC violation",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_malfunction_indicator",
      "description": "CAN: Malfunction indicator",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_vehicle_available",
      "description": "CAN: Vehicle available",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_kill_switch_active",
      "description": "CAN: Kill switch active",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_kickstand_release",
      "description": "CAN: Kickstand release",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_over_under_temperature",
      "description": "CAN: Over/under temperature",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_battery_on_off",
      "description": "CAN: Battery on/off",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_warning_undervoltage",
      "description": "CAN: Undervoltage",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_warning_overvoltage",
      "description": "CAN: Overvoltage",
      "value_type": "Boolean"
    },
    {
      "input_name": "can_e_warning_overcurrent",
      "description": "CAN: Overcurrent",
      "value_type": "Boolean"
    },
    {
      "input_name": "uds_vin",
      "description": "UDS: VIN",
      "value_type": "String"
    },
    {
      "input_name": "uds_sb_lock_status_front_left",
      "description": "UDS: Lock status of the front left seatbelt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "unlocked",
        "1": "locked"
      }
    },
    {
      "input_name": "uds_sb_lock_status_front_right",
      "description": "UDS: Lock status of the front right seatbelt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "unlocked",
        "1": "locked"
      }
    },
    {
      "input_name": "uds_sb_lock_status_rear_left",
      "description": "UDS: Lock status of the back left seatbelt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "unlocked",
        "1": "locked"
      }
    },
    {
      "input_name": "uds_sb_lock_status_rear_right",
      "description": "UDS: Lock status of the back right seatbelt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "unlocked",
        "1": "locked"
      }
    },
    {
      "input_name": "uds_sb_lock_status_rear_middle",
      "description": "UDS: Lock status of the back rear middle seatbelt",
      "value_type": "Boolean",
      "value_titles": {
        "0": "unlocked",
        "1": "locked"
      }
    },
    {
      "input_name": "uds_sb_indicator_lamp",
      "description": "UDS: Seatbelt unfastened warning lamp",
      "value_type": "Boolean",
      "value_titles": {
        "0": "off",
        "1": "on"
      }
    },
    {
      "input_name": "uds_dtc_service_codes",
      "description": "UDS: DTC",
      "value_type": "String"
    },
    {
      "input_name": "uds_park_brake_status",
      "description": "UDS: Handbrake status",
      "value_type": "Integer",
      "value_titles": {
        "0": "in rest position",
        "1": "pulled",
        "2": "pressed",
        "3": "fault"
      }
    },
    {
      "input_name": "uds_boot_status",
      "description": "UDS: State of boot",
      "value_type": "Boolean",
      "value_titles": {
        "0": "closed",
        "1": "open"
      }
    },
    {
      "input_name": "uds_hood_status",
      "description": "UDS: State of hood",
      "value_type": "Boolean",
      "value_titles": {
        "0": "closed",
        "1": "open"
      }
    },
    {
      "input_name": "uds_mil",
      "description": "UDS: MIL status (check engine)",
      "value_type": "Boolean"
    },
    {
      "input_name": "uds_general_door_status",
      "description": "UDS: Door state",
      "value_type": "Integer",
      "value_titles": {
        "0": "closed",
        "1": "open",
        "2": "not installed"
      }
    },
    {
      "input_name": "uds_door_status_front_left",
      "description": "UDS: Door front left",
      "value_type": "Integer",
      "value_titles": {
        "0": "closed",
        "1": "open",
        "2": "not installed"
      }
    },
    {
      "input_name": "uds_door_status_front_right",
      "description": "UDS: Door front right",
      "value_type": "Integer",
      "value_titles": {
        "0": "closed",
        "1": "open",
        "2": "not installed"
      }
    },
    {
      "input_name": "uds_door_status_rear_left",
      "description": "UDS: Door rear left",
      "value_type": "Integer",
      "value_titles": {
        "0": "closed",
        "1": "open",
        "2": "not installed"
      }
    },
    {
      "input_name": "uds_door_status_rear_right",
      "description": "UDS: Door rear right",
      "value_type": "Integer",
      "value_titles": {
        "0": "closed",
        "1": "open",
        "2": "not installed"
      }
    },
    {
      "input_name": "uds_pass_airbag_switch",
      "description": "UDS: Passenger airbag",
      "value_type": "Boolean",
      "value_titles": {
        "0": "closed",
        "1": "open"
      }
    },
    {
      "input_name": "uds_airbag_warning_lamp",
      "description": "UDS: Warning lamp for airbag",
      "value_type": "Boolean",
      "value_titles": {
        "0": "off",
        "1": "on"
      }
    },
    {
      "input_name": "uds_warn_brake_lining_wear",
      "description": "UDS: Brake lining wear",
      "value_type": "Integer",
      "value_titles": {
        "0": "OK or none active",
        "1": "active or 1 stage reached",
        "2": "2 stage reached"
      }
    },
    {
      "input_name": "uds_warn_brake_fluid_level_low",
      "description": "UDS: Brake fluid level low",
      "value_type": "Boolean",
      "value_titles": {
        "0": "no",
        "1": "yes"
      }
    },
    {
      "input_name": "uds_warn_coolant_level_low",
      "description": "UDS: Coolant level low",
      "value_type": "Boolean",
      "value_titles": {
        "0": "no",
        "1": "yes"
      }
    },
    {
      "input_name": "presence_device_absent",
      "description": "Identifier of the absent presence device",
      "value_type": "String"
    },
    {
      "input_name": "absent_device_recovered",
      "description": "Identifier of the absent device that was recovered",
      "value_type": "String"
    }
  ],
  "success": true
}

Tracker

This document contains tracker object structure and API calls to interact with it.

This document contains tracker object structure and API calls to interact with it. Tracker is one of the key entities in our API. It represents tracking device registered in our GPS monitoring system. Lots of API calls created for manipulation of tracker and/or its properties.

Tracker object structure

id - int. Tracker ID aka object_id.
label - string. Tracker label.
clone - boolean. true if this tracker is clone.
group_id - int. Tracker group ID, 0 when no group.
avatar_file_name - string. Optional. Passed only if present.
source - object.
- id - int. Source ID.
- device_id - string. Device ID aka source_imei.
tag_binding - object. List of attached tags. Appears only for call.
- tag_id - int. An ID of tag. Must be unique for a tracker.
- ordinal - int. Number that can be used as ordinal or kind of tag. Must be unique for a tracker. Max value is 5.

Tracker output info

number - int. Output number.
title - string. User-defined output name.

Tracker input types

ignition - Car's ignition. There can be only one sensor of this type.
engine - Engine's working status.
mass - Car's "ground".
car_alarm - Expected to be "on" when car alarm triggered.

API actions

API base path: /tracker.

read

Gets tracker info by ID.

Parameters

name

description

type

format

Examples

Response

See tracker object structure description .

Errors

201 - Not found in the database – if tracker not found.

list

Gets user's trackers with optional filtering by labels. We described this API call in the .

Parameters

name

description

type

format

Constraints for labels:

Labels array size: minimum 1, maximum 1024.
No null items.
No duplicate items.
Item length: minimum 1, maximum 60.

For example, we have trackers with labels "aa1", "bb2", "cc3", if we pass labels=["aa","b"] only trackers containing "aa1" and "bb2" will be returned.

Examples

Response

See tracker object structure description .

Errors

types only.

corrupt

Marks tracker as deleted and corrupt its source, device_id and phone.

required sub-user rights: tracker_register.

Parameters

name

description

type

format

Examples

Response

Errors

13 – Operation not permitted – if tracker already connected to server, or if user has insufficient rights.
243 – Device already connected.
201 – Not found in the database - if tracker not found.
219 – Not allowed for clones of the device - if source tracker is clone itself.

delete

Deletes a tracker if it is "clone". Will not work if specified ID of the original tracker.

required sub-user rights: admin (available only to master users).

Parameters

name

description

type

format

Examples

Response

Errors

201 - Not found in the database – if tracker not found.
249 - Operation available for clones only – if tracker is not clone.
203 - Delete entity associated with – if there are some rules or vehicles associated with tracker.

rules - list of associated rule IDs.
vehicles - list of associated vehicle IDs.

change_phone

Changes tracker's phone and setup new apn.

required sub-user rights: tracker_configure.

Parameters

name

description

type

format

Examples

cURL

Response

Errors

201 - Not found in the database – if tracker not found.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
219 – Not allowed for clones of the device - if specified tracker is a clone.
214 – Requested operation or parameters are not supported by the device - if device does not have GSM module.

get_diagnostics

Gets last CAN and OBD sensors and states values received from the device.

Parameters

name

description

type

format

Examples

Response

user_time - . Current time in user's timezone.
inputs - list of sensor value objects.
- label - string. Sensor's label. E.g. "Sensor #1".

List of available sensor's input names for the object sensor value:

obd_consumption.
obd_rpm.
obd_fuel.
obd_coolant_t.

List of state names for the field states:

obd_vin (value type: string).
obd_dtc_number (DTC codes number; value type: integer).
obd_dtc_codes (DTC codes; value type: string).
obd_dtc_cleared_distance (distance traveled since codes cleared in km; value type: double).

You can locate all inputs, states, and definitions by utilizing the API call.

Errors

201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

get_fuel

Gets current fuel level (in liters) of tracker's fuel tanks.

Parameters

name

description

type

format

Examples

Response

user_time - . Current time in user's timezone.
inputs - array of last readings of fuel-related sensors. Items are object listed below.

List of available sensor's input names for the object sensor value:

fuel_level.
fuel_frequency.
lls_level_x (range for x: [1 – 16]).
fuel_consumption.

Errors

201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

get_inputs

Gets current state of tracker's digital inputs and "semantic" inputs (ignition, buttons, car alarms, etc.) bound to them (if any).

Parameters

name

description

type

format

Examples

Response

user_time - . Current time in user's timezone.
inputs - array (boolean) of states of all digital inputs. [true, true, false] means input 1 is on, input 2 is on, input 3 is off.
states - array of state objects.

Errors

201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

batch_get_inputs

Gets current state of trackers' digital inputs and "semantic" inputs (ignition, buttons, car alarms, etc.) bound to them (if any).

Parameters

name

description

type

format

Examples

Response

user_time - . Current time in user's timezone.
data - object. Input info mapped to tracker ids.

Input info:

inputs - array (boolean) of states of all digital inputs. [true, true, false] means input 1 is on, input 2 is on, input 3 is off.
states - array of state objects.
- type - . One of predefined semantic

Errors

217 - List contains nonexistent entities - if one of trackers either does not exist or is blocked.
221 - Device limit exceeded - if too many IDs were passed in trackers parameter.

get_outputs

Gets tracker's outputs info

Parameters

name

description

type

format

Examples

=== "HTTP GET"

Response

result - array of objects. Array of output info objects described .

Errors

201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

batch_get_outputs

Gets trackers' outputs info

Parameters

name

description

type

format

Examples

Response

result - object. Array of output info objects described mapped to tracker ids.

Errors

217 - List contains nonexistent entities - if one of trackers either does not exist or is blocked.
221 - Device limit exceeded - if too many IDs were passed in trackers parameter.

output/update

Updates tracker's outputs info

Parameters

name

description

type

Examples

cURL

Response

Errors

201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

get_last_gps_point

Gets last point of the tracker located by GPS. Points located by GSM LBS are excluded from consideration.

Parameters

name

description

type

format

Examples

Response

value - track point object.
- get_time - . GPS timestamp of the point, in user's timezone.
- heading - int. Direction bearing in degrees (0-360).

Errors

201 - Not found in the database – if there is no tracker with such ID belonging to authorized user.
208 - Device blocked – if tracker exists but was blocked due to tariff restrictions or some other reason.

get_readings

Gets last sensor values for sensors that are:

metering.
not can- or obd-based.
not "fuel" sensors.

Parameters

name

description

type

format

Examples

Response

user_time - . Current time in user's timezone.
inputs - list of sensor value objects. See below.
- label - string. Sensor's label. E.g. "Sensor #1".

List of available sensor's input names for the object sensor value:

composite.
input_status.
analog_x (range for x: [1 – 8]).
freq_x (range for x: [1 – 8]).

Errors

201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

get_state

Gets current tracker state (gps, gsm, outputs, etc.).

name

description

type

format

Examples

Response

user_time - . Current time in user's timezone.
source_id - int. Tracker data source ID (from "sources" table).
gps - gps object.

Errors

201 – Not found in the database (if there is no tracker with such ID belonging to authorized user).
208 – Device blocked (if tracker exists but was blocked due to tariff restrictions or some other reason).

get_states

Gets current states (gps, gsm, outputs, etc.) for several trackers.

Parameters

name

description

type

format

Examples

cURL

Response

user_time - . Current time in user's timezone.
states - object. A map containing state objects for requested trackers, where the key is the tracker ID and the value is the state (see state object description in response).
blocked - array of tracker IDs. Returned only if list_blocked=true.

Errors

201 – Not found in the database (if tracker corrupted and allow_not_exist = false).
208 – Device blocked (if list_blocked = false and tracker exists but was blocked due to tariff restrictions or some other reason).
217 – List contains nonexistent entities (if allow_not_exist = false and there are nonexistent trackers belonging to an authorized user).

list_models

Gets all integrated tracker models (from "models" table).

Parameters

name

description

type

format

Examples

Response

id - int. Model ID.
vendor - string. Vendor name.
code - string. Model text code

ID type

An ID type used to determine the information needed to register device in our system (see ).

Possible values are:

imei – means device uses IMEI as its identifier, e.g. "356938035643809". See . When needed, you should pass only digits of IMEI, no spaces, minus signs, etc.
meid means device uses MEID consisting of 14 HEX digits as its identifier, e.g. "A10000009296F2". See .
id,n – means device uses n-digit identifier (factory ID with length N), for example, "id,7" means that you must pass 7-digit number, for example "1234567".

Errors

types only.

tags/set

Set tags for a tracker. Tags must be created.

Parameters

name

description

type

format

Examples

cURL

Response

Errors

types only.

location_request

Execute this command to get current position of the device. The device must support requesting function.

Parameters

name

description

type

format

Request types:

sms – GNSS data via SMS. Will send an SMS to request location. SMS gateway must be installed for the panel.
gsm – GSM LBS data via GPRS. Device must have online or GPS not updated status.
gprs – GNSS data via GPRS. Device must have online or GPS not updated

Examples

Response

Errors

201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
213 – Cannot perform action: the device is offline.
214 – Requested operation or parameters are not supported by the device.

register

Registers a new tracker device. During registration, device linked with current API user's account and automatically configured to send data to our servers (if device model supports it). The panel must have installed SMS gateway.

Find detailed instructions on tracker registration .

required sub-user rights: tracker_register.

Parameters

Important! Because of the variety of tracker models and business applications, there are different ways to register tracker in our system. They are called . Each of registration plugins has its own set of additional parameters.

In addition to parameters specified in this section, pass all parameters which are required by the plugin you have chosen. See example below.

Common parameters are:

name

description

type

format

Examples

In this example we use plugin ID = 37 (see ) to register Queclink GV55Lite. We chose to include the device to default group, so group ID is 0. As this device identified by IMEI, we include it as device ID (123451234512346).

Also, we include phone, apn_name, apn_user, apn_password of the sim card installed in device and activation_code since these parameters required by the plugin.

Response

For tracker object structure, see .

Errors

13 – Operation not permitted – if user has insufficient rights.
204 – Entity not found - if specified group does not exist. See .
220 – Unknown device model - if specified device model does not exist.
221 – Device limit exceeded - if device limit set for the user's dealer has been exceeded.

register_retry

Resends registration commands to the device. The panel must have installed SMS gateway.

required sub-user rights: tracker_register.

Parameters

name

description

type

format

Examples

Response

For tracker object structure, see .

Errors

13 – Operation not permitted – if user has insufficient rights.
201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
219 – Not allowed for clones of the device - if specified tracker is a clone.

register_quick

Registers a new tracker using only IMEI. Automatic SMS commands will not be sent for a register. The device must be preconfigured. This API call can be used only for bundles.

required sub-user rights: tracker_register.

Parameters

name

description

type

format

Examples

Response

For tracker object structure, see .

Errors

13 – Operation not permitted – if user has insufficient rights.
201 – Not found in the database - if there is no bundle with such IMEI.
204 – Entity not found - if specified group does not exist.
220 – Unknown device model - if specified device model does not exist.

replace

Lets to replace the device without losing its history and some of its settings. Replacement allows you to register a new device with history, sensors (optional), and rules (optional) of the current tracker saved.

required sub-user rights: tracker_configure.

Parameters

Important! Because of the variety of tracker models and business applications, there are different ways to register a new tracker in our system. They are called . Each of registration plugins has its own set of additional parameters. In addition to parameters specified in this section, pass all parameters which are required by the plugin you have chosen. See example below.

Common parameters are:

name

description

type

format

Examples

In this example we use plugin ID = 37 (see ) to replace device with Queclink GV55Lite. As this device identified by IMEI, we include it as device ID (123451234512346).

Also, we include phone, apn_name, apn_user, apn_password of the sim card installed in device. Activation code is not used when replacing a device.

Response

For tracker object structure, see .

Errors

7 – Invalid parameters - if fields violate restrictions described above or one of the models is a mobile app.
13 – Operation not permitted - if user has insufficient rights.
204 – Entity not found - if specified group does not exist. See .
220 – Unknown device model - if specified device model does not exist.

replace_quick

Replaces a device using only IMEI. Automatic SMS commands will not be sent for an activation. The replacement device must be preconfigured. This API call can be used only for bundles.

required sub-user rights: tracker_configure.

Parameters

name

description

type

format

Examples

Response

For tracker object structure, see .

Errors

7 – Invalid parameters - if fields violate restrictions described above or one of the models is a mobile app.
13 – Operation not permitted - if user has insufficient rights.
201 – Not found in the database - if there is no bundle with such IMEI.
204 – Entity not found - if specified group does not exist.

replace_retry

Resends registration commands to the new device. The panel must have installed SMS gateway.

required sub-user rights: tracker_configure.

Parameters

name

description

type

format

Examples

Response

For tracker object structure, see .

Errors

13 – Operation not permitted – if user has insufficient rights.
204 – Entity not found - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
219 – Not allowed for clones of the device - if specified tracker is a clone.

send_command

Sends command to tracker for performing special control, determined with special_control field of tracker model.

required sub-user rights: tracker_configure, tracker_set_output.

common command format is:

name - Command name.
some_parameter - Parameters depend on certain command.
special_settings - optional field. Its structure defined with special_control field of tracker model.

Certain commands which can be used is defined with special_control field of tracker model and corresponds the table below:

special control

available commands

command types

electronic_lock_command

This command used to seal/unseal electronic lock.

command_code - . Can be "seal" or "unseal".
special_settings - This command is equivalent to API call .

See

Parameters

name

description

type

format

Examples

cURL

Response

For tracker object structure, see .

Errors

types only.

raw_command/send

Sends the GPRS command to the device, processing it in a protocol-dependent manner beforehand.

Find more information about this API call usage in our .

required sub-user rights: tracker_configure, tracker_set_output.

Parameters

name

description

type

Example

cURL

Response

Errors

7 - Invalid parameters.
201 - Not found in the database – if there is no tracker with such device ID belonging to authorized user.

Example response with an error:

Rule types

Rule types with all parameters to create. The rule availability depends on the device, connected and configured equipment and rule integration for it.

Geofence entrance or exit

A rule that triggers on device entering/exiting created on platform geofences.

Parameters

name

description

type

extended parameters

name

description

type

Parking state detection

A rule that triggers on detection of parking state calculated based on .

Parameters

name

description

type

extended parameters

name

description

type

A rule that triggers on speed exceeding determined by hardware. Based on the configs on the device side.

Parameters

name

description

type

extended parameters

description

type

A rule that triggers on excessive idling registered by hardware. Based on the configs on the device side.

Parameters

name

description

type

extended parameters

name

description

type

A rule that triggers on excessive idling registered by the platform. The idling time is calculated based on and ignition state.

Parameters

name

description

type

extended parameters

name

description

type

Fuel level change

Rule triggered by a drastic change in fuel level. A drastic change is when the fuel level changes faster than the accuracy of the sensor in a span of ten minutes.

Parameters

type

Autocontrol related tracked rules like alarm, battery, doors and others. Based on the configs on the device side.

Parameters

name

description

type

extended parameters

extended parameters

description

type

tracker_params

name

description

type

Example:

State field value

A rule that triggers when specified value of a chosen state field sensor detected.

Parameters

name

description

type

extended parameters

name

description

type

tracker_params

name

description

type