Zum Inhalt springen

OJPStopEventRequest

StopEventService

Der StopEvent Service dient dazu, einen Abfahrts- oder Ankunftsmonitor zu konstruieren.

API-Explorer

Sie können eigene Requests ausprobieren – direkter Link zum API-Explorer.

Request

Element Kardinalität Beschreibung Beispiel
RequestTimestamp 1:1  Timestamp der Anfrage. Bevorzugt in Zulu Time.
MessageIdentifier 0:1 Der Identifier der Meldung. Bevorzugt stetig steigend.
ojp:Location/ojp:PlaceRef 0:1 Am Besten die Verwendung eines StopPlaceRef. Location Name wird ignoriert.
ojp:Location/ojp:DepArrTime 0:1 Die zu verwendende Zeit. Am Besten als Zulu-Time

„Z“ ist Zulu-Zeit (also zeitzonenunabhängig). Bei Z müssen unbedingt die Sekunden auch angegeben werden. Stimmt das Format nicht oder ist kein Z vorhanden, versucht das System, die Zeit als lokale Zeit zu interpretieren.

 ojp:Location/ojp:TimeAllowance 0:1 Als Alternative zu DepArrTime. Zeit, die noch nötig ist, die Location zu erreichen. xs:Duration.

 

 ojp:Location/ojp:IndividualTransportOptions 0:* Optionen, um den Ort zu erreichen oder zu verlassen. Siehe Abschnitt zu IndividualTransportOptions unter Trip Service

Erlaubte Modes: walk, cycle, taxi, self-drive-car, others-drive-car, motorcycle, truck. Im Moment werden nur walk und cycle unterstützt. Die Distanzen sind in Meter. Die Geschwindigkeit relativ zu normal (=100%). AdditionalTime ist zusätzliche Zeit bei diesem Modus.

 

ojp:/Params 0:1  die Parameter

Params

Elemente Kardinalität Beschreibung Beispiel
ojp:PtModeFilter 0:1 Filter nach Mode. Element Exclude gibt an, ob die Modes ein- oder ausgeschlossen werden sollen.

Es können 1:* Mode hinzugefügt werden.

Siehe PtModeFilter unter Trip Service

ojp:LineFilter 0:1 Filter nach Linie. Element Exclude gibt an, ob die Linien ein- oder ausgeschlossen werden sollen.

Es können 1:* Line hinzugefügt werden.

 

ojp:OperatorFilter Filter nach Betreiber. Element Exclude gibt an, ob die Betreiber ein- oder ausgeschlossen werden sollen.

Es können 1:* OperatorRef hinzugefügt werden.

 

ojp:NumberOfResults  0:1 Anzahl Resultate

ojp:StopEventType 0:1 Typ der StopEvents:

  • arrival
  • departure
  • both
 ojp:IncludePreviousCalls 0:1 Sollen für die einzelnen Fahrten die vorangehenden Halte auch angegeben werden?
ojp:IncludeOnwardCalls  0:1  Sollen für die einzelnen Fahrten die anschliessenden Halte auch angegeben werden?
ojp:IncludeOperatingDays 0:1 Soll Betriebstaginformation für diesen Stopevent auch eingefügt werden?
ojp:IncludeRealtimeData 0:1 Sollen die Echtzeitdaten für die Berechnung des Trips verwendet werden?

Response

Es ist wichtig zu wissen, dass zum Teil nicht nur die relevante Information am ausgewählten Halt, sondern direkt alle Fahrtinformation enthalten ist. Die Antwort ist in einer ojp:OJPStopEventDelivery enthalten.

 

Element Kardinalität Beschreibung Beispiel
siri:ResponseTimestamp 1:1 Der timestamp der Antwort
siri:RequesteMessageRef 0:1 Hier wird die Message referenziert, die angefragt wurde
siri:Status 1:1 Der Status der Antwort. true heisst, die Anfrage wurde bearbeitet.
ojp:CalcTime 1:1 Die Berechnungszeit in Millisekunden
ojp:StopEventResponseContext 1:1 Hier werden Referenzinformationen wie die verwendeten Haltestellen zurückgeliefert.

Siehe separate Tabelle

ojp:StopEventResult 1:1 die effektiven Resultate
ojp:StopEventResult/ojp:StopEventResultID 1:1 Die ID des Resultats

ojp:StopEventResult/ojp:StopEvent 1:n Die einzelnen Fahrten

siehe separate Tabelle

StopEventResponseContext

Der Kontext enthält

  • Location(s)
  • Situation(s) Noch nicht implementiert
Element Kardinalität Beschreibung Beispiel
ojp:StopPlace 1:1
ojp:StopPlace/ojp:StopPlaceRef 1:1 Die Referenz auf die Haltestelle. Im Moment ist es die DiDok-Nummer. Es kann sich aber auch um die NeTEx-id eines StopPlace handeln oder in Zukunft auch um eine Swiss Location id (SLOID). Bis auf Weiteres besteht ein enger Zusammenhang zwischen den drei Referenzen.
ojp:StopPlace/ojp:StopPlaceName 1:1 Der Name des Halts. Bei Haltestellen gibt es im Moment keine Sprache.
ojp:StopPlace/ojp:TopographicPlaceRef 1:1 Es handelt sich um eine Referenz im Ortebaum.

Da es keine Publikation des Ortebaums gibt, kann dieses Feature nur verwendet werden, wenn es vorgängig in einem LocationInformationRequest angefragt wurde.

ojp:StopPlace/ojp:LocationName 1:1 Name des Ortes

ojp:StopPlace/ojp:GeoPosition 1: WGS84 Koordinaten

ojp:StopEvent

Das StopEvent besteht aus:

  • ojp:PreviousCall(s): Wenn Parameter gewählt
  • ojp:ThisCall: Der aktuell ausgewählte Halt
  • ojp:OnwardCall(s): Zukünftige Halte auf der Fahrt
  • ojp:Service: Informationen zur Fahrt
Element Kardinalität Beschreibung Beispiel
 ojp:PreviousCall  0:*  Die PreviousCall sind die Halte vor demjenigen, der angefragt wurde.

Alle Information ist in einem CallAtStop. Siehe entsprechenden Abschnitt

ojp:ThisCall 1:1  Dies ist der Halt, um den es im Request geht.

Alle Information ist in einem CallAtStop. Siehe entsprechenden Abschnitt

ojp:OnwardCall 0:*  Der OnwardCall sind die Halte nach dem aktuellen Halt, der im Request angefragt wurde.

Alle Information ist in einem CallAtStop. Siehe entsprechenden Abschnitt

ojp:Service 1:1  Der Service ist die eigentliche Information zur ganzen Fahrt.

ojp:CallAtStop

Elment Kardinalität Beschreibung Beispiel
siri:StopPointRef 1:1  Die Haltestellennummer. Im Moment ist es noch eine DiDok-Nummer. Es kann sich auch um eine NeTEx-Id oder um ein SLOID handeln.

ojp:StopPointName 1:1 Der Name der Haltestelle

ojp:PlannedQuay  0:1  Der geplante Steig

ojp:EstimatedQuay 0:1  Der aktuelle Steig, wenn vorhanden

ojp:ServiceArrival 0:1 Der erste Halt hat kein Arrival.

ojp:ServiceDeparture 0:1

ojp:Order 1:1 Die Reihenfolge der Haltestellen

 

ojp:RequestStop 0:1 Halt auf Verlangen. Boolean.

Nicht implementiert, geplant für eine zukünftige Version.

n/a
ojp:UnplannedStop 0:1 Halt, der laut Planung nicht vorgesehen war. Boolean.

Nicht implementiert, geplant für eine zukünftige Version.

n/a
ojp:NotServicedStop 0:1 Entgegen der Planung findet kein Halt statt (Ausfälle).

ojp:SituationFullRef 0:1 Das Feature ist nicht verfügbar.

 

n/a

ojp:Service

Element Kardinalität Beschreibung Beispiel
ojp:OperatingDayRef  1: Der relevante Betriebstag

ojp:JourneyRef  1:1  Die id der Fahrt.

siri:LineRef  1:1 Die id der Linie:

siri:DirectionRef 1:1 Die id der Richtung.

ojp:Mode 1:1 Der Verkehrsmodus.

Die Liste der Modi findet sich beim LocationInformationRequest

ojp:PublishedLineName 1:1  Der veröffentlichte Name der Liste

ojp:OperatorRef 0:1 Die Referenz auf den Betreiber.

Achtung: wird sich noch verändern.

ojp:Attribute 0:* Attribute sind Eigenschaften meist auf Fahrten. Z.B. Niederflurbus, Bar, Reservation notwendig.

ojp:Mandataory ist true, wenn das Attribut dem Benutzer unbedingt angezeigt werden muss.

ojp:OrginStopPointRef  0:1 Die Didok-Nummer des Startpunkts.

Achtung: Die id wird sich noch verändern.

ojp:OriginText 0:1 Der Name der Starthaltestelle.

ojp:DestinationStopPointRef 0:1 Die DiDok-Nummer der/ Zielhaltestelle.

Achtung: Die id wird sich noch verändern.

ojp:DestinationText 0:1 Der Name der Zielhaltestelle.

ojp:Unplanned 0:1 Gibt an, ob es sich um eine zusätzliche, nicht im regulären Fahrplan aufgeführte Verbindung handelt. Boolean.

ojp:Cancelled 0:1 Ausfall einer Verbindung. Boolean.

ojp:Deviation 0:1 Gibt an, ob die Verbindung nicht gemäss dem Fahrplan ausgeführt wird.

Geplant für eine zukünftige Version

n/a
ojp:BookingArrangements 0:1 Das Feature wird nicht unterstützt. n/a
ojp:ParticipantRef 1:1 Dient zur Kommunikation von Störungen oder sonstigen aussergewöhnlichen Situationen.

Geplant für eine zukünftige Version

n/a
ojp:SituationNumber 1:1 Dient zur Kommunikation von Störungen oder sonstigen aussergewöhnlichen Situationen.

Geplant für eine zukünftige Version

n/a