Kelionių API yra skirtas gauti objektų kelionių istorijas užduotam laiko periodui.
Užklausos struktūra:
GET /objects/{objectId}/trips?version=1&from_datetime=<..>&to_datetime=<..>&continuation_token=<..>&limit=<..>&api_key=<..> HTTP/1.1
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8
Užklausos parametrai:
| Parameter | Tipas | Aprašymas | Ar būtinas? |
|---|---|---|---|
| objectId | Tekstas | Išorinio objekto identifikacinis numeris (ID) | Taip |
| from_datetime | Data ir laikas | Suranda įrašus nuo nurodytos datos ir laiko. Datos ir laiko pavyzdys pagal ISO-8601 standartą: “2019-04-13T06:58:48.090Z” | Taip |
| to_datetime | Data ir laikas | Suranda įrašus iki nurodytos datos ir laiko. Jei konkrečiai nenurodyta, sistema ieško įrašų iki dabartinės datos, kol nepasiektas įrašų limitas. Datos ir laiko pavyzdys pagal ISO-8601 standartą: “2019-04-13T06:58:48.090Z” | Ne |
| continuation_token | Data ir laikas | Įterpia tęstinumo simbolį bei rodo sekantį duomenų komplektą, pasiekus praeitą įrašų limitą | Ne |
| limit | Sveikasis skaičius | Nustato įrašų limitą sistemos atsakyme (numatytoji vertė - 100 įrašų, maksimali vertė - 1000) | Ne |
| version | Tekstas | API versija | Taip |
| api_key | Tekstas | Vartotojo identifikacinis raktas | Taip |
Atsakymo pavyzdys:
{
"continuation_token": "2019-05-24T06:58:48.121Z",
"trips": [
{
"object_id": "ID0000",
"trip_type":"BUSINESS",
"trip_duration": 4781,
"mileage": 10.56,
"driver_ids": ["asdf321","123asdf","fdsa123"],
"trip_start": {
"datetime": "2019-05-24T06:58:48.121Z",
"longitude": 11.2222,,
"latitude": 33.444,
"address": {
"country": "Denmark",
"country_code": "DK",
"county": "",
"region": "",
"locality": "Herlev",
"street": "Unnamed Road",
"house_number": "",
"zip": "2730"
},
"trip_end": {
"datetime": "2019-05-24T06:58:48.121Z",
"longitude": 0,
"latitude": 0,
"address": {
"country": "Denmark",
"country_code": "DK",
"county": "",
"region": "",
"locality": "Herlev",
"street": "Unnamed Road",
"house_number": "",
"zip": "2730"
},
},
...
]
}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 pavyzdys:
| Parametras | Tipas | Aprašymas | Matavimo vienetai |
|---|---|---|---|
| continuation_token | Tęstinumo simbolis gaunamas, kai užklausiamas didelis įrašų kiekis ilgam laikotarpiui, kai viršijamas nustatytas įrašų limitas. Tada atsakymo gale rodomas tęstinumo simbolis, kuris naudojamas norint atvaizduoti sekantį duomenų komplektą pasirinktam laikotarpiui. Jei po simbolio nebėra daugiau duomenų, atsakymas bus tuščias | ||
| trips | Masyvas | Talpina visus parametrus priklausomai nuo užklausos | |
| object_id | Tekstas | Objekto identifikatorius | |
| trip_type | Enum | Kelionės tipas Galimos vertės: UNKNOWN NONE PRIVATE BUSINESS WORK | |
| trip_duration | Data | Kelionės trukmė | s |
| mileage | Skaičius | Nuvažiuotas atstumas kelionės metu | m |
| driver_ids | Masyvas | Talpykla, skirta visiems vairuotojų ID, kurie buvo priskirti transporto priemonei kelionės metu | |
| trip_start | Masyvas | Talpykla, skirta kelionės pradžios parametrams | |
| datetime | Data | Aparatinės įrangos sugeneruota koordinačių data ir laikas Formatas: "yyyy-mm-ddThh:mm:ss.sssZ" | Data |
| longitude | Skaičius | GPS koordinatė – ilguma | Laipsniai |
| latitude | Skaičius | GPS koordinatė – platuma | Laipsniai |
| address | Array | Talpykla, skirta adreso parametrams | |
| country | Tekstas | Šalies pavadinimas | |
| country_code | Tekstas | Šalies kodas | |
| county | Tekstas | Valstijos pavadinimas | |
| region | Tekstas | Regiono pavadinimas | |
| locality | Tekstas | Vietovės pavadinimas | |
| street | Tekstas | Gatvės pavadinimas | |
| house_number | Tekstas | Namo numeris | |
| zip | Tekstas | ZIP kodas | |
| trip_end | Masyvas | Talpykla, skirta kelionės pabaigos parametrams |