Työkalut ja parametrit¶
Tämä viite muodostetaan MCP-version 0.2.0 yhteisistä julkisista työkalumäärittelyistä ja tarkistetuista suomennoksista. Sivustoa rakennettaessa ei oteta yhteyttä data-API:in tai lueta asiakastietoja. Tarkista julkaisutilanne ennen käyttöä.
Lataa koneelliset työkalumäärittelyt. Niiden kenttänimet ja alkuperäiset skeemakuvaukset ovat englanniksi. Kohdepalvelimen tools/list on siellä käytössä olevan parametriskeeman ensisijainen lähde.
list_drives¶
Lukee vain tunnuksen fleetiin kuuluvat työajoiksi luokitellut ajot. Yksityisajot ja tuntemattomat luokat jäävät pois. Palauttaa ajon tunnisteen, fleet-viitteen, yksiselitteisesti ratkaistut nykyiset kuljettaja- ja ajoneuvotunnisteet, ajoluokan, matkan, ajankohdat ja vapaan työviitteen. Tietue ei osoita palkka- tai laskutushyväksyntää. Käytä integraation aineistohakuun tilannekuvasivutusta.
Parametrit¶
| Parametri | Tyyppi | Pakollinen | Oletus ja rajat | Merkitys |
|---|---|---|---|---|
from |
merkkijono | kyllä | — | Aikavälin ensimmäinen päivämäärä muodossa YYYY-MM-DD, päivä mukaan lukien. |
to |
merkkijono | kyllä | — | Aikavälin viimeinen päivämäärä muodossa YYYY-MM-DD, päivä mukaan lukien. Alku- ja loppupäivän väli saa sisältää enintään 366 päivämäärää. |
driver |
merkkijono | ei | — | Valinnainen täsmällinen tallennettu kuljettajan käyttäjänimi. Enintään 100 merkkiä; ei laajenna fleet-oikeuksia. |
limit |
kokonaisluku | ei | oletus 25; vähintään 1; enintään 100 |
Yhdellä sivulla palautuvien tietueiden enimmäismäärä. |
offset |
kokonaisluku | ei | oletus 0; vähintään 0; enintään 10000 |
Muuttuvan aineiston sivutuksen aloituskohta. Tilannekuvatilassa jätetään pois tai pidetään nollana. |
pagination |
merkkijono | ei | oletus offset; sallitut arvot offset, snapshot |
offset näyttää muuttuvan aineiston. snapshot muodostaa integraation rajattua aineistohakua varten tilannekuvan, joka säilyy 15 minuuttia. Tilannekuvan rajat ovat 10 000 riviä ja 4 MiB; aktiivisia tilannekuvia voi olla enintään kolme fleetiä kohti. |
cursor |
merkkijono | ei | enintään 128 merkkiä | Vain tilannekuvatilaan. Jätä pois ensimmäisestä kutsusta ja käytä sen jälkeen next_cursor-arvoa sellaisenaan. Työkalu, aikaväli, kuljettajarajaus ja sivukoko on säilytettävä samoina. Jatka myös tyhjältä sivulta, kunnes next_cursor on null. Ei muutossyötteen jatkokohta. |
Muita parametreja ei hyväksytä. Yritystä tai fleetiä ei valita pyynnön argumentilla.
summarize_drives¶
Laskee työajoiksi luokiteltujen ajojen määrän ja tallennetun ajomatkan yhteensä sekä kuljettajittain tunnuksen fleetissä. Yksityiset ja tuntemattomat ajoluokat jäävät pois. Matkat eivät ole automaattisesti hyväksyttyjä korvattavia tai laskutettavia määriä.
Parametrit¶
| Parametri | Tyyppi | Pakollinen | Oletus ja rajat | Merkitys |
|---|---|---|---|---|
from |
merkkijono | kyllä | — | Aikavälin ensimmäinen päivämäärä muodossa YYYY-MM-DD, päivä mukaan lukien. |
to |
merkkijono | kyllä | — | Aikavälin viimeinen päivämäärä muodossa YYYY-MM-DD, päivä mukaan lukien. Alku- ja loppupäivän väli saa sisältää enintään 366 päivämäärää. |
driver |
merkkijono | ei | — | Valinnainen täsmällinen tallennettu kuljettajan käyttäjänimi. Enintään 100 merkkiä; ei laajenna fleet-oikeuksia. |
Muita parametreja ei hyväksytä. Yritystä tai fleetiä ei valita pyynnön argumentilla.
list_work_sessions¶
Lukee tunnuksen fleetin työpäiväkirjamerkinnät ja tallennetut tunnit. Mukana ovat lähdetunniste, fleet-viite ja nykyisestä fleet-rekisteristä yksiselitteisesti ratkaistu kuljettajatunniste tai null. Käytä aineistohakuun tilannekuvasivutusta. Tiedot eivät osoita palkkahyväksyntää eivätkä muodosta muutossyötettä.
Parametrit¶
| Parametri | Tyyppi | Pakollinen | Oletus ja rajat | Merkitys |
|---|---|---|---|---|
from |
merkkijono | kyllä | — | Aikavälin ensimmäinen päivämäärä muodossa YYYY-MM-DD, päivä mukaan lukien. |
to |
merkkijono | kyllä | — | Aikavälin viimeinen päivämäärä muodossa YYYY-MM-DD, päivä mukaan lukien. Alku- ja loppupäivän väli saa sisältää enintään 366 päivämäärää. |
driver |
merkkijono | ei | — | Valinnainen täsmällinen tallennettu kuljettajan käyttäjänimi. Enintään 100 merkkiä; ei laajenna fleet-oikeuksia. |
limit |
kokonaisluku | ei | oletus 25; vähintään 1; enintään 100 |
Yhdellä sivulla palautuvien tietueiden enimmäismäärä. |
offset |
kokonaisluku | ei | oletus 0; vähintään 0; enintään 10000 |
Muuttuvan aineiston sivutuksen aloituskohta. Tilannekuvatilassa jätetään pois tai pidetään nollana. |
pagination |
merkkijono | ei | oletus offset; sallitut arvot offset, snapshot |
offset näyttää muuttuvan aineiston. snapshot muodostaa integraation rajattua aineistohakua varten tilannekuvan, joka säilyy 15 minuuttia. Tilannekuvan rajat ovat 10 000 riviä ja 4 MiB; aktiivisia tilannekuvia voi olla enintään kolme fleetiä kohti. |
cursor |
merkkijono | ei | enintään 128 merkkiä | Vain tilannekuvatilaan. Jätä pois ensimmäisestä kutsusta ja käytä sen jälkeen next_cursor-arvoa sellaisenaan. Työkalu, aikaväli, kuljettajarajaus ja sivukoko on säilytettävä samoina. Jatka myös tyhjältä sivulta, kunnes next_cursor on null. Ei muutossyötteen jatkokohta. |
Muita parametreja ei hyväksytä. Yritystä tai fleetiä ei valita pyynnön argumentilla.
summarize_work_sessions¶
Laskee tunnuksen fleetin työpäiväkirjamerkintöjen määrän ja tallennetut tunnit yhteensä sekä kuljettajittain. Kyseessä ovat päiväkirjan tallennetut tunnit, eivät uudelleen lasketut palkkatunnit.
Parametrit¶
| Parametri | Tyyppi | Pakollinen | Oletus ja rajat | Merkitys |
|---|---|---|---|---|
from |
merkkijono | kyllä | — | Aikavälin ensimmäinen päivämäärä muodossa YYYY-MM-DD, päivä mukaan lukien. |
to |
merkkijono | kyllä | — | Aikavälin viimeinen päivämäärä muodossa YYYY-MM-DD, päivä mukaan lukien. Alku- ja loppupäivän väli saa sisältää enintään 366 päivämäärää. |
driver |
merkkijono | ei | — | Valinnainen täsmällinen tallennettu kuljettajan käyttäjänimi. Enintään 100 merkkiä; ei laajenna fleet-oikeuksia. |
Muita parametreja ei hyväksytä. Yritystä tai fleetiä ei valita pyynnön argumentilla.
Vastausten yhteiset säännöt¶
Onnistunut työkalukutsu sisältää structuredContent-aineiston ja arvon isError: false. Listauksessa ovat period ja joko drives tai work_sessions sekä sivutuksen metatiedot. Koosteessa ovat period, total ja by_driver.
Tarkista vastauskentät, virheenkäsittely ja sivutusohje. Liiketoiminnan aikaleimat käyttävät lähdejärjestelmän aikakäytäntöä; niitä ei muunneta UTC:hen. Palautuva tieto on kirjattua, ei automaattisesti hyväksyttyä palkka- tai laskutusaineistoa.