Add sorting options for places (#301)

Co-authored-by: Malte Herlitze <[email protected]> Co-authored-by: Matthias Günter <[email protected]>
VDVde · Jan 19, 2023 · d455c47 · d455c47
1 parent 0e21b03
commit d455c47
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 9 deletions.
diff --git a/OJP/OJP_PlaceSupport.xsd b/OJP/OJP_PlaceSupport.xsd
@@ -510,6 +510,11 @@
 					<xs:documentation>The service does not support any restrictions by localities.</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>
+			<xs:enumeration value="LOCATION_UNSUPPORTEDSORTINGMETHOD">
+				<xs:annotation>
+					<xs:documentation>The service does not support the sorting method. The details should provide a list of the allowed methods the service supports.</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
 			<xs:enumeration value="LOCATION_OTHER">
 				<xs:annotation>
 					<xs:documentation>A problem has occurred that does not have a specific problem type.</xs:documentation>

diff --git a/OJP/OJP_Places.xsd b/OJP/OJP_Places.xsd
@@ -79,6 +79,7 @@
 		<xs:sequence>
 			<xs:group ref="PlaceDataFilterGroup"/>
 			<xs:group ref="PlacePolicyGroup"/>
+			<xs:group ref="PlaceSortingGroup"/>
 		</xs:sequence>
 	</xs:complexType>
 	<xs:complexType name="GeoRestrictionsStructure">
@@ -206,6 +207,25 @@
 			</xs:element>
 		</xs:sequence>
 	</xs:group>
+	<xs:group name="PlaceSortingGroup">
+		<xs:sequence>
+			<xs:element name="SortingMethod" type="xs:string" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore use with care.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="GeoPosition" type="siri:LocationStructure" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>WGS84 coordinates position. Locations closer to this GeoPosition are preferred.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="MinimalProbability" type="xs:float" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>Ignore locations with a lower probability.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+		</xs:sequence>
+	</xs:group>
 	<xs:simpleType name="PlaceTypeEnumeration">
 		<xs:restriction base="xs:string">
 			<xs:enumeration value="stop">