Merge branch 'changes_for_v1.1' into Update_TripRefinement

# Conflicts: # docs/generated/index.html
VDVde · Jan 19, 2023 · c32b910 · c32b910
2 parents 6211fed + 0e21b03
commit c32b910
Show file tree

Hide file tree

Showing 9 changed files with 153 additions and 10 deletions.
diff --git a/OJP/OJP_All.xsd b/OJP/OJP_All.xsd
@@ -9,6 +9,7 @@
 	<xs:include schemaLocation="OJP_Fare.xsd"/>
 	<xs:include schemaLocation="OJP_FareSupport.xsd"/>
 	<xs:include schemaLocation="OJP_JourneySupport.xsd"/>
+	<xs:include schemaLocation="OJP_Lines.xsd"/>
 	<xs:include schemaLocation="OJP_ModesSupport.xsd"/>
 	<xs:include schemaLocation="OJP_Places.xsd"/>
 	<xs:include schemaLocation="OJP_PlaceSupport.xsd"/>

diff --git a/OJP/OJP_Common.xsd b/OJP/OJP_Common.xsd
@@ -47,14 +47,14 @@
 			</xs:element>
 		</xs:sequence>
 	</xs:complexType>
-	<xs:complexType name="LinkProjectionStructure">
+	<xs:complexType name="LinearShapeStructure">
 		<xs:annotation>
-			<xs:documentation>An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE.</xs:documentation>
+			<xs:documentation>An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="Position" type="siri:LocationStructure" minOccurs="2" maxOccurs="unbounded">
 				<xs:annotation>
-					<xs:documentation>Ordered list of locations representing the geogemtry of the link.</xs:documentation>
+					<xs:documentation>Ordered list of locations representing the geometry of the link or route.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 		</xs:sequence>

diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd
@@ -186,7 +186,7 @@
 	<xs:annotation>
 		<xs:documentation>========================================== Tickets ==========================================</xs:documentation>
 	</xs:annotation>
-	<xs:simpleType name="FareProductCodeType">
+	<xs:simpleType name="FareProductIdType">
 		<xs:annotation>
 			<xs:documentation>Identifier of a FareProduct</xs:documentation>
 		</xs:annotation>
@@ -197,7 +197,7 @@
 			<xs:documentation>Reference to a FareProduct.</xs:documentation>
 		</xs:annotation>
 		<xs:simpleContent>
-			<xs:extension base="FareProductCodeType"/>
+			<xs:extension base="FareProductIdType"/>
 		</xs:simpleContent>
 	</xs:complexType>
 	<xs:element name="FareProductRef" type="FareProductRefStructure">
@@ -255,20 +255,20 @@
 			<xs:documentation>[related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
-			<xs:element name="FareProductId" type="FareProductCodeType">
+			<xs:element name="FareProductId" type="FareProductIdType">
 				<xs:annotation>
-					<xs:documentation>Unique Id of the FareProduct.</xs:documentation>
+					<xs:documentation>Identifier of a FareProduct</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="FareProductName" type="xs:string">
 				<xs:annotation>
-					<xs:documentation>printable FareProduct name</xs:documentation>
+					<xs:documentation>Printable FareProduct name</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:group ref="FareAuthorityGroup"/>
 			<xs:element name="ProtoProduct" type="xs:boolean" default="false" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/</xs:documentation>
+					<xs:documentation>Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:group ref="FareProductPriceGroup"/>

diff --git a/OJP/OJP_JourneySupport.xsd b/OJP/OJP_JourneySupport.xsd
@@ -684,7 +684,7 @@
 					<xs:documentation>End place of this track.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
-			<xs:element name="LinkProjection" type="LinkProjectionStructure" minOccurs="0">
+			<xs:element name="LinkProjection" type="LinearShapeStructure" minOccurs="0">
 				<xs:annotation>
 					<xs:documentation>An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE.</xs:documentation>
 				</xs:annotation>

diff --git a/OJP/OJP_Lines.xsd b/OJP/OJP_Lines.xsd
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns="http://www.vdv.de/ojp" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:siri="http://www.siri.org.uk/siri" xmlns:gml="http://www.opengis.net/gml/3.2" targetNamespace="http://www.vdv.de/ojp" elementFormDefault="qualified" attributeFormDefault="unqualified" id="OJP_siri_service">
+	<xs:annotation>
+		<xs:documentation>OJP/OJP_Lines.xsd - Request and response definitions for information on lines</xs:documentation>
+	</xs:annotation>
+	<xs:import namespace="http://www.siri.org.uk/siri" schemaLocation="../siri/siri_model/siri_all-v2.0.xsd"/>
+	<xs:include schemaLocation="OJP_All.xsd"/>
+	<xs:annotation>
+		<xs:documentation>=============================== Line Information Service ==========================================</xs:documentation>
+	</xs:annotation>
+	<xs:annotation>
+		<xs:documentation>=============================== Line Information Response Group ==========================================</xs:documentation>
+	</xs:annotation>
+	<xs:group name="LineInformationResponseGroup">
+		<xs:annotation>
+			<xs:documentation>Line Information response group.</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element name="LineResult" type="LineResultStructure" minOccurs="0" maxOccurs="unbounded"/>
+		</xs:sequence>
+	</xs:group>
+	<xs:annotation>
+		<xs:documentation>=============================== LineInformation support functions ==========================================</xs:documentation>
+	</xs:annotation>
+	<xs:complexType name="LineResultStructure">
+		<xs:sequence>
+			<xs:element name="LineRef" type="siri:LineRefStructure">
+				<xs:annotation>
+					<xs:documentation>Reference to the LINE.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element ref="siri:PublishedLineName" minOccurs="0"/>
+			<xs:element name="DirectionRef" type="siri:DirectionRefStructure" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>DIRECTION of LINE.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="RouteGeometry" type="LinearShapeStructure" minOccurs="0" maxOccurs="unbounded">
+				<xs:annotation>
+					<xs:documentation>The LINE's route geometry. A line can have multiple ROUTEs and each has its own geometry. The first should be the "main" geometry.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="Mode" type="ModeStructure" minOccurs="0" maxOccurs="unbounded">
+				<xs:annotation>
+					<xs:documentation>List of transport modes that are supported by this line.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+		</xs:sequence>
+	</xs:complexType>
+</xs:schema>
diff --git a/OJP/OJP_Requests.xsd b/OJP/OJP_Requests.xsd
@@ -247,4 +247,30 @@
 			</xs:extension>
 		</xs:complexContent>
 	</xs:complexType>
+	<xs:annotation>
+		<xs:documentation>========================================== Line Information Service ==========================================</xs:documentation>
+	</xs:annotation>
+	<xs:element name="OJPLineInformationRequest" type="OJPLineInformationRequestStructure" substitutionGroup="siri:AbstractFunctionalServiceRequest"/>
+	<xs:complexType name="OJPLineInformationRequestStructure">
+		<xs:complexContent>
+			<xs:extension base="AbstractOJPServiceRequestStructure">
+				<xs:sequence>
+					<xs:element name="LineDirectionFilter" type="LineDirectionFilterStructure" minOccurs="0"/>
+					<xs:element ref="siri:Extensions" minOccurs="0"/>
+				</xs:sequence>
+			</xs:extension>
+		</xs:complexContent>
+	</xs:complexType>
+	<xs:element name="OJPLineInformationDelivery" type="OJPLineInformationDeliveryStructure" substitutionGroup="siri:AbstractFunctionalServiceDelivery"/>
+	<xs:complexType name="OJPLineInformationDeliveryStructure">
+		<xs:complexContent>
+			<xs:extension base="siri:AbstractServiceDeliveryStructure">
+				<xs:sequence>
+					<xs:element ref="OJPLineInformationRequest" minOccurs="0"/>
+					<xs:group ref="LineInformationResponseGroup"/>
+					<xs:element ref="siri:Extensions" minOccurs="0"/>
+				</xs:sequence>
+			</xs:extension>
+		</xs:complexContent>
+	</xs:complexType>
 </xs:schema>
diff --git a/docs/schema-collection.xml b/docs/schema-collection.xml
@@ -8,6 +8,7 @@
 	<xi:include href="../OJP/OJP_RequestSupport.xsd"/>
 	<xi:include href="../OJP/OJP_Fare.xsd"/>
 	<xi:include href="../OJP/OJP_FareSupport.xsd"/>
+	<xi:include href="../OJP/OJP_Lines.xsd"/>
 	<xi:include href="../OJP/OJP_Places.xsd"/>
 	<xi:include href="../OJP/OJP_PlaceSupport.xsd"/>
 	<xi:include href="../OJP/OJP_StopEvents.xsd"/>

diff --git a/examples/functions/LineRequest.xml b/examples/functions/LineRequest.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siri.org.uk/siri" xmlns:ojp="http://www.vdv.de/ojp" version="1.1-dev" xsi:schemaLocation="http://www.siri.org.uk/siri ../../OJP.xsd">
+	<OJPRequest>
+		<ServiceRequest>
+			<RequestTimestamp>2022-12-19T12:00:00Z</RequestTimestamp>
+			<RequestorRef>IRMA</RequestorRef>
+			<ojp:OJPLineInformationRequest>
+				<RequestTimestamp>2022-12-19T12:00:00Z</RequestTimestamp>
+				<MessageIdentifier>4711</MessageIdentifier>
+				<ojp:LineDirectionFilter>
+					<ojp:Line>
+						<LineRef>ch:1:slnid:129312</LineRef>
+						<DirectionRef>ch:1:Direction:H</DirectionRef>
+					</ojp:Line>
+					<ojp:Exclude>false</ojp:Exclude>
+				</ojp:LineDirectionFilter>
+			</ojp:OJPLineInformationRequest>
+		</ServiceRequest>
+	</OJPRequest>
+</OJP>
diff --git a/examples/functions/LineResponse.xml b/examples/functions/LineResponse.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<siri:OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:siri="http://www.siri.org.uk/siri" xmlns:ojp="http://www.vdv.de/ojp" version="1.1-dev" xsi:schemaLocation="http://www.siri.org.uk/siri ../../OJP.xsd">
+	<siri:OJPResponse>
+		<siri:ServiceDelivery>
+			<siri:ResponseTimestamp>2022-12-01T17:54:38Z</siri:ResponseTimestamp>
+			<siri:ProducerRef>OJPCH_Prod</siri:ProducerRef>
+			<siri:Status>true</siri:Status>
+			<ojp:OJPLineInformationDelivery>
+				<siri:ResponseTimestamp>2022-12-01T17:54:38Z</siri:ResponseTimestamp>
+				<siri:RequestMessageRef>4711</siri:RequestMessageRef>
+				<siri:Status>true</siri:Status>
+				<!-- no CalcTime for this service <ojp:CalcTime>20</ojp:CalcTime> -->
+				<ojp:LineResult>
+					<ojp:LineRef>ch:slnid:123123</ojp:LineRef>
+					<siri:PublishedLineName>IC8</siri:PublishedLineName>
+					<ojp:RouteGeometry>
+						<ojp:Position>
+							<siri:Longitude>7.48464</siri:Longitude>
+							<siri:Latitude>46.93150</siri:Latitude>
+						</ojp:Position>
+						<ojp:Position>
+							<siri:Longitude>7.48447</siri:Longitude>
+							<siri:Latitude>46.93141</siri:Latitude>
+						</ojp:Position>
+						<ojp:Position>
+							<siri:Longitude>7.48441</siri:Longitude>
+							<siri:Latitude>46.93138</siri:Latitude>
+						</ojp:Position>
+						<ojp:Position>
+							<siri:Longitude>7.48437</siri:Longitude>
+							<siri:Latitude>46.93134</siri:Latitude>
+						</ojp:Position>
+					</ojp:RouteGeometry>
+					<ojp:Mode>
+						<ojp:PtMode>rail</ojp:PtMode>
+						<siri:RailSubmode>longDistanceTrain</siri:RailSubmode>
+						<ojp:Name>
+							<ojp:Text>Intercity</ojp:Text>
+						</ojp:Name>
+					</ojp:Mode>
+				</ojp:LineResult>
+			</ojp:OJPLineInformationDelivery>
+		</siri:ServiceDelivery>
+	</siri:OJPResponse>
+</siri:OJP>