-
Notifications
You must be signed in to change notification settings - Fork 0
/
OJP_StopEvents.xsd
243 lines (243 loc) · 10.5 KB
/
OJP_StopEvents.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XMLSpy v2015 rel. 3 sp1 (x64) (http://www.altova.com) by Jutta Schmedding (Mentz Datenverarbeitung GmbH) -->
<xs:schema xmlns="http://www.vdv.de/ojp" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:siri="http://www.siri.org.uk/siri" targetNamespace="http://www.vdv.de/ojp" elementFormDefault="qualified" attributeFormDefault="unqualified">
<!-- ===Dependencies ======================================= -->
<xs:import namespace="http://www.siri.org.uk/siri" schemaLocation="./siri_model/siri_modes-v1.1.xsd"/>
<!-- ===========================================================================================================-->
<xs:include schemaLocation="OJP_Common.xsd"/>
<xs:include schemaLocation="OJP_JourneySupport.xsd"/>
<xs:element name="StopEventRequest" type="StopEventRequestStructure">
<xs:annotation>
<xs:documentation>Request element for departure and arrival events at stops</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group name="StopEventRequestGroup">
<xs:annotation>
<xs:documentation>Request structure for departure and arrival events at stops</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Location" type="PlaceContextStructure">
<xs:annotation>
<xs:documentation>Location for which to obtain stop event information.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Params" type="StopEventParamStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Request parameter</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:complexType name="StopEventRequestStructure">
<xs:sequence>
<xs:group ref="StopEventRequestGroup"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="StopEventParamStructure">
<xs:annotation>
<xs:documentation>Request specific parameters (parameters which define what is to be included in a Stop Event result)</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:group ref="StopEventDataFilterGroup"/>
<xs:group ref="StopEventPolicyGroup"/>
<xs:group ref="StopEventContentFilterGroup"/>
</xs:sequence>
</xs:complexType>
<xs:group name="StopEventDataFilterGroup">
<xs:annotation>
<xs:documentation>Request data filters</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="PtModeFilter" type="PtModeFilterStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Modes to be considered in stop events.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LineFilter" type="LineDirectionFilterStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Lines/Directions to include/exclude.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OperatorFilter" type="OperatorFilterStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Transport operators to include/exclude.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:group name="StopEventPolicyGroup">
<xs:annotation>
<xs:documentation>Request policies</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="NumberOfResults" type="xs:positiveInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TimeWindow" type="xs:duration" minOccurs="0">
<xs:annotation>
<xs:documentation>Time window events should lie within. Starting from time given in LocationContext.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="StopEventType" type="StopEventTypeEnumeration" minOccurs="0">
<xs:annotation>
<xs:documentation>Only departures or arrivals or both.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:group name="StopEventContentFilterGroup">
<xs:annotation>
<xs:documentation>Content filters which data is expected in the response</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="IncludePreviousCalls" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether the previous calls of each vehicle journey should be included in the response.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="IncludeOnwardCalls" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether the onward calls of each vehicle journey should be included in the response.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="IncludeOperatingDays" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether operating day information of this stop event should be included in the response.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="IncludeRealtimeData" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether realtime information of this stop event should be included in the response.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:simpleType name="StopEventTypeEnumeration">
<xs:annotation>
<xs:documentation> Departure or arrival events or both</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="departure"/>
<xs:enumeration value="arrival"/>
<xs:enumeration value="both"/>
</xs:restriction>
</xs:simpleType>
<xs:annotation>
<xs:documentation>====================================================</xs:documentation>
</xs:annotation>
<xs:element name="StopEventResponse" type="StopEventResponseStructure">
<xs:annotation>
<xs:documentation>Response element for departure and arrival events at stops</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group name="StopEventResponseGroup">
<xs:annotation>
<xs:documentation>Response structure for departure and arrival events at stops</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="StopEventResponseContext" type="StopEventResponseContextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Container for data that is referenced multiple times.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="StopEventResult" type="StopEventResultStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Enclosing element for stop event data.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:complexType name="StopEventResponseStructure">
<xs:sequence>
<xs:element name="ErrorMessage" type="ErrorMessageStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Error messages that refer to the stop event response as a whole.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="StopEventResponseGroup"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="StopEventResultStructure">
<xs:annotation>
<xs:documentation>Wrapper element for a single stop event result.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="ResultId" type="xs:NMTOKEN">
<xs:annotation>
<xs:documentation>ID of this result.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ErrorMessage" type="ErrorMessageStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Error messages that refer to this stop event.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="StopEvent" type="StopEventStructure">
<xs:annotation>
<xs:documentation>Stop event data element.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="StopEventStructure">
<xs:annotation>
<xs:documentation>Stop event structure.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="PreviousCall" type="CallAtNearStopStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Calls at stops that happen before this stop event (service pattern of this vehicle journey before this stop event).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ThisCall" type="CallAtNearStopStructure">
<xs:annotation>
<xs:documentation>The call of this vehicle journey at this stop.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OnwardCall" type="CallAtNearStopStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Calls at stops that happen after this stop event (rest of the service pattern of the vehicle journey).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Service" type="DatedJourneyStructure">
<xs:annotation>
<xs:documentation>Service that calls at this stop.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="OperatingDaysGroup" minOccurs="0"/>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="StopEventResponseContextStructure">
<xs:annotation>
<xs:documentation>Stop event response context. May hold objects that are referenced several times.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="AbstractResponseContextStructure"/>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="CallAtNearStopStructure">
<xs:annotation>
<xs:documentation>indication of the walk distance and time to a nearby stop where relevant.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="CallAtStop" type="CallAtStopStructure">
<xs:annotation>
<xs:documentation>[same as CALL in SIRI] the meeting of a VEHICLE JOURNEY with a specific SCHEDULED STOP POINT .</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="WalkDistance" type="siri:DistanceType" minOccurs="0">
<xs:annotation>
<xs:documentation>Distance from request location (f.e. address) to this stop in metres.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="WalkDuration" type="xs:duration" minOccurs="0">
<xs:annotation>
<xs:documentation>Distance from request location (f.e. address) to this stop in seconds. All user options taken into account (f.e. walk speed).</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema>