Skip to content

Add new element Period in PassengerInformationActionStructure #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TuThoThai merged 13 commits into from
May 18, 2026
Merged

Add new element Period in PassengerInformationActionStructure #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
aaa1245
add new element ActionPeriod in PassengerInformationAction
haeckerbaer Nov 7, 2025
bd51999
Lint and update documentation tables
github-actions[bot] Nov 7, 2025
db4742d
harmonize element name and update annotation
haeckerbaer Jan 28, 2026
0508dc1
add example showcasing Period on PassengerInformationAction level
haeckerbaer Jan 28, 2026
ed44484
simplify example
haeckerbaer Jan 30, 2026
436259b
Merge branch 'v2.3-wip' into sx_cr_action_validity
TuThoThai Apr 6, 2026
aa2f3cb
fix validation errors in sx esaf example
haeckerbaer May 13, 2026
68abf10
rename action period to match schema
haeckerbaer May 13, 2026
6acf382
add comment describing difference between the two ESAF examples
haeckerbaer May 13, 2026
95e456e
add second ESAF example without new period feature
haeckerbaer May 13, 2026
eccb6f8
Merge branch 'v2.3-wip' into sx_cr_action_validity
TuThoThai May 13, 2026
2f93af6
Merge branch 'v2.3-wip' into sx_cr_action_validity
TuThoThai May 13, 2026
7d448f2
Merge branch 'v2.3-wip' into sx_cr_action_validity
TuThoThai May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/generated/contab/siri.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201313,6 +201313,30 @@ <h3>28.27. The complex type <code>siri:PassengerInformationActionStructure</code
<p class="tableblock darkbrown">Reference to the action number within the incident concept.</p>
</td>
</tr>
<tr>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<a shape="rect" href="" title=""/>
</td>
<td colspan="2" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<code>siri:ActionPeriod</code>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<span title="optional, multiple">0:*</span>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock">
<em>+<a shape="rect" href="#type.siri:HalfOpenTimestampOutputRangeStructure" title="siri:HalfOpenTimestampOutputRangeStructure">siri:HalfOpenTimestampOutputRangeStructure</a>
</em>
</p>
</td>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<p class="tableblock darkbrown">Period of effect of disruption, if different from that of SITUATION, specifically in case of multiple applicable periods (for example periodic roadworks during the night). If omitted, then the ValidityPeriods on PtSituationElement level apply, otherwise overwrites the former.</p>
</td>
</tr>
<tr>
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
<a shape="rect" href="" title=""/>
Expand Down
234 changes: 234 additions & 0 deletions examples/siri_exm_SX/VDV736_exm/SX_ESAF_example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
<?xml version="1.0" encoding="utf-8"?>
<Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.3">
<ServiceDelivery>
<ResponseTimestamp>2022-04-14T09:17:32Z</ResponseTimestamp>
<ProducerRef>ski-ems-out-sx_tesst</ProducerRef>
<ResponseMessageIdentifier>wcP9TgJhf</ResponseMessageIdentifier>
<Status>true</Status>
<MoreData>false</MoreData>
<SituationExchangeDelivery version="2.3">
<ResponseTimestamp>2022-04-14T09:17:32Z</ResponseTimestamp>
<SubscriberRef>ski-ddip-in-sx_test</SubscriberRef>
<SubscriptionRef>1</SubscriptionRef>
<Situations>
<PtSituationElement>
<CreationTime>2022-04-14T09:17:23Z</CreationTime>
<CountryRef>ch</CountryRef>
<ParticipantRef>ski-ems-out-sx_test</ParticipantRef>
<SituationNumber>ch:1:sstid:1:3ac880a2-aeb1-5757-989d-d3c15c8220c6</SituationNumber>
<Version>1</Version>
<Source>
<Country>ch</Country>
<SourceType>directReport</SourceType>
<Name>EMS</Name>
<ExternalCode>ski-ems-out-sx_test</ExternalCode>
</Source>
<VersionedAtTime>2022-04-14T09:17:26Z</VersionedAtTime>
<Progress>published</Progress>
<ValidityPeriod>
<StartTime>2022-08-26T04:00:00Z</StartTime>
<EndTime>2022-08-26T21:00:00Z</EndTime>
</ValidityPeriod>
<PublicationWindow>
<StartTime>2022-04-14T09:17:23Z</StartTime>
<EndTime>2022-08-26T21:59:00Z</EndTime>
</PublicationWindow>
<AlertCause>specialEvent</AlertCause>
<Severity>normal</Severity>
<Priority>3</Priority>
<Audience>public</Audience>
<ScopeType>stopPlace</ScopeType>
<Planned>true</Planned>
<Language>DE</Language>
<Summary xml:lang="DE">Haltestelle Pratteln, Bahnhof verschoben.</Summary>
<Summary xml:lang="EN">Pratteln, Bahnhof stop moved.</Summary>
<Detail xml:lang="DE">Grund ist eine Veranstaltung.</Detail>
<Detail xml:lang="EN">Due to an event.</Detail>
<Affects>
<StopPlaces>
<AffectedStopPlace>
<StopPlaceRef>ch:1:sloid:94994</StopPlaceRef>
<PlaceName>Pratteln, Bahnhof</PlaceName>
</AffectedStopPlace>
</StopPlaces>
</Affects>
<PublishingActions>
<PublishingAction>
<PublishAtScope>
<ScopeType>stopPlace</ScopeType>
<Affects>
<StopPlaces>
<AffectedStopPlace>
<StopPlaceRef>ch:1:sloid:94994</StopPlaceRef>
<PlaceName>Pratteln, Bahnhof</PlaceName>
</AffectedStopPlace>
</StopPlaces>
</Affects>
</PublishAtScope>
<PassengerInformationAction>
<PublicationWindow>
<StartTime>2022-04-14T09:17:23Z</StartTime>
<EndTime>2022-08-26T21:59:00Z</EndTime>
</PublicationWindow>
<ActionRef>ems-696-1</ActionRef>
<!--Compared to the other ESAF example without period, in this scenario two different texts are published: one in the morning and another one in the afternoon. As a result, one ValidityPeriod on PtSituationElement level is not sufficient and therefore Period is actually required on PassengerInformationAction level to distinguish.-->
<Period>
<StartTime>2022-08-26T04:00:00Z</StartTime>
<EndTime>2022-08-26T12:00:00Z</EndTime>
</Period>
<RecordedAtTime>2022-04-14T09:17:26Z</RecordedAtTime>
<OwnerRef>ch:1:sboid:100626</OwnerRef>
<Perspective>whilePlanningTrip</Perspective>
<TextualContent>
<TextualContentSize>S</TextualContentSize>
<SummaryContent>
<SummaryText xml:lang="DE">Pratteln, Bahnhof verschoben</SummaryText>
<SummaryText xml:lang="EN">Pratteln, Bahnhof moved</SummaryText>
</SummaryContent>
<ReasonContent>
<ReasonText xml:lang="DE">Grund: Veranstaltung (ESAF)</ReasonText>
<ReasonText xml:lang="EN">Due to an event (ESAF)</ReasonText>
</ReasonContent>
<ConsequenceContent>
<ConsequenceText xml:lang="DE">Die Haltestelle ist verschoben um 500 Meter Richtung Altstadt</ConsequenceText>
<ConsequenceText xml:lang="EN">The bus stop has been moved by 500 meters in the direction of the old town</ConsequenceText>
</ConsequenceContent>
<RecommendationContent>
<RecommendationText xml:lang="DE">Bitte benutzen Sie die provisorische Haltestelle Pratteln, Bahnhof (Richtung Festgelände)</RecommendationText>
<RecommendationText xml:lang="EN">Please use the temporary stop Pratteln, Bahnhof (direction Festgelände)</RecommendationText>
</RecommendationContent>
<DurationContent>
<DurationText xml:lang="DE">Dauer: 26.08.2022, 06:00 - 26.08.2022, 14:00</DurationText>
<DurationText xml:lang="EN">Duration: 26.08.2022, 06:00 - 26.08.2022, 14:00</DurationText>
</DurationContent>
<RemarkContent>
<Remark xml:lang="DE">Bei Fragen wenden Sie sich an das Informationspersonal vor Ort</Remark>
<Remark xml:lang="EN">If you have any questions, please contact the information staff on site</Remark>
</RemarkContent>
</TextualContent>
</PassengerInformationAction>
<PassengerInformationAction>
<PublicationWindow>
<StartTime>2022-04-14T09:17:26Z</StartTime>
<EndTime>2022-08-28T21:59:00Z</EndTime>
</PublicationWindow>
<ActionRef>ems-696-2</ActionRef>
<!--Compared to the other ESAF example without period, in this scenario two different texts are published: one in the morning and another one in the afternoon. As a result, one ValidityPeriod on PtSituationElement level is not sufficient and therefore Period is actually required on PassengerInformationAction level to distinguish.-->
<Period>
<StartTime>2022-08-26T13:00:00Z</StartTime>
<EndTime>2022-08-26T21:00:00Z</EndTime>
</Period>
<RecordedAtTime>2022-04-14T09:17:26Z</RecordedAtTime>
<OwnerRef>ch:1:sboid:100626</OwnerRef>
<Perspective>whilePlanningTrip</Perspective>
<TextualContent>
<TextualContentSize>S</TextualContentSize>
<SummaryContent>
<SummaryText xml:lang="DE">Pratteln, Bahnhof verschoben</SummaryText>
<SummaryText xml:lang="EN">Pratteln, Bahnhof moved</SummaryText>
</SummaryContent>
<ReasonContent>
<ReasonText xml:lang="DE">Grund: Veranstaltung (ESAF)</ReasonText>
<ReasonText xml:lang="EN">Due to an event (ESAF)</ReasonText>
</ReasonContent>
<ConsequenceContent>
<ConsequenceText xml:lang="DE">Die Haltestelle ist verschoben an die Wasenstrasse</ConsequenceText>
<ConsequenceText xml:lang="EN">The bus stop has been moved to Wasenstrasse</ConsequenceText>
</ConsequenceContent>
<RecommendationContent>
<RecommendationText xml:lang="DE">Bitte folgen Sie der Signalisation für den Zugang zu den Gleisen</RecommendationText>
<RecommendationText xml:lang="EN">Please follow the signs to access the platforms</RecommendationText>
</RecommendationContent>
<DurationContent>
<DurationText xml:lang="DE">Dauer: 26.08.2022, 15:00 - 26.08.2022, 23:00</DurationText>
<DurationText xml:lang="EN">Duration: 26.08.2022, 15:00 - 26.08.2022, 23:00</DurationText>
</DurationContent>
<RemarkContent>
<Remark xml:lang="DE">Bei Fragen wenden Sie sich an das Informationspersonal vor Ort</Remark>
<Remark xml:lang="EN">If you have any questions, please contact the information staff on site</Remark>
</RemarkContent>
</TextualContent>
</PassengerInformationAction>
<PassengerInformationAction>
<PublicationWindow>
<StartTime>2022-08-26T02:00:00Z</StartTime>
<EndTime>2022-08-26T12:00:00Z</EndTime>
</PublicationWindow>
<ActionRef>ems-696-3</ActionRef>
<RecordedAtTime>2022-04-14T09:17:26Z</RecordedAtTime>
<OwnerRef>ch:1:sboid:100626</OwnerRef>
<Perspective>atStopPoint</Perspective>
<Perspective>onBoardVehicle</Perspective>
<TextualContent>
<TextualContentSize>S</TextualContentSize>
<SummaryContent>
<SummaryText xml:lang="DE">Pratteln, Bahnhof verschoben</SummaryText>
<SummaryText xml:lang="EN">Pratteln, Bahnhof moved</SummaryText>
</SummaryContent>
<ReasonContent>
<ReasonText xml:lang="DE">Grund: Veranstaltung (ESAF)</ReasonText>
<ReasonText xml:lang="EN">Due to an event (ESAF)</ReasonText>
</ReasonContent>
<ConsequenceContent>
<ConsequenceText xml:lang="DE">Die Haltestelle ist verschoben um 500 Meter Richtung Altstadt</ConsequenceText>
<ConsequenceText xml:lang="EN">The bus stop has been moved by 500 meters in the direction of the old town</ConsequenceText>
</ConsequenceContent>
<RecommendationContent>
<RecommendationText xml:lang="DE">Bitte benutzen Sie die provisorische Haltestelle Pratteln, Bahnhof (Richtung Festgelände)</RecommendationText>
<RecommendationText xml:lang="EN">Please use the temporary stop Pratteln, Bahnhof (direction Festgelände)</RecommendationText>
</RecommendationContent>
<DurationContent>
<DurationText xml:lang="DE">Dauer: 26.08.2022, 04:00 - 26.08.2022, 14:00</DurationText>
<DurationText xml:lang="EN">Duration: 26.08.2022, 04:00 - 26.08.2022, 14:00</DurationText>
</DurationContent>
<RemarkContent>
<Remark xml:lang="DE">Bei Fragen wenden Sie sich an das Informationspersonal vor Ort</Remark>
<Remark xml:lang="EN">If you have any questions, please contact the information staff on site</Remark>
</RemarkContent>
</TextualContent>
</PassengerInformationAction>
<PassengerInformationAction>
<PublicationWindow>
<StartTime>2022-08-26T13:00:00Z</StartTime>
<EndTime>2022-08-26T21:59:00Z</EndTime>
</PublicationWindow>
<ActionRef>ems-696-6</ActionRef>
<RecordedAtTime>2022-04-14T09:17:26Z</RecordedAtTime>
<OwnerRef>ch:1:sboid:100626</OwnerRef>
<Perspective>atStopPoint</Perspective>
<Perspective>onBoardVehicle</Perspective>
<TextualContent>
<TextualContentSize>S</TextualContentSize>
<SummaryContent>
<SummaryText xml:lang="DE">Pratteln, Bahnhof verschoben</SummaryText>
<SummaryText xml:lang="EN">Pratteln, Bahnhof moved</SummaryText>
</SummaryContent>
<ReasonContent>
<ReasonText xml:lang="DE">Grund: Veranstaltung (ESAF)</ReasonText>
<ReasonText xml:lang="EN">Due to an event (ESAF)</ReasonText>
</ReasonContent>
<ConsequenceContent>
<ConsequenceText xml:lang="DE">Die Haltestelle ist verschoben an die Wasenstrasse</ConsequenceText>
<ConsequenceText xml:lang="EN">The bus stop has been moved to Wasenstrasse</ConsequenceText>
</ConsequenceContent>
<RecommendationContent>
<RecommendationText xml:lang="DE">Bitte folgen Sie der Signalisation für den Zugang zu den Gleisen</RecommendationText>
<RecommendationText xml:lang="EN">Please follow the signs to access the platforms</RecommendationText>
</RecommendationContent>
<DurationContent>
<DurationText xml:lang="DE">Dauer: 26.08.2022, 15:00 - 26.08.2022, 23:59</DurationText>
<DurationText xml:lang="EN">Duration: 26.08.2022, 15:00 - 26.08.2022, 23:59</DurationText>
</DurationContent>
<RemarkContent>
<Remark xml:lang="DE">Bei Fragen wenden Sie sich an das Informationspersonal vor Ort</Remark>
<Remark xml:lang="EN">If you have any questions, please contact the information staff on site</Remark>
</RemarkContent>
</TextualContent>
</PassengerInformationAction>
</PublishingAction>
</PublishingActions>
</PtSituationElement>
</Situations>
</SituationExchangeDelivery>
</ServiceDelivery>
</Siri>
Loading