De 9292 Reisadvies API biedt de mogelijkheid om gebruik te maken van de planner engine van 9292 binnen een eigen website of app voor het geven van OV-reisadviezen van adres naar adres van al het openbaar vervoer in heel Nederland.
Deze handleiding beschrijft hoe u de interface van de 9292 Reisadvies API kunt gebruiken om op uw website of andere toepassing een OV-routeplanner aan uw klanten aan te bieden. Dit is een aanvulling op de online swaggerdocumentatie van ons product.
Als basis voor de 9292 Reisadvies API wordt XML of JSON gebruikt. Kennis van WebAPI als ontwikkelaar en XML of JSON is dan ook noodzakelijk om deze uitvoering te kunnen installeren.
Gebruik van de 9292 Reisadvies API is alleen toegestaan met uitdrukkelijke toestemming van 9292.
Het is verplicht het 9292 Logo te tonen. Het gaat hier om alleen het logo en geen tekst.
9292 geeft akkoord op plaatsing voor live gang binnen de productieomgeving. Dit om de uniformiteit te waarborgen.
Via de volgende URL is het 9292 Logo op te halen:
|
Software versie |
Documentatie versie |
Opmerking |
|
11-05-2020 |
20-01-2020 |
|
|
24-09-2020 |
01-09-2020 |
|
|
08-12-2020 |
15-10-2020 |
|
|
22-03-2021 |
23-03-2021 |
|
|
26-04-2021 |
26-04-2021 |
|
De 9292 Reisadvies API is beveiligd en kan alleen aangeroepen worden als men in het bezit is van een door 9292 verstrekt ‘Token’ of wel APIKey. Dit ‘Token’ bestaat uit een serie tekens en letters die per Licentieovereenkomst wordt afgegeven en die de klant het recht geeft om requests aan de server van 9292 te doen.
Dit ‘Token’ is even geheim als uw gebruikersnaam en wachtwoord. Deel het met niemand.
9292 kan bij misbruik het ‘Token’ deactiveren.
Het toegangstoken ontvangt u per e-mail van de 9292 Servicedesk. Dit is uw identificatiecode. Met dit token kunt u gebruik maken van de aansluittestomgeving van de 9292 Reisadvies API. Wanneer u de implementatie heeft voltooid en 9292 uw dienst heeft getest, kunt u overgaan naar de productieomgeving. Hiervoor ontvangt u van de 9292 Servicedesk een nieuw token.
De aansluiting op de aansluittestomgeving blijft na overgang op de productieomgeving nog twee weken bestaan.
Het token moet in de header bij iedere aanroep worden meegestuurd. Hierbij een voorbeeld van de request header:
|
Header Key |
Value |
|
Authorization |
Token <MY_TOKEN> |
|
Accept |
Application/XML (voor JSON gebruik "Application/JSON") |
|
Content-Type |
charset=utf-8 |
Let op:
De 9292 Reisadvies API ondersteund alleen HTTPS verzoeken.
Er worden tokens meegestuurd die een betreffende afnemer kan identificeren. Daardoor kan er bij het aftappen van een HTTP stroom misbruik van het token worden gemaakt. Dit kan resulteren in een hogere telling in de statistieken en een hogere factuur.
De 9292 Reisadvies API maakt gebruik van gegevens die verouderen of wijzigen (o.a. dienstregelingen). Daarom kan alleen data gebruikt worden die binnen de geldigheidsduur valt. Zodra er een datum wordt gebruikt die buiten de geldigheidsdatum valt zal de 9292 Reisadvies API altijd een foutmelding (400 BadRequest) teruggeven.
De geldigheidsduur kan d.m.v. de Dataset endpoint worden opgevraagd.
Het opvragen van de Dataset wordt niet meegeteld als request voor de facturatie.
Om een locatie op te vragen dient u binnen de 9292 Reisadvies API de Locations endpoint aan te roepen. Met een locatie request kunt u informatie opvragen over een station, plaats, straat, huisnummer, haltenaam of POI (Point Of Interest). Een locatie request zal 25 locaties teruggeven. De stations zullen eerst teruggegeven worden, daarna de bus-/tram-/metrohaltes, daarna de straatnamen, postcodes etc.
Deze Locations endpoint is geen autosuggest. Met behulp van de Locations endpoint kunt u wel zelf een autosuggest voor uw applicatie(s) ontwikkelen.
Het opvragen van een locatie wordt niet meegeteld als request voor de facturatie.
Om een reisadvies op te vragen dient u de Journeys endpoint aan te roepen. Het opvragen van een OV-reisadvies geeft 9 responses terug. Dit zijn reizen rond het opgevraagde tijdstip. Dit aantal is niet instelbaar.
De vertrek-, via- en bestemmingslocatie in een OV-reisadvies request dient te corresponderen met de ‘Id’ van een locatie van de Location endpoint.
Attributes zijn gegevens die door bijvoorbeeld NS worden meegestuurd met betrekking tot een reis(deel). Deze worden niet bij alle reizen getoond, alleen waar de informatie is toegevoegd aan het OV-reisadvies zal het element Attributes worden getoond.
Onderstaand tabel bevat een aantal voorbeelden van mogelijke attributen.
|
Attribuut Id |
Attribuut waarde |
Omschrijving/Opmerking |
|
TWEE |
alleen 2e klas |
Aanduiding dat alleen 2de klas beschikbaar is voor een reis. Dit komt maar op een aantal trajecten voor namelijk:
|
|
WCA |
Rolstoeltoegankelijk |
komt voor als de modaliteit toegankelijk is |
|
SPEC |
Speciaal ticket vereist |
Komt voornamelijk voor bij (Intercity Direct & Internationale treinen) |
|
FINI |
fiets meenemen niet mogelijk |
Komt voornamelijk voor bij (Intercity Direct & Internationale treinen) |
|
RESM |
Reserveren mogelijk |
Komt voornamelijk voor bij (Intercity Direct & Internationale treinen) |
|
TSR |
Toeslag Schiphol - Rotterdam |
Komt voornamelijk voor bij (Intercity Direct & Internationale treinen) |
Attributen in het OV-reisadvies zijn in het “Attributes” component te vinden. Attributes bestaat uit nul of meerdere LegAttributes. Hierbij een voorbeeld van een Attributes component:
|
Formaat |
Voorbeeld |
|
XML |
<Attributes> |
|
JSON |
"Attributes": [{
|
Er kunnen verstoringsberichten aan een reisadvies worden gekoppeld. Deze berichten worden door vervoerders (bijvoorbeeld NS) opgestuurd voor een bepaalde plaats, station, halte lijnnummer en/of alle ritten van een vervoerder.
Een verstoringsbericht, indien aanwezig, wordt in het Disruption element van een leg getoond.
De 9292 Reisadvies API onderkent vier soorten verstoringsberichten:
In alle responses zitten tarieven, deze tarieven staan onder FareLegs. Indien er geen tarieven mogelijk zijn, zoals een OV-reisadvies met een veerboot, dan komt onder element “Complete” false terug. Dan is het niet mogelijk om een totaal OV-reisadvies prijs af te geven. Voor de delen waar het wel mogelijk is, wordt dit per reisdeel getoond.
Hieronder een voorbeeld response van een treintarief van NS met tariefinformatie:
|
Formaat |
Voorbeeld |
|
XML |
<FareInfo> |
|
JSON |
"FareInfo": {
|
Het aantal tariefeenheden van de trein staan onder “PriceUnits” van de “FareLegs”.
Hierbij een voorbeeld van een busreis bij het OV-reisadvies van Leeuwarden naar Harlingen met het volgende prijsadvies:
|
Formaat |
Voorbeeld |
|
XML |
<FareInfo> |
|
JSON |
"FareInfo": {
|
“FareLegs” binnen 1 Journey kunnen opgeteld worden bij de volgende combinaties:
Er kan ook gebruik worden gemaakt van onderstaande elementen, deze tellen alle losse elementen bij elkaar op en tonen het volledige en gereduceerde tarief:
Let op:
We willen u erop wijzen dat het presenteren van het totaal van de reductiebedragen in het geval van diverse modaliteiten uitleg aan de reiziger behoeft. Het recht op reductie in de trein kent andere voorwaarden dan het recht op korting in bus, tram en metro.
Het kan voorkomen dat er geen tarief beschikbaar is omdat er geen OV-chipkaart informatie aanwezig is (bijv. informatie over een veerboot). Dan komt dit als volgt in de <Fares> terug:
|
Formaat |
Voorbeeld |
|
XML |
<FareInfo> |
|
JSON |
"Fares": [{
|
Voor het bepalen of op een FareLeg de OV-chipkaart geldig is wordt door de tariefberekening een veld NoChipFare teruggeven aan de 9292 planner. De 9292 planner geeft deze met dezelfde naam weer door aan de client. Dit is een boolean-veld. De waarde is true als er geen OV-chipkaart gebruikt kan worden en false als deze wel gebruikt kan worden.
|
Formaat |
Voorbeeld |
|
XML |
<FareInfo> |
|
JSON |
"FareInfo": {
|
Plannen met de fiets of scooter is standaard toegevoegd aan de 9292 Reisadvies API. Door gebruik te maken van het invoerveld ‘FirstMile of LastMile’ met de waarde ‘PrivateBicycle’ of ‘PrivateElectricBicycle’ geeft u de reiziger een passend OV-reisadvies met eigen fiets of elektrische fiets naar een trein-, bus-, metro- of tram-fietsoverstappunt.
Met de waarde ‘PrivateMoped’ kunt u de reiziger een OV-reisadvies met de scooter i.p.v. de fiets geven.
9292 Reisadvies API ondersteunt ook het gebruik van huurfietsen en huurscooters. Dit wordt aangegeven door het invoerveld ‘LastMile’ in te vullen met de waarde ‘PublicBicycle’, ‘PublicElectricBicycle’ of ‘PublicMoped’. Hiermee wordt een OV-reisadvies gegeven met een loop-leg naar een passend verhuurlocatie.
Let op:
- De reiziger kan op dit moment alleen bij de ‘LastMile’ gebruik maken van huurfietsen en huurscooters.
- Informatie over beschikbare verhuurlocaties per aankomst- of vertreklocatie en de details van een verhuurlocatie (o.a. het aantal beschikbare voertuigen en openingstijden) zijn in de huidige release nog niet beschikbaar.
De standaard business regels voor plannen met de fiets zijn:
De standaard business regels voor plannen met de scooter zijn:
Door gebruik te maken van de optie ‘Bezettingsinfomatie’ geeft u de reiziger een passend OV-reisadvies met daarin de drukte per gereisde modaliteit en u kunt een totaal drukte voorspelling meegeven over de gehele reis.
De volgende parameters zijn beschikbaar om bezettingsinformatie in het OV-reisadvies te krijgen:
|
Parameters |
Beschrijving (voorbeeld) |
|
ShowOccupancy |
true |
De bezetting wordt aangegeven op een schaal van 0 tot 5 conform de BISON specificatie “Concept koppelvlak bezetting” Het bezetting kan worden gevisualiseerd middels de bijbehorende kleur of het bijbehorende icoontje.
Zie onderstaande tabel.
Dit is een concept voorbeeld van hoe 9292 zelf de gegevens gaat vertalen in haar apps en website.
|
Drukte volgens BISON |
Enumeratie |
Kleur |
Icoontje 9292 |
Opmerkingen |
|
0 |
No information |
|
 |
Geen informatie ontvangen of bezetting onbekend. |
|
1 |
Empty |
|
 |
Bij NS worden 1 en 2 samengevoegd naar 2 |
|
2 |
Many seats available |
|
 |
Bij NS <65% van zitplaatsen per bak bezet |
|
3 |
Few seats available |
|
 |
Bij NS >65% en < 100%van zitplaatsen per bak bezet |
|
4 |
Standing room only |
|
 |
Bij NS >100% van zitplaatsen per bak bezet |
|
5 |
Full |
|
 |
Alleen relevant voor realtime gegevens. Dit is toekomstige informatie en wordt nog niet aangeleverd. |
Bij de icoontjes wordt rekening gehouden met onderscheid in de afbeelding, zodat dit ook te zien is bij kleurenblindheid.
Een reis van Waterlooplein in Amsterdam, naar de Stadsschouwburg in Utrecht.
De gehele reis krijgt indicator druk omdat 1 leg de indicator “druk” heeft.
Er wordt dus geaggregeerd naar de drukste halte van het traject.
Dit optioneel af te nemen onderdeel kan op verzoek worden toegevoegd aan de 9292 Reisadvies API. De sterwaarden en centrumzones worden gebruikt bij de zogenoemde sterabonnementen. Als u voor dit onderdeel kiest, dan zal de 9292 Reisadvies API berekenen welk sterabonnement nodig is voor het betreffende OV-reisadvies. Er wordt nog in enkele gevallen gebruik gemaakt van sterabonnementen en zodoende zal niet bij ieder OV-reisadvies de sterwaarde/centrumzone worden meegegeven. Zie onderstaand voorbeeld.
In dit voorbeeld is een OV-reisadvies opgevraagd van Station Koog Zaandijk naar Station Krommenie Assendelft. De modaliteit trein is in dit advies uitgeschakeld:
Request:
Als er starzones aanwezig zijn in het OV-reisadvies dan ziet het er als volgt uit:
|
Formaat |
Voorbeeld |
|
XML |
<PriceUnits i:nil="true" /> |
|
JSON |
"StarZones": [ |
Als er geen Starzones aanwezig zijn dan wordt het volgende getoond:
|
Formaat |
Voorbeeld |
|
XML |
<StarZones xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> |
|
JSON |
"StarZones": [] |
De sterwaarde kan zowel een numerieke als alfabetische waarde hebben. Er zijn zeven mogelijkheden als waarde: 1 t/m 6 en Netabonnement. Bij een waarde groter dan 6 komt het Netabonnement als waarde naar voren, omdat deze geldig is in het hele land op stad- en streekvervoer.
Het kan voorkomen dat voor een reis meer dan 1 abonnement nodig is. In dat geval worden meerdere elementen <FareLeg> getoond waarbij geldt dat de eerste FareLeg de tarief informatie laat zien voor de totale reis. Vervolgens wordt per benodigd abonnement de bijbehorende <FareLeg> getoond. Dit is als volgt zichtbaar in de <Fares>:
|
Formaat |
Voorbeeld |
|
XML |
<FareInfo>
<Complete>true</Complete>
<FareLegs>
<FareLeg>
<Fares>
<Fare>
<Eurocents>1759</Eurocents>
<FareClass>None</FareClass>
<Reduced>false</Reduced>
</Fare>
<Fare>
<Eurocents>1161</Eurocents>
<FareClass>None</FareClass>
<Reduced>true</Reduced>
</Fare>
</Fares>
<FromId>scherpenisse/bushalte-spuidamstraat</FromId>
<NoChipFare>false</NoChipFare>
<OperatorsString>Connexxion, Arriva, RET & EBS</OperatorsString>
<PlaceNamesString>Scherpenisse - Hellevoetsluis</PlaceNamesString>
<PriceUnits i:nil="true" />
<StarValue></StarValue>
<StarZones xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<ToId>hellevoetsluis/bushalte-amnesty-internationallaan</ToId>
</FareLeg>
<FareLeg>
<Fares />
<FromId>scherpenisse/bushalte-spuidamstraat</FromId>
<NoChipFare>false</NoChipFare>
<OperatorsString>Connexxion</OperatorsString>
<PlaceNamesString>Scherpenisse - Halsteren</PlaceNamesString>
<PriceUnits i:nil="true" />
<StarValue>3</StarValue>
<StarZones xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>7233, 7243, 7248, 7259, 7738</d7p1:string>
</StarZones>
<ToId>halsteren/bushalte-nieuwe-molenweg</ToId>
</FareLeg>
<FareLeg>
<Fares />
<FromId>rotterdam/metrostation-zuidplein</FromId>
<NoChipFare>false</NoChipFare>
<OperatorsString>RET & EBS</OperatorsString>
<PlaceNamesString>Rotterdam - Hellevoetsluis</PlaceNamesString>
<PriceUnits i:nil="true" />
<StarValue>5</StarValue>
<StarZones xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>5246, 5247, 5336, 5337, 5358</d7p1:string>
</StarZones>
<ToId>hellevoetsluis/bushalte-amnesty-internationallaan</ToId>
</FareLeg>
</FareLegs>
<FullPriceEuroCents>1759</FullPriceEuroCents>
<ReducedPriceEuroCents>1161</ReducedPriceEuroCents>
</FareInfo>
|
|
JSON |
"FareInfo": {
"Complete": true,
"ReducedPriceEuroCents": 1161,
"FullPriceEuroCents": 1759,
"FareLegs": [{
"FromId": "scherpenisse/bushalte-spuidamstraat",
"ToId": "hellevoetsluis/bushalte-amnesty-internationallaan",
"PlaceNamesString": "Scherpenisse - Hellevoetsluis",
"OperatorsString": "Connexxion, Arriva, RET & EBS",
"Fares": [{
"Eurocents": 1759,
"Reduced": false,
"FareClass": "None"
},
{
"Eurocents": 1161,
"Reduced": true,
"FareClass": "None"
}
],
"StarZones": [],
"StarValue": "",
"PriceUnits": null,
"NoChipFare": false
},
{
"FromId": "scherpenisse/bushalte-spuidamstraat",
"ToId": "halsteren/bushalte-nieuwe-molenweg",
"PlaceNamesString": "Scherpenisse - Halsteren",
"OperatorsString": "Connexxion",
"Fares": [],
"StarZones": [
"7233, 7243, 7248, 7259, 7738"
],
"StarValue": "3",
"PriceUnits": null,
"NoChipFare": false
},
{
"FromId": "rotterdam/metrostation-zuidplein",
"ToId": "hellevoetsluis/bushalte-amnesty-internationallaan",
"PlaceNamesString": "Rotterdam - Hellevoetsluis",
"OperatorsString": "RET & EBS",
"Fares": [],
"StarZones": [
"5246, 5247, 5336, 5337, 5358"
],
"StarValue": "5",
"PriceUnits": null,
"NoChipFare": false
}
]
}
|
Dit optioneel af te nemen onderdeel kan op verzoek worden toegevoegd aan de 9292 Reisadvies API.
Door gebruik te maken van de optie CO2 in het OV-reisadvies, kunnen uw gebruikers per OV-reis vergelijken hoeveel CO2 zij besparen door met het Openbaar Vervoer te reizen.
De berekening van CO2 is gebaseerd op basis van CO2 uitstoot per kilometer en Well to Wheel (WTW) = de uitstoot van zowel de voorketen als de directe emissies samen.
De overzichten worden hieronder weergegeven voor de verschillende vervoermiddelen.
De CO2 waarden zoals hieronder vermeld staan zijn afkomstig van de website co2emissiefactoren.nl en is het initiatief van SKAO, Stimular, Connekt, Milieu Centraal en de Rijksoverheid en is tot stand gekomen in samenwerking met diverse stakeholders.
Auto
|
Categorie |
CO2 uitstoot |
|
Auto Klein |
180 |
|
Auto Middenklasse |
202 |
|
Auto Groot |
236 |
Openbaar vervoer
|
Categorie |
CO2 uitstoot |
|
Tram |
66 |
|
Bus |
140 |
|
Metro |
74 |
|
Trein |
6 |
|
Veerboot |
115 |
|
Taxi |
202 |
Geraadpleegde bronnen:
Hierbij een voorbeeld van CO2 waardes in het OV-reisadvies van postcode 3221AL in Hellevoetsluis naar postcode 3078 PE in Rotterdam.
Request:
Response:
|
Formaat |
Voorbeeld |
|
XML |
<CO2Info> |
|
JSON |
"CO2Info": {
|
Toelichting van de meest relevante elementen uit bovenstaande response:
|
Element |
Beschrijving (voorbeeld) |
|
JourneyDistance |
gemeten afstand van de reis in kilometers |
|
JourneyEmission |
totale CO2 emissie van de reis met het openbaar vervoer in kilogrammen |
Dit optioneel af te nemen onderdeel kan op verzoek worden toegevoegd aan de 9292 Reisadvies API. Door gebruik te maken van de optie ‘Realtime OV-reisadviezen’ geeft u de reiziger een passend OV-reisadvies inclusief vertraging van de trein, bus, metro of tram. Waar wijzigingen in tijden optreden, kan de reis herpland worden en biedt 9292 alternatieven aan.
De volgende parameters zijn toegevoegd aan de 9292 Reisadvies API om realtime te tonen in het OV-reisadvies.
|
Parameters |
Beschrijving (voorbeeld) |
|
RealtimeArrival |
Actuele aankomsttijd |
|
RealtimeDeparture |
Actuele vertrektijd |
|
RealtimeState |
None, Offset, Cancelled |
|
Cancellations |
None of Cancellations |
|
Delays |
None, InternalDelay |
|
Detour |
Normal |
|
LudMessage |
<Text> Dit is een alternatief reisadvies.</ Text> |
In onderstaand voorbeeld tonen we hoe een vertraging op een rit wordt weergegeven. In dit voorbeeld is zowel de vertrektijd als de aankomsttijd gewijzigd ten opzichte van de oorspronkelijke vertrek- en aankomsttijd.
Oorspronkelijke vertrek en aankomsttijden zijn:
|
Formaat |
Voorbeeld |
|
XML |
<RealtimeArrival>2014-11-05T11:55:00</RealtimeArrival> |
|
JSON |
"RealtimeDeparture": "2014-11-05T11:32:00", |
In een OV-reisadvies wordt voor elke halte de realtime vertrek- en aankomsttijd doorgegeven, ook op de tussenliggende haltes. In onderstaand voorbeeld op de halte Claudius Prinsenlaan in Breda is de bus eerder vertrokken dan de oorspronkelijke planning.
De bus zou moeten vertrekken om 10:05 uur maar vertrekt om 10:02 uur.
|
Formaat |
Voorbeeld |
|
XML |
<Call> |
|
JSON |
"Calls": [{
|
Als een geplande rit niet wordt gereden, dan zal er een cancel bericht worden verzonden vanuit de vervoerder. Dit is zichtbaar in onderstaand voorbeeld.
De sprinter van Amersfoort naar Zwolle rijdt niet. Voor elk station/halte die de rit aan doet, wordt in de RealtimeState een Cancelled ingevuld.
Dit OV-reisadvies gaat dus niet door. Het is van belang dit in de presentatie aan de reiziger uit te leggen.
Request:
|
Formaat |
Voorbeeld |
|
XML |
<Call> |
|
JSON |
"RealtimeInfo": {
|
Het kan voorkomen dat een aansluiting niet gehaald wordt. Bijvoorbeeld als bij een overstap in het eerste deel van de reis sprake was van vertraging. In de RealtimeInfo wordt dan een FatalDelay getoond, de rest van de output wijzigt niet.
Dit OV-reisadvies gaat dus niet door. Het is van belang dit in de presentatie aan de reiziger uit te leggen.
|
Formaat |
Voorbeeld |
|
XML |
<RealtimeInfo> |
|
JSON |
"RealtimeInfo": {
|
Bij een vervallen OV-reisadvies wordt er vaak een alternatief advies geboden. Het is van belang dit in de presentatie aan de reiziger uit te leggen.
Stel dat voor de reis van Kampen Zuid naar Amsterdam Bijlmer Arena de rit met de sprinter is vervallen. Er rijdt nu een Intercity vanaf Kampen Zuid naar Duivendrecht en vervolgens ga je met de Metro naar Amsterdam Bijlmer Arena.
De belangrijkste wijziging in de response is weergegeven in onderstaand voorbeeld:
|
Formaat |
Voorbeeld |
|
XML |
<RealtimeInfo> |
|
JSON |
"RealtimeInfo": {
|
Wanneer NS een extra rit inlegt wordt dit getoond in de 9292 Reisadvies API.
In onderstaand voorbeeld wordt er een extra rit ingelegd tussen Harderwijk en Zwolle: een extra intercity met ritnummer 29600.
Deze adviezen noemen wij altijd een Alternatief reisadvies zoals je in de Ludmessage ziet staan. Het kan zijn dat er geen Platform of Platformchange is ingevuld zoals hier het geval is. Dat betekent dat 9292 deze informatie niet heeft binnengekregen of de informatie niet is verwerkt. Behalve als het de laatste halte van een extra rit of gewijzigde rit betreft, deze wordt dan niet getoond, dit is een bekende fout en wordt hersteld in een volgende versie.
|
Formaat |
Voorbeeld |
|
XML |
<Journey> |
|
JSON |
"RealtimeInfo": {
|
Wanneer een rit een extra stop bevat dan is dit als volgt zichtbaar in de 9292 Reisadvies API:
In de 9292 Reisadvies API is niet zichtbaar welk halte/station er extra wordt aangedaan, alleen is het mogelijk dat het aankomst/vertrekperron niet is ingevuld.
De response van een rit met een extra stop ziet er als volgt uit:
|
Formaat |
Voorbeeld |
|
XML |
<Destination>Den Haag</Destination> |
|
JSON |
"RealtimeInfo": {
|
Dit optioneel af te nemen onderdeel kan op verzoek worden toegevoegd aan de 9292 Reisadvies API. Door gebruik te maken van de optie ‘OV Prijswijzer’ geeft u de reiziger een passend OV-reisadvies inclusief de abonnement informatie over de trein, bus, metro of tram. Voor informatie over de OV Prijswijzer verwijzen we u naar onze website. Daar vindt u ook met welke abonnementen de OV Prijswijzer rekent.
De volgende parameters zijn toegevoegd aan de 9292 Reisadvies API om het OV Prijswijzer advies te tonen in het OV-reisadvies.
|
Parameters |
Beschrijving (voorbeeld) |
|
TravellerAge |
Leeftijd (getal tussen de 4 en 100) |
|
TravellerFrequencyPeriod |
Periode (getal 1 of 2) 1 = week, 2 = maand |
|
TravellerFrequency |
Aantal dagen (getal tussen 1 en 31, afhankelijk van TravellerFrequencyPeriode) Als TravellerFrequencyPeriod = 1, dan moet TravellerFrequency tussen 1 en 7 zijn. Als TravellerFrequencyPeriod = 2 dan moet TravellerFrequency tussen de 1 en 31 zijn. |
Het bestaande request moet uitgebreid worden met bovenstaande parameters om in het OV-reisadvies ook een OV Prijswijzer advies op te vragen. Hieronder een voorbeeld van een valide request, met de volgende gegevens:
|
Veld |
Parameter |
|
Van |
Amsterdam centraal station |
|
Naar |
Den haag centraal station |
|
Datum |
17-07-2017 |
|
Tijd |
07:45 |
|
Leeftijd reiziger |
24 |
|
Aantal dagen |
3 |
|
Periode (week) |
1 |
Request:
In onderstaand voorbeeld tonen we de XML- en JSON-gedeeltes waarin een OV Prijswijzer advies op een rit wordt weergegeven.
|
Formaat |
Voorbeeld |
|
XML |
<ProductAdviceInfo> |
|
JSON |
"ProductAdviceInfo": {
|
Dit onderdeel wordt op verzoek toegevoegd aan de 9292 Reisadvies API. Door gebruik te maken van de optie ‘Toegankelijk Plannen & Haltetoegankelijkheid’ geeft u de reiziger een passend OV-reisadvies voor modaliteiten en haltes die geschikt zijn voor iemand met een motorische beperking. Daarnaast worden alle reisadviezen (wel of niet gepland met toegankelijkheid) voorzien van informatie met betrekking tot haltetoegankelijkheid.
De volgende parameters zijn beschikbaar om een toegankelijk OV-reisadvies te krijgen.
|
Parameters |
Beschrijving (voorbeeld) |
|
PlanWithAccessibility |
true |
In de call zijn de volgende eigenschappen toegevoegd:
Mogelijke waarden van deze eigenschappen:
|
Waarden |
Betekenis |
|
Accessible |
Halte is toegankelijk |
|
NotAccessible |
Halte is niet toegankelijk |
|
Unknown |
Geen informatie beschikbaar |