Skip to content
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.

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

rebuild usage of realtime information #259

Merged
merged 19 commits into from
Jan 20, 2023
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
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
23 changes: 21 additions & 2 deletions OJP/OJP_JourneySupport.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,25 @@
</xs:element>
</xs:sequence>
</xs:group>
<xs:simpleType name="UseRealtimeDataEnumeration">
<xs:restriction base="xs:string">
<xs:enumeration value="full">
<xs:annotation>
<xs:documentation>Full use of real-time information, including removal of SERVICE JOURNEYS.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="explanatory">
<xs:annotation>
<xs:documentation>Cancelled and delayed SERVICE JOURNEYs are still returned, but an additional explanatory textual information is provide to decribe their current real-time status.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="none">
<xs:annotation>
<xs:documentation>Only based on timetable data</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:group name="BaseTripPolicyGroup">
<xs:annotation>
<xs:documentation>Policies that control the trip search behaviour for both public and individual transport.</xs:documentation>
Expand All @@ -544,9 +563,9 @@
</xs:element>
<xs:group ref="NumberOfResultsGroup" minOccurs="0"/>
</xs:choice>
<xs:element name="IgnoreRealtimeData" type="xs:boolean" default="false" minOccurs="0">
<xs:element name="UseRealtimeData" type="UseRealtimeDataEnumeration" default="full" minOccurs="0">
<xs:annotation>
<xs:documentation>The trip calculation should not use any realtime or incident data.</xs:documentation>
<xs:documentation>The way real-time data should be used in the calculation of the trip.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ImmediateTripStart" type="xs:boolean" default="false" minOccurs="0">
Expand Down
4 changes: 2 additions & 2 deletions OJP/OJP_StopEvents.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,9 @@
<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:element name="UseRealtimeData" type="UseRealtimeDataEnumeration" default="full" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether realtime information of this stop event should be included in the response.</xs:documentation>
<xs:documentation>Whether real-time information of this stop event should be used in the response. Default is "full"</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="IncludePlacesContext" type="xs:boolean" default="true" minOccurs="0">
Expand Down
9 changes: 7 additions & 2 deletions OJP/OJP_TripInfo.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@
<xs:documentation>Parameters that control the response behaviour.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="UseTimetabledDataOnly" type="xs:boolean" default="false" minOccurs="0">
<xs:element name="UseRealTimeData" type="UseRealtimeDataEnumeration" default="full" minOccurs="0">
<xs:annotation>
<xs:documentation>Do not show any realtime or incident data. Default is false.</xs:documentation>
<xs:documentation>Use real-time data. Default is "full"</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand Down Expand Up @@ -175,6 +175,11 @@
<xs:documentation>No geographic information available for this vehicle journey.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="TRIPINFO_NOREALTIME">
<xs:annotation>
<xs:documentation>No real-time information available.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="TRIPINFO_OTHER">
<xs:annotation>
<xs:documentation>A problem has occurred that does not have a specific problem type.</xs:documentation>
Expand Down
5 changes: 5 additions & 0 deletions OJP/OJP_Trips.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -1077,6 +1077,11 @@
<xs:documentation>Refers to a leg to be refined by the server.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="UseRealtimeData" type="UseRealtimeDataEnumeration" default="full" minOccurs="0">
<xs:annotation>
<xs:documentation>Usage of real-time data in refinement. Default is "full".</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="TripContentFilterGroup"/>
<xs:element name="FareParam" type="FareParamStructure" minOccurs="0">
<xs:annotation>
Expand Down
Loading