Į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:
| Parametras | Tipas | Aprašymas | Privalomas |
|---|---|---|---|
| object_id | Tekstas | Išorinio objekto ID | Taip |
| from_datetime | Data ir laikas | Rasti įvykius prasidedančius nuo nurodytos datos | Taip |
| to_datetime | Data ir laikas | Rasti įvykius iki nurodytos datos | Taip |
| continuation_token | Sveikasis skaičius | Įterpia tęstinumo simbolį, bei rodo sekantį duomenų komplektą, pasiekus praeitą įrašų limitą | Ne |
| limit | Sveikasis skaičius | Nustato įvykių skaičių atsakyme | Ne |
| version | Tekstas | API versija | Taip |
| api_key | Tekstas | Vartotojo identifikacijos raktas | Taip |
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:
| Parametras | Tipas | Aprašymas |
|---|---|---|
| continuation_token | Sveikasis skaičius | Tęstinumo simbolis gaunamas, kai užklausiamas didelis įrašų kiekis ilgam laikotarpiui, kai viršijamas nustatytas įrašų limitas |
| events | Masyvas | Talpina visus objekto įvykius pasirinktam laikotarpiui |
| name | Tekstas | Įvykio pavadinimas |
| description | Tekstas | Įvykio aprašymas |
| driver_id | Tekstas | Išorinio vairuotojo ID |
| trip_type | Enum | Kelionės tipas |
| duration | Ilgas sveikasis skaičius | Įvykio trukmė sekundėmis |
| start | Masyvas | Talpina visą įvykio pradžios informaciją |
| end | Masyvas | Talpina visą įvykio pabaigos informaciją |
| datetime | Data ir laikas | Data ir laikas |
| location | Masyvas | Talpina koordinates |
| latitude | Skaičius | Platuma |
| longitude | Skaičius | Ilguma |
| mileage | Skaičius | Rida kilometrais |
| speed | Sveikasis skaičius | Greitis km/h |