Object Coordinates Streaming API v3

Note
This API is not included in any plan. Please contact your sales manager to order and enable this API.

The Object Coordinates Streaming API v3 is used to inform the user about object changes. This particular API works as a stream of information, using SSE (server sent events) technology. Once the user has sent an API request, first the last known coordinate for each object is displayed, afterwards new data will be outputted to the user as soon as a change occurs.  There is no need to resend the API request unless the streaming connection was broken. 

Note
The connection will be automatically terminated after 4 hours if there are no new records.

Note
The API returns the last known coordinate. In cases when the API stream was ongoing and for some reason was reconnected with no new coordinates received during that time, the user will receive the last know coordinate, which has already been received once, thus duplicating the coordinate record. This should be kept in mind, since it may cause issues in various systems.

Object Coordinates Streaming API v3 can be initiated for either for one specific object, or for all objects available to the user.

Real-time data request for a specific object

Request structure:

GET /object-coordinates-stream?version=3&object_id=<…>&api_key=<…>& HTTP/1.1
Host: api.fm-track.com
Content-Type: text/event-stream;charset=UTF-8

curl -N –http2 “https://api.fm-track.com/object-coordinates-stream?version=3&object_id=<…>&api_key=<…>”

Real-time data request for all objects

Request structure:

GET /object-coordinates-stream?version=3&api_key=<…>&include_geozones=<…> HTTP/1.1
Host: api.fm-track.com
Content-Type: text/event-stream;charset=UTF-8

curl -N –http2 “https://api.fm-track.com/object-coordinates-stream?version=3&api_key=<…>”

Response example

data:
{
    "object_id":"abc123",
    "datetime":"2019-02-11T02:00:00.000Z",
    "ignition_status":"OFF",
    "position":{
        "altitude" : 0,
        "direction" : 0,
        "latitude" : 0,
        "longitude" : 0,
        "satellites_count" : 0,
        "speed" : 0
    },
    "address": {
        "country": "Poland",
        "country_code": "PL",
        "county": "Województwo dolnośląskie",
        "region": "",
        "locality": "",
        "street": "E67",
        "house_number": "",
        "zip": "55"
    },
    "inputs":{
        "other":{
            "virtual_gps_odometer":0.0000,
            "country_code_geonames":91
        },
        "device_inputs":{
            "virtual_odometer":5.00,
            "digital_input_4":false,
            "driver_1_state":"DRIVE",
            "input_trigger":0,
            "tco_first_driver_state":"DRIVE",
            "priority":"LOW",
            ....,
            "hdop":"0.0"
        },
        "calculated_inputs":{
            "din4_working_time":0.00,
            "custom_input_3":0.00,
            "custom_input_6":0.00,
            "temperature":0.00,
            "custom_input_1":0.00,
            ....,
            "custom_input_2":0.00,
            "mileage":5000.00
        }
    },
    "geozone_ids":["fde96c01","9b32bd68","95dcd895"]
}

If a parameter was entered incorrectly, the system will respond with an error code. All error codes are described in the APIs section. Parameters for which no data is provided are not included in the response. A full list of response parameters is available at the end of this section.

Response parameters