#AutoTranslate
Brief Description
The StopEvent Service is used to construct a departure or arrival monitor.
Technical Description
API Explorer
You can try out your own requests – direct link to API Explorer.
Request
<?xml version="1.0" encoding="utf-8"?>
<OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.siri.org.uk/siri" version="1.0" xmlns:ojp="http://www.vdv.de/ojp" xsi:schemaLocation="http://www.siri.org.uk/siri ../ojp-xsd-v1.0/OJP.xsd">
<OJPRequest>
<ServiceRequest>
<RequestTimestamp>2021-01-09T11:34:25.507Z</RequestTimestamp>
<RequestorRef>API-Explorer</RequestorRef>
<ojp:OJPStopEventRequest>
<RequestTimestamp>2020-01-20T12:00:00Z</RequestTimestamp>
<MessageIdentifier>756</MessageIdentifier>
<ojp:Location>
<ojp:PlaceRef>
<ojp:StopPlaceRef>ch:1:sloid:30813</ojp:StopPlaceRef>
<ojp:LocationName>
<ojp:Text>Zürich Kreuzplatz</ojp:Text>
</ojp:LocationName>
</ojp:PlaceRef>
<ojp:DepArrTime>2021-01-20T12:00:00Z</ojp:DepArrTime>
<ojp:IndividualTransportOptions>
<Mode>walk</Mode>
<MaxDistance>5000</MaxDistance>
<MaxDuration>PT5M</MaxDuration>
<MinDistance>0</MinDistance>
<MinDuration>PT0M</MinDuration>
<Speed>50</Speed>
<AdditionalTime>PT10M</AdditionalTime>
</ojp:IndividualTransportOptions>
</ojp:Location>
<ojp:Params>
<ojp:StopEventType>both</ojp:StopEventType>
<ojp:IncludePreviousCalls>true</ojp:IncludePreviousCalls>
<ojp:IncludeOnwardCalls>true</ojp:IncludeOnwardCalls>
<ojp:IncludeOperatingDays>true</ojp:IncludeOperatingDays>
<ojp:IncludeRealtimeData>true</ojp:IncludeRealtimeData>
</ojp:Params>
</ojp:OJPStopEventRequest>
</ServiceRequest>
</OJPRequest>
</OJP>| Item | Cardinality | Description | Example |
|---|---|---|---|
RequestTimestamp | 1:1 | The timestamp of the request. Preferably in UTC time. |
<RequestTimestamp>2020-01-20T12:00:00Z</RequestTimestamp> |
MessageIdentifier | 0:1 | The identifier of the message. Increasingly increasing number preferred. |
<MessageIdentifier>756</MessageIdentifier> |
ojp:Location/ojp:PlaceRef | 0:1 | It is best to use a StopPlaceRef. Location Name is ignored.
Only SLOID will be used; for foreign StopPlaces, the BPUIC number may still occur as PlaceRef in StopPlaceRef. More Information. |
<ojp:PlaceRef> |
ojp:Location/ojp:DepArrTime | 0:1 | The time to be used. Ideally in UTC
‘Z’ stands for Zulu Time (independent of any time zone). For Z, the seconds must also be specified. If the format is not correct or if there is no Z, the system tries to interpret the time as local time. |
<ojp:DepArrTime>2020-01-20T12:00:00Z</ojp:DepArrTime> |
ojp:Location/ojp:TimeAllowance | 0:1 | As an alternative to DepArrTime. Time still needed to reach the location. xs:Duration. |
<ojp:Location>
|
ojp:Location/ojp:IndividualTransportOptions | 0:* | Options to reach or leave the location. See section on IndividualTransportOptions under Trip Service
Permitted modes: walk, cycle, taxi, self-drive-car, others-drive-car, motorcycle, truck. At the moment, only walk and cycle are supported. The distances are in metres. The speed is relative to normal (=100%). AdditionalTime is additional time in this mode. |
<ojp:IndividualTransportOptions> <Mode>walk</Mode> <MaxDistance>5000</MaxDistance> <MaxDuration>PT5M</MaxDuration> <MinDistance>0</MinDistance> <MinDuration>PT0M</MinDuration> <Speed>50</Speed> <AdditionalTime>PT10M</AdditionalTime> </ojp:IndividualTransportOptions>
|
ojp:Params | 0:1 | the parameters |
<ojp:Params> <ojp:StopEventType>both</ojp:StopEventType> <ojp:IncludePreviousCalls>true</ojp:IncludePreviousCalls> <ojp:IncludeOnwardCalls>true</ojp:IncludeOnwardCalls> <ojp:IncludeOperatingDays>true</ojp:IncludeOperatingDays> <ojp:IncludeRealtimeData>true</ojp:IncludeRealtimeData> </ojp:Params> |
Params
| Item | Cardinality | Description | Example |
|---|---|---|---|
ojp:PtModeFilter | 0:1 | Filter by mode. The Exclude element indicates whether the modes are to be included or excluded.
1:* mode can be added. See PtModeFilter under Trip Service |
<ojp:PtModeFilter> <ojp:Mode> <ojp:Exclude>true</ojp:Exclude> <ojp:PtMode>bus</ojp:PtMode> <siri:BusSubmode>localBusService</siri:BusSubmode> </ojp:Mode> </ojp:PtModeFilter> |
ojp:LineFilter | 0:1 | Filter by line. The Exclude element indicates whether the lines are to be included or excluded.
1:* Line can be added.
|
<ojp:LineFilter> <ojp:Line> <LineRef>sbb:91018:A</LineRef> <DirectionRef>H</DirectionRef> </ojp:Line> <ojp:Exclude>true</ojp:Exclude> </ojp:LineFilter> |
ojp:OperatorFilter | 0:1 | Filter by operator. The Exclude element indicates whether the operators are to be included or excluded.
1:* OperatorRef can be added. |
<ojp:OperatorFilter>
<ojp:Exclude>false</ojp:Exclude>
<ojp:OperatorRef>sbb:3849</ojp:OperatorRef>
</ojp:OperatorFilter>
|
ojp:NumberOfResults | 0:1 | Number of results |
<NumberOfResults>10</NumberOfResults> |
ojp:StopEventType | 0:1 | Type of StopEvents:
|
<ojp:StopEventType>both</ojp:StopEventType> |
ojp:IncludePreviousCalls | 0:1 | Show the previous stops for the individual trips as well? |
<ojp:IncludePreviousCalls>true</ojp:IncludePreviousCalls> |
ojp:IncludeOnwardCalls | 0:1 | Show the subsequent stops for the individual trips as well? |
<ojp:IncludeOnwardCalls>true</ojp:IncludeOnwardCalls> |
ojp:IncludeOperatingDays | 0:1 | Include operating day information for this Stopevent as well? |
ojp:IncludeOperatingDays>true</ojp:IncludeOperatingDays> |
ojp:IncludeRealtimeData | 0:1 | Use the real-time data to calculate the trip? |
<ojp:IncludeRealtimeData>true</ojp:IncludeRealtimeData> |
Response
<?xml version="1.0" encoding="UTF-8"?>
<siri:OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:siri="http://www.siri.org.uk/siri" version="1.0" xmlns:ojp="http://www.vdv.de/ojp" xsi:schemaLocation="http://www.siri.org.uk/siri ../ojp-xsd-v1.0/OJP.xsd">
<siri:OJPResponse>
<siri:ServiceDelivery>
<siri:ResponseTimestamp>2020-01-12T22:27:13Z</siri:ResponseTimestamp>
<siri:ProducerRef>OJPCH_test</siri:ProducerRef>
<siri:Status>true</siri:Status>
<ojp:OJPStopEventDelivery>
<siri:ResponseTimestamp>2020-01-12T22:27:13Z</siri:ResponseTimestamp>
<siri:RequestMessageRef>756</siri:RequestMessageRef>
<siri:Status>true</siri:Status>
<ojp:CalcTime>310</ojp:CalcTime>
<ojp:StopEventResponseContext>
<ojp:Places>
<ojp:Location>
<ojp:StopPlace>
<ojp:StopPlaceRef>ch:1:sloid:30813</ojp:StopPlaceRef>
<ojp:StopPlaceName>
<ojp:Text>Zürich Kreuzplatz</ojp:Text>
</ojp:StopPlaceName>
<ojp:TopographicPlaceRef>-1:-1</ojp:TopographicPlaceRef>
</ojp:StopPlace>
<ojp:LocationName>
<ojp:Text xml:lang="de">Zürich Kreuzplatz</ojp:Text>
</ojp:LocationName>
<ojp:GeoPosition/>
</ojp:Location>
<ojp:Location>
<ojp:StopPoint>
<siri:StopPointRef>ch:1:sloid:30813</siri:StopPointRef>
<ojp:StopPointName>
<ojp:Text>Zürich Kreuzplatz</ojp:Text>
</ojp:StopPointName>
<ojp:ParentRef>ch:1:sloid:30813</ojp:ParentRef>
<ojp:TopographicPlaceRef>-1:-1</ojp:TopographicPlaceRef>
</ojp:StopPoint>
<ojp:LocationName>
<ojp:Text xml:lang="de">Zürich Kreuzplatz</ojp:Text>
</ojp:LocationName>
<ojp:GeoPosition>
<siri:Longitude>8.55408</siri:Longitude>
<siri:Latitude>47.36488</siri:Latitude>
</ojp:GeoPosition>
</ojp:Location>
<!--- and so on --->
</ojp:Places>
</ojp:StopEventResponseContext>
<ojp:StopEventResult>
<ojp:ResultId>ID-61BB1C56-4F28-410A-9D03-298D9BF9165C</ojp:ResultId>
<ojp:StopEvent>
<ojp:PreviousCall>
<ojp:CallAtStop>
<siri:StopPointRef>ch:1:sloid:91228</siri:StopPointRef>
<ojp:StopPointName>
<ojp:Text>Zürich, Kienastenwies</ojp:Text>
</ojp:StopPointName>
<ojp:ServiceDeparture>
<ojp:TimetabledTime>2020-01-12T12:42:00Z</ojp:TimetabledTime>
</ojp:ServiceDeparture>
<ojp:Order>1</ojp:Order>
</ojp:CallAtStop>
</ojp:PreviousCall>
<!--- and so on --->
<ojp:ThisCall>
<ojp:CallAtStop>
<siri:StopPointRef>ch:1:sloid:30813</siri:StopPointRef>
<ojp:StopPointName>
<ojp:Text>Zürich Kreuzplatz</ojp:Text>
</ojp:StopPointName>
<ojp:ServiceArrival>
<ojp:TimetabledTime>2020-01-12T12:56:00Z</ojp:TimetabledTime>
</ojp:ServiceArrival>
<ojp:Order>14</ojp:Order>
</ojp:CallAtStop>
</ojp:ThisCall>
<ojp:OnwardCall>
<ojp:CallAtStop>
<siri:StopPointRef>ch:1:sloid:91375</siri:StopPointRef>
<ojp:StopPointName>
<ojp:Text>Zürich, Sprecherstrasse</ojp:Text>
</ojp:StopPointName>
<ojp:ServiceArrival>
<ojp:TimetabledTime>2020-01-12T12:56:00Z</ojp:TimetabledTime>
</ojp:ServiceArrival>
<ojp:ServiceDeparture>
<ojp:TimetabledTime>2020-01-12T12:56:00Z</ojp:TimetabledTime>
</ojp:ServiceDeparture>
<ojp:Order>15</ojp:Order>
</ojp:CallAtStop>
</ojp:OnwardCall>
<!--- and so on --->
<ojp:Service>
<ojp:OperatingDayRef></ojp:OperatingDayRef>
<ojp:JourneyRef>sbb:92031::R:j20:21060</ojp:JourneyRef>
<siri:LineRef>sbb:92031::R</siri:LineRef>
<siri:DirectionRef>H</siri:DirectionRef>
<ojp:Mode>
<ojp:PtMode>bus</ojp:PtMode>
<siri:BusSubmode>regionalBus</siri:BusSubmode>
<ojp:Name>
<ojp:Text xml:lang="de">Bus</ojp:Text>
</ojp:Name>
</ojp:Mode>
<ojp:PublishedLineName>
<ojp:Text>31</ojp:Text>
</ojp:PublishedLineName>
<ojp:OperatorRef>sbb:849:VerkehrsbetriebeZrich</ojp:OperatorRef>
<ojp:Attribute>
<ojp:Text>
<ojp:Text xml:lang="de">Linie 31: Niederflureinstieg</ojp:Text>
</ojp:Text>
<ojp:Code>30</ojp:Code>
<ojp:Mandatory>false</ojp:Mandatory>
</ojp:Attribute>
<ojp:OriginStopPointRef>ch:1:sloid:91228</ojp:OriginStopPointRef>
<ojp:OriginText>
<ojp:Text xml:lang="de">Zürich, Kienastenwies</ojp:Text>
</ojp:OriginText>
<ojp:DestinationStopPointRef>ch:1:sloid:91056</ojp:DestinationStopPointRef>
<ojp:DestinationText>
<ojp:Text xml:lang="de">Zürich Altstetten, Bahnhof</ojp:Text>
</ojp:DestinationText>
</ojp:Service>
</ojp:StopEvent>
</ojp:StopEventResult>
</ojp:OJPStopEventDelivery>
</siri:ServiceDelivery>
</siri:OJPResponse>
</siri:OJP>+
Please note that sometimes not only the relevant information for the selected stop is included but all the trip information. The answer is packed into an ojp:OJPStopEventDelivery.
| Item | Cardinality | Description | Example |
|---|---|---|---|
siri:ResponseTimestamp | 1:1 | The timestamp of the answer |
<siri:ResponseTimestamp>2020-04-03T14:47:59Z</siri:ResponseTimestamp> |
siri:RequesteMessageRef | 0:1 | This refers to the message that was requested |
<siri:RequestMessageRef>756</siri:RequestMessageRef> |
siri:Status | 1:1 | The status of the response. true means that the request has been processed. |
<siri:Status>true</siri:Status> |
ojp:CalcTime | 1:1 | The calculation time in milliseconds |
<ojp:CalcTime>939</ojp:CalcTime> |
ojp:StopEventResponseContext | 1:1 | Reference information such as the stops used is returned here.
See separate table | |
ojp:StopEventResult | 0:n | the actual results | |
ojp:StopEventResult/ojp:StopEventResultID | 1:1 | The ID of the result |
<ojp:ResultId>ID-5194D714-33A5-48B0-8895-BDCBAB540958</ojp:ResultId> |
ojp:StopEventResult/ojp:StopEvent | 1:1 | The individual journeys
see separate table |
StopEventResponseContext
The context includes
- Location(s)
- Situation(s) not yet implemented
| Item | Cardinality | Description | Example |
|---|---|---|---|
ojp:StopPlace | 1:1 | ||
ojp:StopPlace/ojp:StopPlaceRef | 1:1 | The reference to the stop. Only SLOID will be used; for foreign StopPoints, the BPUIC number may still occur as StopPlaceRef. |
<ojp:StopPlaceRef>ch:1:sloid:30813</ojp:StopPlaceRef> |
ojp:StopPlace/ojp:StopPlaceName | 1:1 | The name of the stop. There is currently no language for stops. |
<ojp:StopPlaceName> <ojp:Text>Zürich Kreuzplatz</ojp:Text> </ojp:StopPlaceName> |
ojp:StopPlace/ojp:TopographicPlaceRef | 1:1 | This is a reference in the location tree.
Since the location tree is not published, this feature can only be used if it has been requested beforehand in a LocationInformationRequest. |
<ojp:TopographicPlaceRef>23026261:27</ojp:TopographicPlaceRef> |
ojp:StopPlace/ojp:LocationName | 1:1 | Name of the location |
<ojp:LocationName> <ojp:Text xml:lang="de">Zürich Kreuzplatz</ojp:Text> </ojp:LocationName> |
ojp:StopPlace/ojp:GeoPosition | 1:1 | WGS84 coordinates |
<ojp:GeoPosition> <siri:Longitude>8.55408</siri:Longitude> <siri:Latitude>47.36488</siri:Latitude> </ojp:GeoPosition> |
ojp:StopEvent
The StopEvent consists of:
- ojp:PreviousCall(s): If parameters are set
- ojp:ThisCall: The currently selected stop
- ojp:OnwardCall(s): Future stops on the journey
- ojp:Service: Information about the journey
| Item | Cardinality | Description | Example |
|---|---|---|---|
ojp:PreviousCall | 0:* | The PreviousCall contains the stops before the one that was requested.
All information is contained in a CallAtStop. See relevant section |
<ojp:PreviousCall> |
ojp:ThisCall | 1:1 | This is the stop to which the request refers.
All information is contained in a CallAtStop. See relevant section |
<ojp:ThisCall> |
ojp:OnwardCall | 0:* | The OnwardCall contains the stops after the current stop that was specified in the request.
All information is contained in a CallAtStop. See relevant section |
<ojp:OnwardCall> |
ojp:Service | 1:1 | The service provides the actual information about the entire journey. |
<ojp:Service> |
ojp:CallAtStop
| Item | Cardinality | Description | Example |
|---|---|---|---|
siri:StopPointRef | 1:1 | The stop number. This is currently also a DiDok number. It can also be a NeTEx ID or a SLOID.
Attention: Both didok and sloid can occur. More Information. |
<siri:StopPointRef>ch:1:sloid:30813</siri:StopPointRef> |
ojp:StopPointName | 1:1 | The name of the stop |
<ojp:StopPointName> <ojp:Text>Zürich Kreuzplatz</ojp:Text> </ojp:StopPointName> |
ojp:PlannedQuay | 0:1 | The planned platform |
<ojp:PlannedQuay> <ojp:Text xml:lang="de">1</ojp:Text> </ojp:PlannedQuay> |
ojp:EstimatedQuay | 0:1 | The current platform, if available |
<ojp:EstimatedQuay> <ojp:Text xml:lang="de">1</ojp:Text> </ojp:EstimatedQuay |
ojp:ServiceArrival | 0:1 | The first stop has no arrival. |
<ojp:ServiceArrival> <ojp:TimetabledTime>2020-04-03T15:40:00Z</ojp:TimetabledTime> <ojp:EstimatedTime>2020-04-03T15:40:00Z</ojp:EstimatedTime> </ojp:ServiceArrival> |
ojp:ServiceDeparture | 0:1 | The last stop has no departure. |
<ojp:ServiceDeparture> <ojp:TimetabledTime>2020-04-03T15:40:00Z</ojp:TimetabledTime> <ojp:EstimatedTime>2020-04-03T15:40:00Z</ojp:EstimatedTime> </ojp:ServiceDeparture> |
ojp:Order | 1:1 | The sequence of the stops |
<ojp:Order>9</ojp:Order>
|
ojp:RequestStop | 0:1 | Request stop. Boolean.
Not implemented, planned for a future version. | n/a |
ojp:UnplannedStop | 0:1 | Stop that was not planned. Boolean.
Not implemented, planned for a future version. | n/a |
ojp:NotServicedStop | 0:1 | Contrary to plans, there will be no stops (cancellations). |
<ojp:NotServicedStop>true</ojp:NotServicedStop> |
ojp:SituationFullRef | 0:1 | This feature is unavailable.
| n/a |
ojp:Service
| Item | Cardinality | Description | Example |
|---|---|---|---|
ojp:OperatingDayRef | 1:1 | The relevant operating day |
<ojp:OperatingDayRef>2020-04-03</ojp:OperatingDayRef> |
ojp:JourneyRef | 1:1 | The ID of the journey. |
<ojp:JourneyRef>sbb:91011:A:R:j20:887</ojp:JourneyRef> |
siri:LineRef | 1:1 | The ID of the line: |
<siri:LineRef>sbb:91011:A</siri:LineRef> |
siri:DirectionRef | 1:1 | The ID of the direction. |
<siri:DirectionRef>R</siri:DirectionRef> |
ojp:Mode | 1:1 | The mode of transport.
The list of modes can be found at LocationInformationRequest |
<ojp:Mode> <ojp:PtMode>tram</ojp:PtMode> <siri:TramSubmode>cityTram</siri:TramSubmode> <ojp:Name> <ojp:Text xml:lang="de">Tram</ojp:Text> </ojp:Name> </ojp:Mode> |
ojp:PublishedLineName | 1:1 | The published name of the list |
<ojp:PublishedLineName> <ojp:Text>11</ojp:Text> </ojp:PublishedLineNam |
ojp:OperatorRef | 0:1 | The reference to the operator.
Attention: will still change. |
<ojp:OperatorRef>sbb:3849</ojp:OperatorRef> |
ojp:Attribute | 0:* | Attributes are properties, usually relating to trips. E.g. low-floor bus, bar, reservation required.
ojp:Mandateory is true if the attribute must be displayed to the user. |
<ojp:Attribute> <ojp:Text> <ojp:Text xml:lang="de">Linie 31: Niederflureinstieg</ojp:Text> </ojp:Text> <ojp:Code>30</ojp:Code> <ojp:Mandatory>false</ojp:Mandatory> </ojp:Attribute> |
ojp:OrginStopPointRef | 0:1 | The Didok number of the starting point.
Attention: The ID will still change. |
<ojp:OriginStopPointRef>ch:1:sloid:91315</ojp:OriginStopPointRef> |
ojp:OriginText | 0:1 | The name of the departure stop. |
<ojp:OriginText> <ojp:Text xml:lang="de">Zürich, Rehalp</ojp:Text> </ojp:OriginText> |
ojp:DestinationStopPointRef | 0:1 | The DiDok number of the destination stop.
Attention: The ID will still change. |
<ojp:DestinationStopPointRef>8591049</ojp:DestinationStopPointRef> |
ojp:DestinationText | 0:1 | The name of the destination stop. |
<ojp:DestinationText> <ojp:Text xml:lang="de">Zürich, Auzelg</ojp:Text> </ojp:DestinationText> |
ojp:Unplanned | 0:1 | Indicates whether this is an additional journey not listed in the regular timetable. Boolean. |
<ojp:Unplanned>true</ojp:Unplanned> |
ojp:Cancelled | 0:1 | A journey was cancelled. Boolean. |
<ojp:Cancelled>true</ojp:Cancelled> |
ojp:Deviation | 0:1 | Indicates whether the journey is not running according to the timetable.
Planned for future release | n/a |
ojp:BookingArrangements | 0:1 | This feature is not supported. | n/a |
ojp:ParticipantRef | 1:1 | Is used to communicate faults or other exceptional situations.
Planned for future release | n/a |
ojp:SituationNumber | 1:1 | Is used to communicate faults or other exceptional situations.
Planned for future release | n/a |
Further information
Car tunnel hoists
<siri:OJP xmlns="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.vdv.de/ojp" version="1.0">
<siri:OJPRequest>
<siri:ServiceRequest>
<siri:RequestTimestamp>2024-07-22T10:40:16.970Z</siri:RequestTimestamp>
<siri:RequestorRef>OJP_JS_SDK_v0.9.35</siri:RequestorRef>
<OJPStopEventRequest>
<siri:RequestTimestamp>2024-07-22T10:40:16.970Z</siri:RequestTimestamp>
<Location>
<PlaceRef>
<StopPlaceRef>ch:1:sloid:19606</StopPlaceRef>
<LocationName>
<Text/>
</LocationName>
</PlaceRef>
<DepArrTime>2024-07-22T10:40:02.237Z</DepArrTime>
</Location>
<Params>
<NumberOfResults>10</NumberOfResults>
<StopEventType>departure</StopEventType>
<IncludePreviousCalls>true</IncludePreviousCalls>
<IncludeOnwardCalls>true</IncludeOnwardCalls>
<IncludeRealtimeData>true</IncludeRealtimeData>
</Params>
<siri:Extensions>
<ParamsExtension>
<PrivateModeFilter>
<Exclude>false</Exclude>
</PrivateModeFilter>
</ParamsExtension>
</siri:Extensions>
</OJPStopEventRequest>
</siri:ServiceRequest>
</siri:OJPRequest>
</siri:OJP>Large-capacity profiles (at BLS) can be identified by the GF-attribute:
<ojp:Attribute>
<ojp:Text>
<ojp:Text xml:lang="de">Grossraumprofil</ojp:Text>
</ojp:Text>
<ojp:Code>A__GF</ojp:Code>
</ojp:Attribute>