Merge branch 'changes_for_v1.1' into Operators_updated

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

Hide file tree

Showing 16 changed files with 788 additions and 17 deletions.
diff --git a/OJP/OJP_All.xsd b/OJP/OJP_All.xsd
@@ -3,11 +3,13 @@
 	<xs:annotation>
 		<xs:documentation>OJP/OJP_All.xsd - Includes for all OJP schema files</xs:documentation>
 	</xs:annotation>
+	<xs:include schemaLocation="OJP_Availability.xsd"/>
 	<xs:include schemaLocation="OJP_Common.xsd"/>
 	<xs:include schemaLocation="OJP_FacilitySupport.xsd"/>
 	<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_Availability.xsd b/OJP/OJP_Availability.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
@@ -688,7 +688,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
@@ -221,4 +221,56 @@
 			</xs:extension>
 		</xs:complexContent>
 	</xs:complexType>
+	<xs:annotation>
+		<xs:documentation>========================================== Availability Request ==========================================</xs:documentation>
+	</xs:annotation>
+	<xs:element name="OJPAvailabilityRequest" type="OJPAvailabilityRequestStructure" substitutionGroup="siri:AbstractFunctionalServiceRequest"/>
+	<xs:complexType name="OJPAvailabilityRequestStructure">
+		<xs:complexContent>
+			<xs:extension base="AbstractOJPServiceRequestStructure">
+				<xs:sequence>
+					<xs:group ref="AvailabilityRequestGroup"/>
+					<xs:element ref="siri:Extensions" minOccurs="0"/>
+				</xs:sequence>
+			</xs:extension>
+		</xs:complexContent>
+	</xs:complexType>
+	<xs:element name="OJPAvailabilityDelivery" type="OJPAvailabilityDeliveryStructure" substitutionGroup="siri:AbstractFunctionalServiceDelivery"/>
+	<xs:complexType name="OJPAvailabilityDeliveryStructure">
+		<xs:complexContent>
+			<xs:extension base="siri:AbstractServiceDeliveryStructure">
+				<xs:sequence>
+					<xs:group ref="ServiceResponseContextGroup"/>
+					<xs:group ref="AvailabilityResponseGroup"/>
+					<xs:element ref="siri:Extensions" minOccurs="0"/>
+				</xs:sequence>
+			</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/OJP/OJP_Utility.xsd b/OJP/OJP_Utility.xsd
@@ -48,6 +48,12 @@
 		</xs:annotation>
 		<xs:restriction base="xs:normalizedString"/>
 	</xs:simpleType>
+	<xs:simpleType name="EMailAddressType">
+		<xs:annotation>
+			<xs:documentation>Type definition for e-mail addresses.</xs:documentation>
+		</xs:annotation>
+		<xs:restriction base="xs:normalizedString"/>
+	</xs:simpleType>
 	<xs:complexType name="InternationalTextStructure">
 		<xs:annotation>
 			<xs:documentation>[a restricted view of ALTERNATIVE NAME in TMv6] alternative identified text to be used in specified languages.</xs:documentation>

diff --git a/docs/schema-collection.xml b/docs/schema-collection.xml
@@ -1,19 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <schema-collection xmlns:xi="http://www.w3.org/2001/XInclude">
+	<!--
+		The order of includes defines the order in the generated documentation
+	-->
 	<xi:include href="../OJP.xsd"/>
-	<xi:include href="../OJP/OJP_Common.xsd"/>
-	<xi:include href="../OJP/OJP_FacilitySupport.xsd"/>
+	<xi:include href="../OJP/OJP_Requests.xsd"/>
+	<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_JourneySupport.xsd"/>
-	<xi:include href="../OJP/OJP_ModesSupport.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_Requests.xsd"/>
-	<xi:include href="../OJP/OJP_RequestSupport.xsd"/>
-	<xi:include href="../OJP/OJP_SituationSupport.xsd"/>
 	<xi:include href="../OJP/OJP_StopEvents.xsd"/>
 	<xi:include href="../OJP/OJP_TripInfo.xsd"/>
 	<xi:include href="../OJP/OJP_Trips.xsd"/>
+	<xi:include href="../OJP/OJP_JourneySupport.xsd"/>
+	<xi:include href="../OJP/OJP_Availability.xsd"/>
+	<xi:include href="../OJP/OJP_Common.xsd"/>
+	<xi:include href="../OJP/OJP_FacilitySupport.xsd"/>
+	<xi:include href="../OJP/OJP_ModesSupport.xsd"/>
+	<xi:include href="../OJP/OJP_SituationSupport.xsd"/>
 	<xi:include href="../OJP/OJP_Utility.xsd"/>
 </schema-collection>
diff --git a/examples/function/OJPAvailabilityRequest.xml b/examples/function/OJPAvailabilityRequest.xml
@@ -0,0 +1,70 @@
+<?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>2020-01-19T12:00:00Z</RequestTimestamp>
+			<RequestorRef>MyClient</RequestorRef>
+			<ojp:OJPAvailabilityRequest>
+				<RequestTimestamp>2020-01-19T12:00:00Z</RequestTimestamp>
+				<MessageIdentifier>231231-231</MessageIdentifier>
+				<ojp:PublicTransport>
+					<ojp:PickUpLocation>
+						<ojp:CallPlace>
+							<ojp:StopPlaceRef>ch:1:sloid:7000</ojp:StopPlaceRef>
+							<ojp:Name>
+								<ojp:Text>origin</ojp:Text>
+							</ojp:Name>
+						</ojp:CallPlace>
+						<ojp:Order>7</ojp:Order>
+					</ojp:PickUpLocation>
+					<ojp:SetDownLocation>
+						<ojp:CallPlace>
+							<ojp:GeoPosition>
+								<Longitude>20.12121</Longitude>
+								<Latitude>30.134123</Latitude>
+								<Precision>20</Precision>
+							</ojp:GeoPosition>
+							<ojp:Name>
+								<ojp:Text>destiniation</ojp:Text>
+							</ojp:Name>
+							<ojp:AllowedSystemId>sbb</ojp:AllowedSystemId>
+						</ojp:CallPlace>
+						<ojp:ServiceArrival>
+							<ojp:TimetabledTime>2022-10-19T12:00:00Z</ojp:TimetabledTime>
+							<ojp:EstimatedTimeLow>2022-10-19T11:55:00Z</ojp:EstimatedTimeLow>
+							<ojp:EstimatedTimeHigh>2022-10-19T12:10:00Z</ojp:EstimatedTimeHigh>
+						</ojp:ServiceArrival>
+						<ojp:Order>10</ojp:Order>
+						<ojp:RequestStop>true</ojp:RequestStop>
+						<ojp:UnplannedStop>false</ojp:UnplannedStop>
+						<ojp:NotServicedStop>false</ojp:NotServicedStop>
+					</ojp:SetDownLocation>
+					<LineRef>ch:1:slnid:102301231</LineRef>
+					<ojp:Mode>
+						<ojp:PtMode>bus</ojp:PtMode>
+						<BusSubmode>demandAndResponseBus</BusSubmode>
+					</ojp:Mode>
+					<ojp:ProductCategory>
+						<ojp:ProductCategoryRef>NB</ojp:ProductCategoryRef>
+					</ojp:ProductCategory>
+					<ojp:PublishedServiceName>
+						<ojp:Text>NB 1</ojp:Text>
+					</ojp:PublishedServiceName>
+					<VehicleRef>1293912-1231</VehicleRef>
+					<ojp:OperatorRef>ch:1:sboid:13123</ojp:OperatorRef>
+				</ojp:PublicTransport>
+				<ojp:MobilityUser>
+					<ojp:Age>19</ojp:Age>
+					<ojp:WheelchairUser>true</ojp:WheelchairUser>
+					<ojp:NoSingleStep>true</ojp:NoSingleStep>
+					<ojp:NoStairs>true</ojp:NoStairs>
+					<ojp:LevelEntrance>true</ojp:LevelEntrance>
+					<ojp:WalkSpeed>70</ojp:WalkSpeed>
+					<ojp:AdditionalTransferTime>PT2M</ojp:AdditionalTransferTime>
+				</ojp:MobilityUser>
+				<ojp:EarliestDepartureTime>2022-10-19T11:30:00Z</ojp:EarliestDepartureTime>
+				<ojp:LatestArrivalTime>2022-10-19T12:10:00Z</ojp:LatestArrivalTime>
+			</ojp:OJPAvailabilityRequest>
+		</ServiceRequest>
+	</OJPRequest>
+</OJP>
diff --git a/examples/function/OJPAvailabilityRequest_1.xml b/examples/function/OJPAvailabilityRequest_1.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ojp:OJPAvailabilityRequest xmlns:ojp="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.siri.org.uk/siri  ../../OJP.xsd">
+	<siri:RequestTimestamp>2022-12-12T11:46:00Z</siri:RequestTimestamp>
+	<ojp:PublicTransport>
+		<ojp:PickUpLocation>
+			<ojp:CallPlace>
+				<siri:StopPointRef>de:05766:2317:0:1</siri:StopPointRef>
+				<ojp:Name>
+					<ojp:Text>Kt-Kalldorf, Winterberg</ojp:Text>
+				</ojp:Name>
+			</ojp:CallPlace>
+			<ojp:ServiceDeparture>
+				<ojp:TimetabledTime>2022-12-12T11:46:00Z</ojp:TimetabledTime>
+			</ojp:ServiceDeparture>
+		</ojp:PickUpLocation>
+		<ojp:SetDownLocation>
+			<ojp:CallPlace>
+				<siri:StopPointRef>de:05766:3437:0:2</siri:StopPointRef>
+				<ojp:Name>
+					<ojp:Text>Kt-Stemmen, Elfenborner Weg</ojp:Text>
+				</ojp:Name>
+			</ojp:CallPlace>
+			<ojp:ServiceArrival>
+				<ojp:TimetabledTime>2022-12-12T12:02:00Z</ojp:TimetabledTime>
+			</ojp:ServiceArrival>
+		</ojp:SetDownLocation>
+	</ojp:PublicTransport>
+	<ojp:MobilityUser/>
+</ojp:OJPAvailabilityRequest>
diff --git a/examples/function/OJPAvailabilityRequest_2.xml b/examples/function/OJPAvailabilityRequest_2.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ojp:OJPAvailabilityRequest xmlns:ojp="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.siri.org.uk/siri  ../../OJP.xsd">
+	<siri:RequestTimestamp>2022-12-12T11:46:00Z</siri:RequestTimestamp>
+	<ojp:PublicTransport>
+		<ojp:PickUpLocation>
+			<ojp:CallPlace>
+				<siri:StopPointRef>de:05766:2317:0:1</siri:StopPointRef>
+				<ojp:Name>
+					<ojp:Text>Kt-Kalldorf, Winterberg</ojp:Text>
+				</ojp:Name>
+			</ojp:CallPlace>
+			<ojp:ServiceDeparture>
+				<ojp:TimetabledTime>2022-12-14T09:46:00Z</ojp:TimetabledTime>
+			</ojp:ServiceDeparture>
+		</ojp:PickUpLocation>
+		<ojp:SetDownLocation>
+			<ojp:CallPlace>
+				<siri:StopPointRef>de:05766:3437:0:2</siri:StopPointRef>
+				<ojp:Name>
+					<ojp:Text>Kt-Stemmen, Elfenborner Weg</ojp:Text>
+				</ojp:Name>
+			</ojp:CallPlace>
+			<ojp:ServiceArrival>
+				<ojp:TimetabledTime>2022-12-14T10:02:00Z</ojp:TimetabledTime>
+			</ojp:ServiceArrival>
+		</ojp:SetDownLocation>
+	</ojp:PublicTransport>
+	<ojp:MobilityUser/>
+</ojp:OJPAvailabilityRequest>
diff --git a/examples/function/OJPAvailabilityResponse notOK.xml b/examples/function/OJPAvailabilityResponse notOK.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ojp:OJPAvailabilityDelivery xmlns:ojp="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.siri.org.uk/siri  ../../OJP.xsd">
+	<siri:ResponseTimestamp>2001-12-17T09:30:47Z</siri:ResponseTimestamp>
+	<siri:Status>false</siri:Status>
+	<siri:ErrorCondition>
+		<siri:OtherError>
+			<siri:ErrorText>Anfrage konnte nicht verarbeitet werden</siri:ErrorText>
+		</siri:OtherError>
+	</siri:ErrorCondition>
+</ojp:OJPAvailabilityDelivery>