Vairuotojų laiko analizės API

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:

ParametrasTipasAprašymas
driverIdTekstasVairuotojo identifikatorius (šį ID galima gauti nusiuntus užklausą į Vairuotojų API)
versionTekstasAPI versija, šiuo metu galima tik version=1
api_keyTekstasVartotojo 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:

PavadinimasTipasAprašymasMatavimo vienetai
typeTekstasNurodo, ar vairuotojas yra pirmasis ar antrasis, tai yra, ar vairuotojo kortelė įdėta į pirmąjį ar antrąjį tachografo kortelės lizdąTekstas
calculated_untilDataUžklausos išsiuntimo data ir laikas
Formatas: "yyyy-mm-ddThh:mm:ss.sssZ"
Pagal ISO8601
stateMasyvasTalpina visus vairuotojo būsenos parametrus
activityTekstasVairuotojo būsena užklausos išsiuntimo metuTekstas
started_atDataVairuotojo būsenos pradžios data ir laikas
Formatas: "yyyy-mm-ddThh:mm:ss.sssZ"
Pagal ISO8601
durationSveikasis skaičiusBendra vairuotojo būsenos trukmėSekundės
current_dayMasyvasTalpina visus esamosios dienos parametrus
driving_statusTekstasNurodo, ar vairuoja vienas vairuotojas, ar ekipažas Tekstas
drivingMasyvasTalpina visus vairavimo parametrus
regularMasyvasTalpina visus įprasto vairavimo parametrus
durationSveikasis skaičiusBendra įprasto vairavimo trukmėSekundės
duration_limitSveikasis skaičiusMaksimali leidžiama įprasto vairavimo trukmėSekundės
extraMasyvasTalpina papildomo vairavimo parametrus
durationSveikasis skaičiusBendra papildomo vairavimo trukmėSekundės
duration_limitSveikasis skaičiusMaksimali leidžiama papildomo vairavimo trukmėSekundės
workingMasyvasTalpina visus kasdienio darbo parametrus
durationSveikasis skaičiusBendra kasdienio darbo trukmėSekundės
restingMasyvasTalpina visus kasdienio poilsio parametrus
rest_in_progressLoginė reikšmėNurodo, ar vairuotojas ilsėjosi užklausos išsiuntimo metu True (Tiesa) - False (Netiesa)
next_restDataKito kasdienio poilsio data ir laikas
Formatas: "yyyy-mm-ddThh:mm:ss.sssZ"
Pagal ISO8601
current_weekMasyvasTalpina visus esamosios savaitės parametrus
drivingMasyvasTalpina visus vairavimo parametrus
durationSveikasis skaičiusBendra savaitinio vairavimo trukmėSekundės
duration_limitSveikasis skaičiusMaksimali leidžiama savaitinio vairavimo trukmėSekundės
extended_daily_driving_periodsMasyvasTalpina visus pratęsto kasdienio vairavimo parametrus
usedSveikasis skaičiusPanaudotų pratęsto vairavimo laikotarpių kiekisSkaičius
usage_limitSveikasis skaičiusMaksimalus pratęsto vairavimo laikotarpių kiekis Skaičius
workingMasyvasTalpina visus savaitinio darbo parametrus
durationSveikasis skaičiusBendra savaitinio darbo trukmėSekundės
restingMasyvasTalpina visus savaitinio poilsio parametrus
rest_in_progressLoginė reikšmėNurodo, ar vairuotojas ilsėjosi užklausos išsiuntimo metuTrue (Tiesa) - False (Netiesa)
next_restDataKito savaitinio poilsio data ir laikas
Formatas: "yyyy-mm-ddThh:mm:ss.sssZ"
Pagal ISO8601
reduced_daily_restsMasyvasTalpina visus sutrumpinto poilsio parametrus
usedSveikasis skaičiusPanaudotų sutrumpinto poilsio laikotarpių kiekisSkaičius
usage_limitSveikasis skaičiusMaksimalus sutrumpinto poilsio laikotarpių kiekisSkaičius
previous_weekMasyvasTalpina visus praeitos savaitės parametrus
drivingMasyvasTalpina visus vairavimo parametrus
durationSveikasis skaičiusBendra vairavimo trukmė praeitą savaitęSekundės
duration_limitSveikasis skaičiusMaksimali leidžiama savaitinio vairavimo trukmėSekundės
restingMasyvasTalpina visus praeitos savaitės poilsio parametrus
durationSveikasis skaičiusBendra praeitos savaitės poilsio trukmėSekundės
infringementsMasyvasTalpina visus pažeidimų parametrus
daily_driving_limit_exceededMasyvasTalpina visus viršyto kasdienio vairavimo parametrus
durationSveikasis skaičiusBendra vairavimo virš kasdienio limito trukmėSekundės
weekly_driving_limit_exceededMasyvasTalpina visus viršyto savaitinio vairavimo parametrus
durationSveikasis skaičiusBendra vairavimo virš savaitinio limito trukmėSekundės
data_gap_durationMasyvasTalpina visus duomenų negavimo laikotarpio parametrus
durationSveikasis skaičiusBendra 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