Documentatie storingen en werkzaamheden
De webservice voor de storingen en werkzaamheden maakt het mogelijk informatie op te vragen over storingen en/of werkzaamheden.
De volgende informatie kan worden opgevraagd:
- actuele storingen (=ongeplande storingen + actuele werkzaamheden)
- geplande werkzaamheden (=geplande werkzaamheden)
- actuele storingen voor een gespecificeerd station (=ongeplande storingen + actuele werkzaamheden)
Request
De storingsinformatie kan worden opgehaald met behulp van de volgende url:
| Parameternaam | Omschrijving | Verplicht |
|---|---|---|
| station | De code (afkorting) of korte naam of middellange naam of volledige naam of synoniem van de stationsnaam. Deze parameter levert de informatie zoals hierboven beschreven in punt 3. | Nee |
| actual | Boolean (true or false) indicator of de actuele storingen moeten worden geretourneerd. Dit betreft zowel de ongeplande storingen die op het moment van de request actueel zijn, als de geplande werkzaamheden die binnen twee uur van het request plaatsvinden. Deze parameter levert de informatie zoals hierboven beschreven in punt 1. | ja |
| unplanned | Boolean (true or false) indicator of de geplande werkzaamheden voor de komende 2 weken moeten worden geretourneerd. Deze parameter levert de informatie zoals hierboven beschreven in punt 2. Let op: bij unplanned=true worden de geplande werkzaamheden geretourneerd. Dit is dus net andersom dan wat de parameternaam doet vermoeden. | Nee |
Geen van de parameters is verplicht, echter als er geen enkele parameter wordt ingevuld dan worden er 0 storingen geretourneerd, wat niet de bedoeling kan zijn.
Let op: De parameters kunnen vrij gecombineerd worden maar dit zal in de regel geen logisch resultaat opleveren. De meeste afnemers van de service zullen ofwel actuele storingen of geplande werkzaamheden of actuele storingen voor een bepaald station opvragen.
Response
De volgende twee requests leveren dezelfde resultaten:
http://webservices.ns.nl/ns-api-storingen?station=ut
http://webservices.ns.nl/ns-api-storingen?station=Utrecht+Centraal
De response staat binnen NS bekend als stationsbericht. Het retourneert alle relevante storingen (gepland en ongepland) voor het station Utrecht Centraal (code=ut). De response is als volgt:
<Storingen> <Ongepland> <Storing> <id>prio-13345</id> <Traject>'s-Hertogenbosch-Nijmegen</Traject> <Reden>beperkingen op last van de politie</Reden> <Bericht></Bericht> <Datum>2010-12-16T11:16:00+0100</Datum> </Storing> </ongepland> <Gepland> <Storing> <id>2010_almo_wp_18_19dec</id> <Traject>Almere Oostvaarders-Weesp/Naarden-Bussum</Traject> <Periode>zaterdag 18 en zondag 19 december</Periode> <Reden>Beperkt treinverkeer, businzet en/of omreizen, extra reistijd 15-30 min.</Reden> <Advies>Maak gebruik van de overige treinen of de bussen: reis tussen Weesp en Almere Centrum met de NS-bus in plaats van de trein tussen Almere Centrum en Lelystad Centrum rijden vier Sprinters per uur reis tussen Almere Muziekwijk en Naarden-Bussum via Weesp</Advies> <Bericht></Bericht> </Storing> </Gepland> </Storingen>