Pagrindinis Vairuotojų laiko analizės API tikslas yra pateikti konkretaus vairuotojo vairavimo ir poilsio laiko duomenis. Pateikti duomenys yra paremti laiko analizės funkcionalumu.
Konkretaus vairuotojo užklausos pavyzdys:
GET /drivers/{driverId}/current-time-analysis?version=1&api_key=<…>
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8
Kad šis API veiktų, privaloma pateikti šiuos parametrus:
Parametras | Tipas | Aprašymas |
---|---|---|
driverId | Tekstas | Vairuotojo identifikatorius (šį ID galima gauti nusiuntus užklausą į Vairuotojų API) |
version | Tekstas | API versija, šiuo metu galima tik version=1 |
api_key | Tekstas | Vartotojo identifikacinis raktas |
Serverio atsako pavyzdys:
{ "type": "PRIMARY", "calculated_until": "2018-05-31T14:47:47.000Z", "state": { "activity": "UNKNOWN", "started_at": "2018-05-24T11:10:00.000Z", "duration": 617820 }, "current_day": { "driving_status": "SINGLE", "driving": { "regular": { "duration": 0, "duration_limit": 32400 }, "extra": { "duration": 0, "duration_limit": 3600 } }, "working": { "duration": 0 }, "resting": { "rest_in_progress": false, "next_rest": null } }, "current_week": { "driving": { "duration": 0, "duration_limit": 201600, "extended_daily_driving_periods": { "used": 0, "usage_limit": 2 } }, "working": { "duration": 0 }, "resting": { "rest_in_progress": false, "next_rest": null, "reduced_daily_rests": { "used":0, "usage_limit": 3 } } }, "previous_week": { "driving": { "duration": 0, "duration_limit": 201600 }, "resting": { "duration": 0 } }, "infringements": { "daily_driving_limit_exceeded": { "duration": 0 }, "weekly_driving_limit_exceeded": { "duration": 0 } }, "data_gap_duration": { "duration": 0 } }
Jei parametrai arba API raktas įvesti neteisingai, sistema pateiks klaidos kodą, visi klaidų kodai aprašyti API skyriuje.
Visi atsakymų, kuriuos galima gauti su kiekvienu parametro tipu, laukeliai aprašyti sekančioje lentelėje:
Pavadinimas | Tipas | Aprašymas | Matavimo vienetai |
---|---|---|---|
type | Tekstas | Nurodo, ar vairuotojas yra pirmasis ar antrasis, tai yra, ar vairuotojo kortelė įdėta į pirmąjį ar antrąjį tachografo kortelės lizdą | Tekstas |
calculated_until | Data | Užklausos išsiuntimo data ir laikas Formatas: "yyyy-mm-ddThh:mm:ss.sssZ" | Pagal ISO8601 |
state | Masyvas | Talpina visus vairuotojo būsenos parametrus | |
activity | Tekstas | Vairuotojo būsena užklausos išsiuntimo metu | Tekstas |
started_at | Data | Vairuotojo būsenos pradžios data ir laikas Formatas: "yyyy-mm-ddThh:mm:ss.sssZ" | Pagal ISO8601 |
duration | Sveikasis skaičius | Bendra vairuotojo būsenos trukmė | Sekundės |
current_day | Masyvas | Talpina visus esamosios dienos parametrus | |
driving_status | Tekstas | Nurodo, ar vairuoja vienas vairuotojas, ar ekipažas | Tekstas |
driving | Masyvas | Talpina visus vairavimo parametrus | |
regular | Masyvas | Talpina visus įprasto vairavimo parametrus | |
duration | Sveikasis skaičius | Bendra įprasto vairavimo trukmė | Sekundės |
duration_limit | Sveikasis skaičius | Maksimali leidžiama įprasto vairavimo trukmė | Sekundės |
extra | Masyvas | Talpina papildomo vairavimo parametrus | |
duration | Sveikasis skaičius | Bendra papildomo vairavimo trukmė | Sekundės |
duration_limit | Sveikasis skaičius | Maksimali leidžiama papildomo vairavimo trukmė | Sekundės |
working | Masyvas | Talpina visus kasdienio darbo parametrus | |
duration | Sveikasis skaičius | Bendra kasdienio darbo trukmė | Sekundės |
resting | Masyvas | Talpina visus kasdienio poilsio parametrus | |
rest_in_progress | Loginė reikšmė | Nurodo, ar vairuotojas ilsėjosi užklausos išsiuntimo metu | True (Tiesa) - False (Netiesa) |
next_rest | Data | Kito kasdienio poilsio data ir laikas Formatas: "yyyy-mm-ddThh:mm:ss.sssZ" | Pagal ISO8601 |
current_week | Masyvas | Talpina visus esamosios savaitės parametrus | |
driving | Masyvas | Talpina visus vairavimo parametrus | |
duration | Sveikasis skaičius | Bendra savaitinio vairavimo trukmė | Sekundės |
duration_limit | Sveikasis skaičius | Maksimali leidžiama savaitinio vairavimo trukmė | Sekundės |
extended_daily_driving_periods | Masyvas | Talpina visus pratęsto kasdienio vairavimo parametrus | |
used | Sveikasis skaičius | Panaudotų pratęsto vairavimo laikotarpių kiekis | Skaičius |
usage_limit | Sveikasis skaičius | Maksimalus pratęsto vairavimo laikotarpių kiekis | Skaičius |
working | Masyvas | Talpina visus savaitinio darbo parametrus | |
duration | Sveikasis skaičius | Bendra savaitinio darbo trukmė | Sekundės |
resting | Masyvas | Talpina visus savaitinio poilsio parametrus | |
rest_in_progress | Loginė reikšmė | Nurodo, ar vairuotojas ilsėjosi užklausos išsiuntimo metu | True (Tiesa) - False (Netiesa) |
next_rest | Data | Kito savaitinio poilsio data ir laikas Formatas: "yyyy-mm-ddThh:mm:ss.sssZ" | Pagal ISO8601 |
reduced_daily_rests | Masyvas | Talpina visus sutrumpinto poilsio parametrus | |
used | Sveikasis skaičius | Panaudotų sutrumpinto poilsio laikotarpių kiekis | Skaičius |
usage_limit | Sveikasis skaičius | Maksimalus sutrumpinto poilsio laikotarpių kiekis | Skaičius |
previous_week | Masyvas | Talpina visus praeitos savaitės parametrus | |
driving | Masyvas | Talpina visus vairavimo parametrus | |
duration | Sveikasis skaičius | Bendra vairavimo trukmė praeitą savaitę | Sekundės |
duration_limit | Sveikasis skaičius | Maksimali leidžiama savaitinio vairavimo trukmė | Sekundės |
resting | Masyvas | Talpina visus praeitos savaitės poilsio parametrus | |
duration | Sveikasis skaičius | Bendra praeitos savaitės poilsio trukmė | Sekundės |
infringements | Masyvas | Talpina visus pažeidimų parametrus | |
daily_driving_limit_exceeded | Masyvas | Talpina visus viršyto kasdienio vairavimo parametrus | |
duration | Sveikasis skaičius | Bendra vairavimo virš kasdienio limito trukmė | Sekundės |
weekly_driving_limit_exceeded | Masyvas | Talpina visus viršyto savaitinio vairavimo parametrus | |
duration | Sveikasis skaičius | Bendra vairavimo virš savaitinio limito trukmė | Sekundės |
data_gap_duration | Masyvas | Talpina visus duomenų negavimo laikotarpio parametrus | |
duration | Sveikasis skaičius | Bendra duomenų negavimo trukmė | Sekundės |
API rezultatus, užklausų parametrus ir atsakymus galima peržiūrėti „Swagger“ programoje, naudojantis šia nuoroda: https://api.fm-track.com