ALERTS - Viestirajapinta

ALERTS -rajapinnan kautta on saatavilla Föli-alueen liikennöinnin poikkeustiedotteet ja vuoroperuutukset. Käytettävissä on URLt :

Yleistä

Viestit koostuvat header, message ja information attribuuteista. Attribuuteista muut kuin message voi puuttua. Viestin muut ominaisuudet perustuvat pääasiassa GTFS-RT:n tietosisältöön.

Viestisisällön kannalta message -kenttä toimii tekstillisesti yksinään. Mikäli käytettävissä on rajoitetusti esitystilaa, voidaan siis näyttää pelkkä message-tietue. Mikäli esitystilaa on riittävästi, voidaan valinnan mukaisesti näyttää myös header ja information. Näistä jälkimmäinen täydentää message -tekstiä ja nämä kaksi on tarkoitettu näytettäväksi yhdistettynä. information -attribuutti ei siis välttämättä toimi tekstuaalisesti yksinään, vaan vaatii message -tekstin eteensä.

Kaikille kolmelle kentälle on myös tehty UTF-8 > ISO-8859-1//TRANSLIT > UTF-8 muunnos. Vaikka teksti on JSON-tyyppisesti Unicodea, viestissä ei ole ISO-8859-1 ulkopuolisia merkkejä.

Viestin icon-kenttä sisältää viestille suositellun kuvakkeen symbolin. Käytössä on arvot BIKE (kaupunkipyörät), BOAT (vesibussi), BUS (linjabussi) ja NONE tai näiden yhdistelmä alaviivolla aakkosjärjestyksessä yhdistettynä.

Vastauksen attribuutit

GTFS-RT:n syy- ja vaikutuskoodit

Syykoodit

Vaikutuskoodit

Huomioitavia asioita

Kieli ja käännökset

Viestin päätason header, message ja information -attribuutit saattavat olla kaksikielisiä. On siis mahdollista, että viestin päätason information sisältää kaksikielisen tiedotteen käytettäväksi yleisissä tiloissa, mutta viestille on olemassa lisäksi myös pelkkä suomenkielinen ja/tai ruotsinkielinen translation. Mikäli käyttäjän tai lukijan kieli on luotettavasti tiedossa ja sille on olemassa translation, kannattaa käyttää sitä, muutoin tulee käyttää päätason attribuutteja.

Esimerkkivastauksia

Viestit :

http://data.foli.fi/alerts
{
  "servertime": 1587723597,
  "global_message": {},
  "emergency_message": {},
  "cancellations": [
    {
      "icon": "BUS",
      "line": "2A",
      "cause": "UNKNOWN_CAUSE",
      "stops": [
        {
          "stop": "1651",
          "arrival": 1587723300,
          "isactive": true
        },
        {
          "stop": "1652",
          "arrival": 1587723365,
          "isactive": true
        },
   ... (snip) ...
        {
          "stop": "592",
          "arrival": 1587725435,
          "isactive": false
        }
      ],
      "priority": 1200,
      "departure": 1587723300
    }
  ],
  "messages": [
    {
      "icon": "NONE",
      "cause": "OTHER_CAUSE",
      "effect": "OTHER_EFFECT",
      "header": "Kaikki Fölin vanhat matkakortit on vaihdettava uusiin",
      "images": [
        {
          "url": "//data.foli.fi/alerts/images/2e35b83ed032eb887cd2d8946f7c627e",
          "type": "image/png",
          "title": ""
        }
      ],
      "repeat": [
        [
          1566878400,
          1577829540
        ]
      ],
      "message": "Kaikki Turun seudun joukkoliikenne Fölin vanhat matkakortit on vaihdettava uusiin tämän vuoden aikana.",
      "isactive": false,
      "priority": 1000,
      "categories": [
        "NEW_SERVICES",
        "NEWS_SERVICES"
      ],
      "message_id": 131503,
      "channel_web": false,
      "information": "Vaihdettavia kortteja ovat kaikki Turun joukkoliikenteen aikaiset matkakortit sekä lisäksi ne Föli-logolla varustetut matkakortit, joissa ei ole mustaa Waltti-logoa. Ainoat 31.12.2019 jälkeen toimivat Föli-kortit ovat ne, joissa on sekä Fölin että Waltin logot. Vaihto uuteen korttipohjaan on maksuton ja vanhan matkakortin saldo siirretään uudelle kortille. Matkakorttipohjat uusitaan teknisistä syistä.\n\nMatkakortin voi käydä vaihtamassa uuteen Fölin palvelutoimistossa ja muissa palvelupisteissä, joita löytyy jokaisesta Föli-alueen kunnasta.\n\nFölin palvelupisteet:\n\n- Fölin palvelutoimisto, Aurakatu 5, Turku\n- Yhteispalvelu Monitori, Kauppakeskus Skanssi, 2. krs., Skanssinkatu 10, Turku\n- Palvelupiste Fiskari, Kaarina-talo, Lautakunnankatu 1, Kaarina\n- Piikkiön palvelupiste, Piikkiön kirjasto, Hadvalantie 9, Kaarina\n- Raision kaupungin palvelupiste, Eeronkuja 2, Raisio\n- Naantalin yhteispalvelupiste, Käsityöläiskatu 2, Naantali\n- Liedon asiointipiste, Kirkkotie 13, Lieto\n- Ruskon pääkirjasto, Vanhatie 4, Rusko",
      "translations": {},
      "channel_stops": false,
      "affected_stops": [],
      "channel_gtfsrt": false,
      "channel_mobile": true,
      "channel_ticker": false,
      "affected_routes": []
    },
    {
      "icon": "BUS",
      "cause": "OTHER_CAUSE",
      "effect": "DETOUR",
      "header": "Poikkeusreitti Piikkiössä",
      "images": [],
      "repeat": [
        [
          1585741800,
          1588194000
        ]
      ],
      "message": "Linjat 703-708 ovat poikkeusreitillä maanantaista 24.6. alkaen. Linjat ajetaan molempiin suuntiin Helsingintietä Makarlantien sijasta.",
      "isactive": true,
      "priority": 1000,
      "categories": [
        "ANNOUNCE",
        "NEW_ROUTES"
      ],
      "message_id": 132390,
      "channel_web": false,
      "information": "Poikkeusreitti Turkuun: Helsingintie - Hepojoentie - Hadvalantie jne. Paimion suuntaan päinvastoin. \n\nPoikkeusreitin syynä ovat Makarlan sillan korjaustyöt, jotka jatkuvat vuoteen 2020 asti.\n\nLinja K5 liikennöi normaalireitillään.",
      "translations": {
        "en_GB": {
          "header": "Lines 703–708 operate on an exceptional route in Piikkiö",
          "message": "Lines 703–708 will operate on an exceptional route as of Monday 24 June, 2019. The lines will run both ways via Helsingintie instead of Makarlantie.",
          "information": "The exceptional route to Turku is: Helsingintie – Hepojoentie – Hadvalantie and so on. The route is the same in the other direction, but in reverse.\n\nThe reason for the exceptional route is the repairs of the Makarla bridge, which will continue up to 2020."
        },
        "sv_FI": {
          "header": "Linjerna 703–708 kör en avvikande rutt i Pikis",
          "message": "Linjerna 703–708 kör en avvikande rutt från och med måndagen 24.6. Orsaken till den avvikande rutten är reparationsarbetena på bron i Makarla som fortsätter fram till år 2020.",
          "information": "Linjerna körs åt båda hållen på Helsingintie i stället för Makarlantie. Den avvikande rutten till Åbo är: Helsingintie – Hepojoentie – Hadvalantie osv. Åt motsatt riktning är rutten omvänd."
        }
      },
      "channel_stops": false,
      "affected_stops": [
        "6275",
        "6276",
        "6344"
      ],
      "channel_gtfsrt": false,
      "channel_mobile": true,
      "channel_ticker": false,
      "affected_routes": [
        "97",
        "125",
        "126",
        "127",
        "128",
        "129"
      ]
    }
  ]
}
	

Viestien tagit / kategoriat :

http://data.foli.fi/alerts/categories
[
    {
        "catid": 128853,
        "category": "TIMETABLE_CHANGES",
        "descr_fi": "Aikataulumuutokset",
        "descr_sv": "",
        "descr_en": "Timetable changes"
    },
    {
        "catid": 128852,
        "category": "TICKETS_AND_FARES",
        "descr_fi": "Liput ja hinnat",
        "descr_sv": "",
        "descr_en": "Ticket and fares"
    },
  ... (snip) ...
    {
        "catid": 131126,
        "category": "NEWS_SERVICES",
        "descr_fi": "Uutiset",
        "descr_sv": "",
        "descr_en": "News"
    },
    {
        "catid": 131986,
        "category": "ANNOUNCE",
        "descr_fi": "Tiedote",
        "descr_sv": "",
        "descr_en": ""
    }
]