Parameter

Betekenis

Projection

Specificeert de projectie van de coordinaten die in het request zijn opgenomen en ook die in de response. Mogelijke waardes: WGS84 en RD. Default is WGS84.

...Latitude

Bij WGS84-projecties: de latitude coordinaat. Bij RD-projectie: de Y-coordinaat.

...Longitude

Bij WGS84-projecties: de longitude coordinaat. Bij RD-projectie: de X-coordinaat.

Radius

Bij opvragen van haltes in een cirkel: de straal van de cirkel in meters

Query

Bij opvragen van haltes met zoektermen: een lijst van trefwoorden gescheiden door spaties

Language

Bepaalt de taal van een aantal vertaalbare woorden in de response. Mogelijke waardes: NL of EN. Default is NL.

FlexOV

Bepaalt of naast haltes voor het reguliere OV ook haltes voor flexibel OV worden meegeleverd. Default is false.

StopType

Het soort halte dat geleverd moet worden. Mogelijke waardes: Cluster, Physical, Quay en StopPlace. Default is Cluster.

IncludeParentStop

Levert bij fysieke haltes ook de bijbehorende clusterhalte op en bij quay-haltes de bijbehorende StopPlace-halte. Default is false.

IncludePhysicalStops

Levert de identificaties van gerelateerde fysieke haltes op. Bij fysieke haltes worden de identificaties van quay-haltes geleverd en bij quay-haltes de identificaties van fysieke haltes. Default is false.

Details

Als de halte-informatie alleen bedoeld is om een kaart met haltes te kunnen weergeven, kan met de waarde false een minimale hoeveelheid gegevens per halte worden opgevraagd. Dit maakt het mogelijk om meer haltes op te vragen met minder details per halte. Default is true oftewel: alle details

Object

Inhoud en betekenis

Stop

Bevat de identificerende gegevens en een indicatie of er gedurende de huidige dag vervoerdiensten zijn op deze halte. Alle andere halte-objecten hieronder zijn onderdeel van dit object.

Coordinates

De geografische coordinaten van de halte. De parameter in het request bepaalt welke projectie gebruikt wordt: WGS84 of RD. Alleen de coordinaten van de gevraagde projectie worden geleverd.

StopAttribute

Deze attributen geven de toegankelijkheid van de halte aan voor minder validen.

Line

Algemene en identificerende gegevens over een lijn indien de dienst op de huidige dag minimaal 1 keer wordt uitgevoerd.

Disruption

Dit kunnen zowel geplande als ongeplande verstoringen van de normale dienstregeling op een halte zijn. Een vervoerder kan in principe op ieder moment een ongeplande verstoring melden.

Parameter

Betekenis

StartTime

Begin van de periode waarvoor vertrekinformatie wordt gevraagd. In plaats van een datum/tijd kan ook de waarde NOW gekozen worden. Het waardebereik is vanaf het begin van de huidige dag tot enkele dagen in de toekomst. Default is NOW. Indien het datum/tijd formaat niet wordt herkend, dan wordt de waarde NOW aangenomen.

PreviewInterval

De duur van de periode waarvoor vertrekinformatie wordt gevraagd. De waarde is in minuten; de maximale waarde is 1440 (24 uur). Default is 60.

MaximumStopVisits

Het maximum aantal vertrektijden dat in de response teruggeleverd mag worden. Als het maximum bereikt is en er zijn meer vertrektijden in de gespecificeerde periode, dan wordt dit aangegeven in de response (zie ErrorMessage).

StopCodes

Een lijst van identificaties van de haltes. De codes zijn verschillend voor verschillende types haltes, ook al duiden ze dezelfde fysieke halte aan.

StopType

Het soort halte waarvan de identificaties worden gespecificeerd. Mogelijke waardes: Cluster, Physical, Quay en StopPlace. Default is Cluster.

LinePlanningNumber

Het lijnplanningsnummer is de identificatie van een lijn zoals die wordt gehanteerd in de planning van een dienstregeling. Dit nummer wordt geleverd bij haltes en vertrektijden en kan gebruikt worden om de vertrekinformatie te beperken tot specifieke lijnen. Meerdere lijnplanningsnummers kunnen worden gebruikt voor het filter.

OperatorName

Deze parameter beperkt vertrekinformatie tot de genoemde vervoerder(s). Meerdere namen zijn mogelijk.

TransportType

Deze parameter beperkt de lijst tot de genoemde typen vervoer. Meerdere typen zijn mogelijk.

Projection

Specificeert de projectie van de coordinaten die in het request zijn opgenomen en ook die in de response. Mogelijke waardes: WGS84 en RD. Default is WGS84.

Language

Bepaalt de taal van een aantal vertaalbare woorden in de response. Mogelijke waardes: NL of EN. Default is NL.

FlexOV

Bepaalt of naast vertrekinformatie voor het reguliere OV ook vertrekinformatie voor flexibel OV worden meegeleverd. Default is false.

PassageType

Specificeert of vertrek- of aankomstinformatie is gewenst of allebei. Default is vertrekinformatie.

Object

Inhoud en betekenis

VisitStop

Bevat identificerende gegevens van de halte.

Coordinates

De halte-coordinaten. Zie hierboven.

StopAttribute

De toegankelijkheid van de halte.

Visit

Dit object representeert het bezoek van vervoerdersdienst aan een halte en bevat gegevens van de vervoersdienst die voor de hele rit relevant zijn.

DepartureGroup

Dit object bevat gegevens die specifiek voor het vertrek van een vervoersdienst relevant zijn, zoals vertrektijd, vertrekplatform of -spoor, drukte-indicatie en wijzigingen t.o.v. van de geplande dienstregeling. De drukte-indicatie is een cijfer van 0 tot 5 met de betekenis:
0 - Onbekend
1 - Leeg
2 - Rustig
3 - Gemiddeld
4 - Druk
5 - Vol

ArrivalGroup

Analoog aan de DepartureGroup bevat dit object de gegevens die relevant zijn voor de aankomst van een vervoersdienst bij een halte. Bij een ArrivalGroup wordt geen drukte-indicatie geleverd.

Notice

Dit zijn meldingen van vervoerders die in de dienstregeling zijn opgenomen, bijv. contactgegevens voor het reserveren van diensten of wijzigingen die voor een langere periode gelden.

JourneyAttribute

Dit geeft de toegankelijkheid van het voertuig voor minder validen aan. Dit kan afwijken van de toegankelijkheid van de halte.

Disruption

Dit zijn meldingen van vervoerders over wijzigingen of verstoringen die buiten de dienstregeling optreden. Vaak gaat het om grootschalige of ingrijpende verstoringen met adviezen hoe verder te reizen.

Object

Inhoud en betekenis

ErrorMessage

Dit object wordt alleen geleverd indien er fouten tijdens de verwerking worden geconstateerd, bijv. een identificatie van een halte die niet (meer) bestaat of waarschuwingen, bijv. als er de resultaten zijn begrensd door het maximum aantal haltes.