Ehdotus uudeksi rajapinnaksi kulkutietoviestien hakemiselle

[Teemu Sirkiä]

Nykyisellään aikataulutietoja (ml. kulkutietoviestit) voi hakea käytännössä vain junan numeron perusteella. Kuitenkin erilaisia analyyseja varten olisi kätevää, jos kulkutietoviestejä voisi hakea myös liikennepaikan ja raideosuuden perusteella. Näiden tietojen avulla olisi mahdollista tilastoida esimerkiksi raiteiston käyttöä liikennepaikoilla. Rajapinnan nykyversiosta on käytännössä mahdotonta saada tähän sopivaa tietoa ulos muuten kuin keräämällä kaikki kulkutietoviestit ja analysoimalla niitä jälkikäteen.

Ehdotan perustettavaksi seuraavat kaksi uutta rajapintaa:

Kulkutietoviestit liikennepaikan perusteella
http://rata.digitraffic.fi/api/v1/train-messages/HKI?date=2016-02-15

• Rajapinta palauttaa pyydetyn liikennepaikan kaikki kulkutietoviestit pyydetyltä päivältä.

Kulkutietoviestit liikennepaikan raideosuuden perusteella
http://rata.digitraffic.fi/api/v1/train-messages/HKI/001a?from=2016-01-01&to=2016-02-01
http://rata.digitraffic.fi/api/v1/train-messages/HKI/001a?limit=400

• Rajapinta palauttaa liikennepaikalta pyydetyn raideosuuden kaikki kulkutietoviestit pyydetyltä aikaväliltä.
• from ja to ovat vapaaehtoisia, muuten palautetaan n uusinta, jonka määrä voidaan myös asettaa limit-parametrilla
• Tällainen aikarajaus on tässä oleellinen, koska jotkin raideosuudet varautuvat vain harvoin. Näin yksittäistä raideosuutta voidaan analysoida tämän kautta paremmin kuin koko liikennepaikan tiedot palauttavalla haulla.

Tekniseen toteutukseen rajapinnan päässä riittänee, että kulkutietoviestit indeksoidaan junan lisäksi myös liikennepaikan ja raideosuuden perusteella.

[Solita / Jaakko]

Hyvä idea, helppo toteuttaa.

Käyn läpi tämän LiVi:n kanssa lähiaikoina. Tiketti LIIKEAVOI-105.