Skip to content

Commit ea8080e

Browse files
haeckerbaerhaeckerbaer
authored
Add new element Period in PassengerInformationActionStructure (#190)
* add new element ActionPeriod in PassengerInformationAction * Lint and update documentation tables * harmonize element name and update annotation * add example showcasing Period on PassengerInformationAction level * simplify example * fix validation errors in sx esaf example * rename action period to match schema * add comment describing difference between the two ESAF examples * add second ESAF example without new period feature
1 parent 65250d5 commit ea8080e

4 files changed

Lines changed: 420 additions & 0 deletions

File tree

‎docs/generated/contab/siri.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201313,6 +201313,30 @@ <h3>28.27. The complex type <code>siri:PassengerInformationActionStructure</code
201313201313
<p class="tableblock darkbrown">Reference to the action number within the incident concept.</p>
201314201314
</td>
201315201315
</tr>
201316+
<tr>
201317+
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
201318+
<a shape="rect" href="" title=""/>
201319+
</td>
201320+
<td colspan="2" rowspan="1" class="tableblock halign-left valign-top">
201321+
<p class="tableblock">
201322+
<code>siri:ActionPeriod</code>
201323+
</p>
201324+
</td>
201325+
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
201326+
<p class="tableblock">
201327+
<span title="optional, multiple">0:*</span>
201328+
</p>
201329+
</td>
201330+
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
201331+
<p class="tableblock">
201332+
<em>+<a shape="rect" href="#type.siri:HalfOpenTimestampOutputRangeStructure" title="siri:HalfOpenTimestampOutputRangeStructure">siri:HalfOpenTimestampOutputRangeStructure</a>
201333+
</em>
201334+
</p>
201335+
</td>
201336+
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
201337+
<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>
201338+
</td>
201339+
</tr>
201316201340
<tr>
201317201341
<td colspan="1" rowspan="1" class="tableblock halign-left valign-top">
201318201342
<a shape="rect" href="" title=""/>

‎examples/siri_exm_SX/VDV736_exm/SX_ESAF_example.xml‎

Lines changed: 234 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,234 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.3">
3+
<ServiceDelivery>
4+
<ResponseTimestamp>2022-04-14T09:17:32Z</ResponseTimestamp>
5+
<ProducerRef>ski-ems-out-sx_tesst</ProducerRef>
6+
<ResponseMessageIdentifier>wcP9TgJhf</ResponseMessageIdentifier>
7+
<Status>true</Status>
8+
<MoreData>false</MoreData>
9+
<SituationExchangeDelivery version="2.3">
10+
<ResponseTimestamp>2022-04-14T09:17:32Z</ResponseTimestamp>
11+
<SubscriberRef>ski-ddip-in-sx_test</SubscriberRef>
12+
<SubscriptionRef>1</SubscriptionRef>
13+
<Situations>
14+
<PtSituationElement>
15+
<CreationTime>2022-04-14T09:17:23Z</CreationTime>
16+
<CountryRef>ch</CountryRef>
17+
<ParticipantRef>ski-ems-out-sx_test</ParticipantRef>
18+
<SituationNumber>ch:1:sstid:1:3ac880a2-aeb1-5757-989d-d3c15c8220c6</SituationNumber>
19+
<Version>1</Version>
20+
<Source>
21+
<Country>ch</Country>
22+
<SourceType>directReport</SourceType>
23+
<Name>EMS</Name>
24+
<ExternalCode>ski-ems-out-sx_test</ExternalCode>
25+
</Source>
26+
<VersionedAtTime>2022-04-14T09:17:26Z</VersionedAtTime>
27+
<Progress>published</Progress>
28+
<ValidityPeriod>
29+
<StartTime>2022-08-26T04:00:00Z</StartTime>
30+
<EndTime>2022-08-26T21:00:00Z</EndTime>
31+
</ValidityPeriod>
32+
<PublicationWindow>
33+
<StartTime>2022-04-14T09:17:23Z</StartTime>
34+
<EndTime>2022-08-26T21:59:00Z</EndTime>
35+
</PublicationWindow>
36+
<AlertCause>specialEvent</AlertCause>
37+
<Severity>normal</Severity>
38+
<Priority>3</Priority>
39+
<Audience>public</Audience>
40+
<ScopeType>stopPlace</ScopeType>
41+
<Planned>true</Planned>
42+
<Language>DE</Language>
43+
<Summary xml:lang="DE">Haltestelle Pratteln, Bahnhof verschoben.</Summary>
44+
<Summary xml:lang="EN">Pratteln, Bahnhof stop moved.</Summary>
45+
<Detail xml:lang="DE">Grund ist eine Veranstaltung.</Detail>
46+
<Detail xml:lang="EN">Due to an event.</Detail>
47+
<Affects>
48+
<StopPlaces>
49+
<AffectedStopPlace>
50+
<StopPlaceRef>ch:1:sloid:94994</StopPlaceRef>
51+
<PlaceName>Pratteln, Bahnhof</PlaceName>
52+
</AffectedStopPlace>
53+
</StopPlaces>
54+
</Affects>
55+
<PublishingActions>
56+
<PublishingAction>
57+
<PublishAtScope>
58+
<ScopeType>stopPlace</ScopeType>
59+
<Affects>
60+
<StopPlaces>
61+
<AffectedStopPlace>
62+
<StopPlaceRef>ch:1:sloid:94994</StopPlaceRef>
63+
<PlaceName>Pratteln, Bahnhof</PlaceName>
64+
</AffectedStopPlace>
65+
</StopPlaces>
66+
</Affects>
67+
</PublishAtScope>
68+
<PassengerInformationAction>
69+
<PublicationWindow>
70+
<StartTime>2022-04-14T09:17:23Z</StartTime>
71+
<EndTime>2022-08-26T21:59:00Z</EndTime>
72+
</PublicationWindow>
73+
<ActionRef>ems-696-1</ActionRef>
74+
<!--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.-->
75+
<Period>
76+
<StartTime>2022-08-26T04:00:00Z</StartTime>
77+
<EndTime>2022-08-26T12:00:00Z</EndTime>
78+
</Period>
79+
<RecordedAtTime>2022-04-14T09:17:26Z</RecordedAtTime>
80+
<OwnerRef>ch:1:sboid:100626</OwnerRef>
81+
<Perspective>whilePlanningTrip</Perspective>
82+
<TextualContent>
83+
<TextualContentSize>S</TextualContentSize>
84+
<SummaryContent>
85+
<SummaryText xml:lang="DE">Pratteln, Bahnhof verschoben</SummaryText>
86+
<SummaryText xml:lang="EN">Pratteln, Bahnhof moved</SummaryText>
87+
</SummaryContent>
88+
<ReasonContent>
89+
<ReasonText xml:lang="DE">Grund: Veranstaltung (ESAF)</ReasonText>
90+
<ReasonText xml:lang="EN">Due to an event (ESAF)</ReasonText>
91+
</ReasonContent>
92+
<ConsequenceContent>
93+
<ConsequenceText xml:lang="DE">Die Haltestelle ist verschoben um 500 Meter Richtung Altstadt</ConsequenceText>
94+
<ConsequenceText xml:lang="EN">The bus stop has been moved by 500 meters in the direction of the old town</ConsequenceText>
95+
</ConsequenceContent>
96+
<RecommendationContent>
97+
<RecommendationText xml:lang="DE">Bitte benutzen Sie die provisorische Haltestelle Pratteln, Bahnhof (Richtung Festgelände)</RecommendationText>
98+
<RecommendationText xml:lang="EN">Please use the temporary stop Pratteln, Bahnhof (direction Festgelände)</RecommendationText>
99+
</RecommendationContent>
100+
<DurationContent>
101+
<DurationText xml:lang="DE">Dauer: 26.08.2022, 06:00 - 26.08.2022, 14:00</DurationText>
102+
<DurationText xml:lang="EN">Duration: 26.08.2022, 06:00 - 26.08.2022, 14:00</DurationText>
103+
</DurationContent>
104+
<RemarkContent>
105+
<Remark xml:lang="DE">Bei Fragen wenden Sie sich an das Informationspersonal vor Ort</Remark>
106+
<Remark xml:lang="EN">If you have any questions, please contact the information staff on site</Remark>
107+
</RemarkContent>
108+
</TextualContent>
109+
</PassengerInformationAction>
110+
<PassengerInformationAction>
111+
<PublicationWindow>
112+
<StartTime>2022-04-14T09:17:26Z</StartTime>
113+
<EndTime>2022-08-28T21:59:00Z</EndTime>
114+
</PublicationWindow>
115+
<ActionRef>ems-696-2</ActionRef>
116+
<!--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.-->
117+
<Period>
118+
<StartTime>2022-08-26T13:00:00Z</StartTime>
119+
<EndTime>2022-08-26T21:00:00Z</EndTime>
120+
</Period>
121+
<RecordedAtTime>2022-04-14T09:17:26Z</RecordedAtTime>
122+
<OwnerRef>ch:1:sboid:100626</OwnerRef>
123+
<Perspective>whilePlanningTrip</Perspective>
124+
<TextualContent>
125+
<TextualContentSize>S</TextualContentSize>
126+
<SummaryContent>
127+
<SummaryText xml:lang="DE">Pratteln, Bahnhof verschoben</SummaryText>
128+
<SummaryText xml:lang="EN">Pratteln, Bahnhof moved</SummaryText>
129+
</SummaryContent>
130+
<ReasonContent>
131+
<ReasonText xml:lang="DE">Grund: Veranstaltung (ESAF)</ReasonText>
132+
<ReasonText xml:lang="EN">Due to an event (ESAF)</ReasonText>
133+
</ReasonContent>
134+
<ConsequenceContent>
135+
<ConsequenceText xml:lang="DE">Die Haltestelle ist verschoben an die Wasenstrasse</ConsequenceText>
136+
<ConsequenceText xml:lang="EN">The bus stop has been moved to Wasenstrasse</ConsequenceText>
137+
</ConsequenceContent>
138+
<RecommendationContent>
139+
<RecommendationText xml:lang="DE">Bitte folgen Sie der Signalisation für den Zugang zu den Gleisen</RecommendationText>
140+
<RecommendationText xml:lang="EN">Please follow the signs to access the platforms</RecommendationText>
141+
</RecommendationContent>
142+
<DurationContent>
143+
<DurationText xml:lang="DE">Dauer: 26.08.2022, 15:00 - 26.08.2022, 23:00</DurationText>
144+
<DurationText xml:lang="EN">Duration: 26.08.2022, 15:00 - 26.08.2022, 23:00</DurationText>
145+
</DurationContent>
146+
<RemarkContent>
147+
<Remark xml:lang="DE">Bei Fragen wenden Sie sich an das Informationspersonal vor Ort</Remark>
148+
<Remark xml:lang="EN">If you have any questions, please contact the information staff on site</Remark>
149+
</RemarkContent>
150+
</TextualContent>
151+
</PassengerInformationAction>
152+
<PassengerInformationAction>
153+
<PublicationWindow>
154+
<StartTime>2022-08-26T02:00:00Z</StartTime>
155+
<EndTime>2022-08-26T12:00:00Z</EndTime>
156+
</PublicationWindow>
157+
<ActionRef>ems-696-3</ActionRef>
158+
<RecordedAtTime>2022-04-14T09:17:26Z</RecordedAtTime>
159+
<OwnerRef>ch:1:sboid:100626</OwnerRef>
160+
<Perspective>atStopPoint</Perspective>
161+
<Perspective>onBoardVehicle</Perspective>
162+
<TextualContent>
163+
<TextualContentSize>S</TextualContentSize>
164+
<SummaryContent>
165+
<SummaryText xml:lang="DE">Pratteln, Bahnhof verschoben</SummaryText>
166+
<SummaryText xml:lang="EN">Pratteln, Bahnhof moved</SummaryText>
167+
</SummaryContent>
168+
<ReasonContent>
169+
<ReasonText xml:lang="DE">Grund: Veranstaltung (ESAF)</ReasonText>
170+
<ReasonText xml:lang="EN">Due to an event (ESAF)</ReasonText>
171+
</ReasonContent>
172+
<ConsequenceContent>
173+
<ConsequenceText xml:lang="DE">Die Haltestelle ist verschoben um 500 Meter Richtung Altstadt</ConsequenceText>
174+
<ConsequenceText xml:lang="EN">The bus stop has been moved by 500 meters in the direction of the old town</ConsequenceText>
175+
</ConsequenceContent>
176+
<RecommendationContent>
177+
<RecommendationText xml:lang="DE">Bitte benutzen Sie die provisorische Haltestelle Pratteln, Bahnhof (Richtung Festgelände)</RecommendationText>
178+
<RecommendationText xml:lang="EN">Please use the temporary stop Pratteln, Bahnhof (direction Festgelände)</RecommendationText>
179+
</RecommendationContent>
180+
<DurationContent>
181+
<DurationText xml:lang="DE">Dauer: 26.08.2022, 04:00 - 26.08.2022, 14:00</DurationText>
182+
<DurationText xml:lang="EN">Duration: 26.08.2022, 04:00 - 26.08.2022, 14:00</DurationText>
183+
</DurationContent>
184+
<RemarkContent>
185+
<Remark xml:lang="DE">Bei Fragen wenden Sie sich an das Informationspersonal vor Ort</Remark>
186+
<Remark xml:lang="EN">If you have any questions, please contact the information staff on site</Remark>
187+
</RemarkContent>
188+
</TextualContent>
189+
</PassengerInformationAction>
190+
<PassengerInformationAction>
191+
<PublicationWindow>
192+
<StartTime>2022-08-26T13:00:00Z</StartTime>
193+
<EndTime>2022-08-26T21:59:00Z</EndTime>
194+
</PublicationWindow>
195+
<ActionRef>ems-696-6</ActionRef>
196+
<RecordedAtTime>2022-04-14T09:17:26Z</RecordedAtTime>
197+
<OwnerRef>ch:1:sboid:100626</OwnerRef>
198+
<Perspective>atStopPoint</Perspective>
199+
<Perspective>onBoardVehicle</Perspective>
200+
<TextualContent>
201+
<TextualContentSize>S</TextualContentSize>
202+
<SummaryContent>
203+
<SummaryText xml:lang="DE">Pratteln, Bahnhof verschoben</SummaryText>
204+
<SummaryText xml:lang="EN">Pratteln, Bahnhof moved</SummaryText>
205+
</SummaryContent>
206+
<ReasonContent>
207+
<ReasonText xml:lang="DE">Grund: Veranstaltung (ESAF)</ReasonText>
208+
<ReasonText xml:lang="EN">Due to an event (ESAF)</ReasonText>
209+
</ReasonContent>
210+
<ConsequenceContent>
211+
<ConsequenceText xml:lang="DE">Die Haltestelle ist verschoben an die Wasenstrasse</ConsequenceText>
212+
<ConsequenceText xml:lang="EN">The bus stop has been moved to Wasenstrasse</ConsequenceText>
213+
</ConsequenceContent>
214+
<RecommendationContent>
215+
<RecommendationText xml:lang="DE">Bitte folgen Sie der Signalisation für den Zugang zu den Gleisen</RecommendationText>
216+
<RecommendationText xml:lang="EN">Please follow the signs to access the platforms</RecommendationText>
217+
</RecommendationContent>
218+
<DurationContent>
219+
<DurationText xml:lang="DE">Dauer: 26.08.2022, 15:00 - 26.08.2022, 23:59</DurationText>
220+
<DurationText xml:lang="EN">Duration: 26.08.2022, 15:00 - 26.08.2022, 23:59</DurationText>
221+
</DurationContent>
222+
<RemarkContent>
223+
<Remark xml:lang="DE">Bei Fragen wenden Sie sich an das Informationspersonal vor Ort</Remark>
224+
<Remark xml:lang="EN">If you have any questions, please contact the information staff on site</Remark>
225+
</RemarkContent>
226+
</TextualContent>
227+
</PassengerInformationAction>
228+
</PublishingAction>
229+
</PublishingActions>
230+
</PtSituationElement>
231+
</Situations>
232+
</SituationExchangeDelivery>
233+
</ServiceDelivery>
234+
</Siri>

0 commit comments

Comments
 (0)