Object Coordinates History API

Object Coordinates History API main purpose is to output clients’ object historical data (coordinates). Object Coordinates History API has two endpoints, thus there are two types of requests. The first type of request is for one object and a specific date and time. Only data recorded at the specified date and time is shown.

Request example for a specific date:

GET /objects/{object_id}/coordinates/{datetime}/?version=1&api_key=<..> HTTP/1.1
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8

The request type requires three parameters (not counting the API_key) to be specified in order for the API request to work:

Note
It is recommended to use datetime parameter from the second endpoint of the Object Coordinates History API because the date time parameter is specified by the second, and the system does not search for data around the specified date.

A response example is shown if all the parameters were included and the API_key is valid:

{
    "object_id" : "abc123",
    "datetime" : "2017-04-13T06:58:48.090Z",
    "ignition_status" : "UNKNOWN",
    "position" : {
        "altitude" : 0,
        "direction" : 0,
        "latitude" : 0,
        "longitude" : 0,
        "hdop": 0,
        "satellites_count" : 0,
        "speed" : 0
    },
    "device_inputs" : {
        "digital_input_1" : true,
        "digital_input_2" : true,
        "digital_input_3" : true,
        "digital_input_4" : true,
        "power_supply_voltage" : 0,
        "ibutton" : "xxxxxxxxxx",
        "first_driver_id" : "xxxxxxxxxx",
        "second_driver_id" : "xxxxxxxxxx",
         "temperature_sensor_0": 0,
         "temperature_sensor_1": 0,
         "temperature_sensor_2": 0,
         "temperature_sensor_3": 0,
         "temperature_sensor_0_id": "xxxxxxxxxx"
    },
    "calculated_inputs":{
        "mileage" : 0
    }
}

If a parameter or the API_key was inputted incorrectly, the system will respond with an error code, all possible error codes are described in the APIs section. Parameters are described at the end of this section.

The second endpoint of the History API displays an array of  history data for a defined period of time. Each set of data has a specified date and time, which can be used when sending the first type of History API request.

Request example for a specific date period:

GET /objects/{object_id}//coordinates?version=1{&fromDatetime,toDatetime,continuationToken,limit}&api_key=<..> HTTP/1.1
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8

The request type requires three parameters (not counting the API_key) to be specified in order for the API request to work:

Optional parameters that are not mandatory, but can be included in the request:

A response example is shown below:

{
  "continuation_token": "2017-04-13T06:58:48.121Z",
  "items": [
    {
     "object_id" : "abc123",
     "datetime" : "2017-04-13T06:58:48.090Z",
     "ignition_status" : "UNKNOWN",
     "position" : {
         "altitude" : 0,
         "direction" : 0,
         "latitude" : 0,
         "longitude" : 0,
         "hdop": 0,
         "satellites_count" : 0,
         "speed" : 0
     },
     "device_inputs" : {
         "digital_input_1" : true,
         "digital_input_2" : true,
         "digital_input_3" : true,
         "digital_input_4" : true,
         "power_supply_voltage" : 0,
         "ibutton" : "xxxxxxxxxx",
         "first_driver_id" : "xxxxxxxxxx",
         "second_driver_id" : "xxxxxxxxxx",
         "temperature_sensor_0": 0,
         "temperature_sensor_1": 0,
         "temperature_sensor_2": 0,
         "temperature_sensor_3": 0,
         "temperature_sensor_0_id": "xxxxxxxxxx"
     },
     "calculated_inputs":{
         "mileage" : 0
     }
    }
  ]
}

All response fields than can be received with every type of parameter are described in the next table:

API endpoints, request parameters and responses can be previewed in “Swagger” through this link : https://api.fm-track.com