Įvykių istorijos API

Įvykių istorijos API yra skirtas gauti objektų įvykių istoriją pasirinktam laikotarpiui.

Užklausos struktūra:

GET /detected-events?object_id=<...>&from_datetime=<...>&to_datetime=<...>&continuation_token=<..>&limit=<..>&version=1&api_key=<..> HTTP/1.1
Host: api.fm-track.com
Content-Type: application/json;charset=UTF-8

Užklausos parametrai:

ParametrasTipasAprašymasPrivalomas
object_idTekstasIšorinio objekto IDTaip
from_datetimeData ir laikasRasti įvykius prasidedančius nuo nurodytos datosTaip
to_datetimeData ir laikasRasti įvykius iki nurodytos datosTaip
continuation_tokenSveikasis skaičiusĮterpia tęstinumo simbolį, bei rodo sekantį duomenų komplektą, pasiekus praeitą įrašų limitąNe
limitSveikasis skaičiusNustato įvykių skaičių atsakymeNe
versionTekstasAPI versijaTaip
api_keyTekstasVartotojo identifikacijos raktasTaip

Atsakymo pavyzdys:

{
  "continuation_token": 1,
  "events": [
    {
      "name": "ToyotaIgnition",
      "description": "TestIgnition",
      "driver_id": null,
      "trip_type": "NONE",
      "duration": 31,
      "start": {
        "datetime": "2020-02-10T09:13:23.000Z",
        "location": {
          "latitude": 54.924457,
          "longitude": 23.872841
        },
        "mileage": 6000.0,
        "speed": 40
      },
      "end": {
        "datetime": "2020-02-10T09:13:54.000Z",
        "location": {
          "latitude": 54.924457,
          "longitude": 23.872841
        },
        "mileage": 6000.0
      }
    },
    ...
  ]
}

Jei parametras arba API raktas įvestas neteisingai, sistema pateiks klaidos kodą, visi klaidų kodai aprašyti API skyriuje. Parametrai, kuriems duomenys nėra pateikti, nėra įtraukiami į atsakymą. Parametrai aprašyti šio skyriaus pabaigoje.

Atsakymo parametrai:

ParametrasTipasAprašymas
continuation_tokenSveikasis skaičiusTęstinumo simbolis gaunamas, kai užklausiamas didelis įrašų kiekis ilgam laikotarpiui, kai viršijamas nustatytas įrašų limitas
eventsMasyvasTalpina visus objekto įvykius pasirinktam laikotarpiui
nameTekstasĮvykio pavadinimas
descriptionTekstasĮvykio aprašymas
driver_idTekstasIšorinio vairuotojo ID
trip_typeEnumKelionės tipas
durationIlgas sveikasis skaičiusĮvykio trukmė sekundėmis
startMasyvasTalpina visą įvykio pradžios informaciją
endMasyvasTalpina visą įvykio pabaigos informaciją
datetimeData ir laikasData ir laikas
locationMasyvasTalpina koordinates
latitudeSkaičiusPlatuma
longitudeSkaičiusIlguma
mileageSkaičiusRida kilometrais
speedSveikasis skaičiusGreitis km/h