Objektų koordinačių istorijos API

Objektų koordinačių istorijos API pagrindinis tikslas yra išvesti klientų objektų istorinius duomenis (koordinates). Objektų koordinačių istorijos API turi du galutinius taškus, todėl yra du užklausų tipai. Pirmasis užklausos tipas yra vienam objektui su konkrečia data ir laiku. Rodomi tik duomenys, įrašyti nurodytu laiku.

Konkrečios datos užklausos pavyzdys:

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

Šiam užklausos tipui reikia trijų parametrų (neskaitant API rakto), kuriuos reikia nurodyti, kad API prašymas veiktų:

Pastaba
Rekomenduojama naudoti datetime parametrą iš antrojo objektų koordinačių istorijos API galinio taško, sistema neieško duomenų aplink nurodytą datą, o pateikia koordinatę nurodytu laiku.

Užklausos pavyzdys, kai įtraukiami visi parametrai, o API raktas galiojantis:

{
    "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
    }
}

Jei parametras arba API raktas įvestas neteisingai, sistema pateiks klaidos kodą, visi klaidų kodai aprašyti API skyriuje. Parametrai aprašyti šio skyriaus pabaigoje.

Antrojo istorijos API galinio taško atveju rodomi nurodyto laikotarpio duomenys. Kiekvienas duomenų komplektas turi nurodytą laikotarpį, kurį galima naudoti siunčiant pirmojo tipo istorijos API užklausą.

Konkretaus laikotarpio užklausos pavyzdys:

GET /objects/{object_id}/coordinates?version=1{&from_datetime,to_datetime,continuation_token,limit}&api_key=<…>
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8

Šiam užklausos tipui reikia trijų parametrų (neskaitant API rakto), kuriuos reikia nurodyti, kad API užklausa veiktų:

Pasirenkamieji parametrai, kurie nėra privalomi, tačiau juos galima įterpti į užklausą:

Atsakymo pavyzdys pateikiamas žemiau:

{
  "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
     }
    }
  ]
}

Visi atsakymų, kuriuos galima gauti su kiekvienu parametro tipu, laukeliai yra aprašyti šioje lentelėje:

API rezultatus, užklausų parametrus ir atsakymus galima peržiūrėti „Swagger“ programoje, naudojantis šia nuoroda:https://api.fm-track.com