SIRI SX - Message with stopCondition on a Vehicle
Content
- 1 Messages depending on stopCondition
- 1.1 The message is only shown when the affected stop is the target or origin of a travel search request
- 1.1.1 stopCondition
- 1.2 The message is only shown when boarding a specific vehicle (departure) on a specific stop
- 1.2.1 stopCondition
- 1.3 The message is shown for all searches to-, from, or past the specified stops on a vehicle (departure)
- 1.3.1 stopCondition
- 1.4 The message is shown when searching past a specific stop on a vehicle (departure)
- 1.4.1 stopCondition
- 1.1 The message is only shown when the affected stop is the target or origin of a travel search request
XML
See complete examples:
Boarding and alighting: https://github.com/entur/profile-norway-examples/blob/master/siri/situation-exchange/siri-sx-alight-board-specific-stop-and-vehicle.xml
Only boarding: https://github.com/entur/profile-norway-examples/blob/master/siri/situation-exchange/siri-sx-boarding-specific-stop-and-vehicle.xml
Boarding and alighting or passing: https://github.com/entur/profile-norway-examples/blob/master/siri/situation-exchange/siri-sx-alight-board-passing-stops.xml
Messages depending on stopCondition
The message is only shown when the affected stop is the target or origin of a travel search request
The message is displayed depending on the search request parameters, time and StopConditions.
stopCondition
<!---For Vehicle 1--->
<AffectedStopPoint>
<StopPointRef>NSR:Quay:1067</StopPointRef>
<StopPointName>Dovre</StopPointName>
<StopCondition>destination</StopCondition>
<StopCondition>startPoint</StopCondition>
</AffectedStopPoint>The message will be displayed when searching from- or to Dovre.
The following is true for the illustration:
Search 1 will not show the message
Search 2 will show the message
Search 3 will not show the message
Search 4 will show the message due to startPoint at Dovre
Search 5 will not show the message
The message is only shown when boarding a specific vehicle (departure) on a specific stop
The message is referenced by multiple stops on the same specific VehicleJourney (specific departure on a specific date set with <VehicleJourneyRef> and <OriginAimedDepartureTime>).
stopConditions are set to 'startPoint' for all stops, and the message will only be shown when searching a journey on the specific date, with the specific departure, from one of the specific stops.
stopCondition
<!---For Vehicle 1--->
<StopPoints>
<AffectedStopPoint>
<StopPointRef>NSR:Quay:629</StopPointRef>
<StopPointName>Kvam</StopPointName>
<StopCondition>startPoint</StopCondition>
</AffectedStopPoint>
<AffectedStopPoint>
<StopPointRef>NSR:Quay:652</StopPointRef>
<StopPointName>Dovre</StopPointName>
<StopCondition>startPoint</StopCondition>
</AffectedStopPoint>
<AffectedStopPoint>
<StopPointRef>NSR:Quay:316</StopPointRef>
<StopPointName>Oppdal</StopPointName>
<StopCondition>startPoint</StopCondition>
</AffectedStopPoint>
</StopPoints>The following is true for the illustration:
Search 1 will not show the message
Search 2 will not show the message
Search 3 will not show the message
Search 4 will show the message
Search 5 will not show the message
The message is shown for all searches to-, from, or past the specified stops on a vehicle (departure)
The message is applied to multiple successive stops on a VehicleJourney, on a specific OriginAimedDepartureTime.
The message is shown in search responses where the particular vehicle, stop, and date appears but depends on the stopConditions on the stops.
stopCondition
<!---For Vehicle 1--->
<StopPoints>
<AffectedStopPoint>
<StopPointRef>NSR:Quay:4</StopPointRef>
<StopPointName>Otta</StopPointName>
<StopCondition>startPoint</StopCondition>
</AffectedStopPoint>
<AffectedStopPoint>
<StopPointRef>NSR:Quay:652</StopPointRef>
<StopPointName>Dovre</StopPointName>
<StopCondition>notStopping</StopCondition>
<StopCondition>destination</StopCondition>
<StopCondition>startPoint</StopCondition>
</AffectedStopPoint>
<AffectedStopPoint>
<StopPointRef>NSR:Quay:645</StopPointRef>
<StopPointName>Dombås</StopPointName>
<StopCondition>notStopping</StopCondition>
<StopCondition>destination</StopCondition>
<StopCondition>startPoint</StopCondition>
</AffectedStopPoint>
<AffectedStopPoint>
<StopPointRef>NSR:Quay:316</StopPointRef>
<StopPointName>Oppdal</StopPointName>
<StopCondition>destination</StopCondition>
</AffectedStopPoint>
</StopPoints>The following is true for the illustration:
Search 1 will not show the message
Search 2 will show the message due to Dovre being the destination
Search 3 will show the message twice, due to notStopping at Dovre and notStopping at Dombås
Search 4 will show the message three times, due to startPoint at Dovre, notStopping at Dombås and destination at Oppdal
Search 5 will not show the message
The message is shown when searching past a specific stop on a vehicle (departure)
The message is applied to multiple successive stops on a VehicleJourney, on a specific OriginAimedDepartureTime.
The message is shown in search responses where the particular vehicle- and stop.
stopCondition
<!---For Vehicle 1--->
<AffectedStopPoint>
<StopPointRef>NSR:Quay:652</StopPointRef>
<StopPointName>Dovre</StopPointName>
<StopCondition>notStopping</StopCondition>
</AffectedStopPoint>The following is true for the illustration:
Search 1 will not show the message
Search 2 will not show the message
Search 3 will show the message
Search 4 will not show the message
Search 5 will not show the message