Skip to content

Commit

Permalink
TripRefineRequest (#247)
Browse files Browse the repository at this point in the history
* TripRefine service
TripRefine service added.

* Update OJP_Trips.xsd
annotation was not correctly placed in xml tree.
  • Loading branch information
trurlurl authored and sgrossberndt committed Oct 4, 2022
1 parent a64fb8a commit 741f33e
Show file tree
Hide file tree
Showing 3 changed files with 145 additions and 4 deletions.
27 changes: 27 additions & 0 deletions OJP/OJP_Requests.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,31 @@
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== TripRefine Service ==========================================</xs:documentation>
</xs:annotation>
<xs:element name="OJPTripRefineRequest" type="OJPTripRefineRequestStructure" substitutionGroup="siri:AbstractFunctionalServiceRequest"/>
<xs:complexType name="OJPTripRefineRequestStructure">
<xs:complexContent>
<xs:extension base="AbstractOJPServiceRequestStructure">
<xs:sequence>
<xs:group ref="TripRefineRequestGroup"/>
<xs:element ref="siri:Extensions" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="OJPTripRefineDelivery" type="OJPTripRefineDeliveryStructure" substitutionGroup="siri:AbstractFunctionalServiceDelivery"/>
<xs:complexType name="OJPTripRefineDeliveryStructure">
<xs:complexContent>
<xs:extension base="siri:AbstractServiceDeliveryStructure">
<xs:sequence>
<xs:element ref="OJPTripRefineRequest" minOccurs="0"/>
<xs:group ref="ServiceResponseContextGroup"/>
<xs:group ref="TripRefineResponseGroup"/>
<xs:element ref="siri:Extensions" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:schema>
78 changes: 76 additions & 2 deletions OJP/OJP_Trips.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<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>========================================== Request definitions ==========================================</xs:documentation>
<xs:documentation>========================================== TripRequest definitions ==========================================</xs:documentation>
</xs:annotation>
<xs:group name="TripRequestGroup">
<xs:annotation>
Expand Down Expand Up @@ -201,7 +201,7 @@
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== Response definitions ==========================================</xs:documentation>
<xs:documentation>========================================== TripResponse definitions ==========================================</xs:documentation>
</xs:annotation>
<xs:group name="TripResponseGroup">
<xs:annotation>
Expand Down Expand Up @@ -927,4 +927,78 @@
</xs:element>
</xs:sequence>
</xs:group>
<xs:annotation>
<xs:documentation>========================================== TripRefineRequest definitions ==========================================</xs:documentation>
</xs:annotation>
<xs:group name="TripRefineRequestGroup">
<xs:annotation>
<xs:documentation>Trip refinement request structure.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="RefineParams" type="TripRefineParamStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Options to control the refine</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TripResult" type="TripResultStructure">
<xs:annotation>
<xs:documentation>The trip result to be refined by the server.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TripResponseContext" type="ResponseContextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Context to hold objects, which are referenced within the response.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:complexType name="TripRefineParamStructure">
<xs:annotation>
<xs:documentation>Trip refinement request parameter structure.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="ForeignObjectRefs" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>If true, then the request may contain object references from another system. Default is FALSE.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RefineLegRef" type="xs:NMTOKEN" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Refers to a leg to be refined by the server.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="TripContentFilterGroup"/>
<xs:element name="FareParam" type="FareParamStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== TripRefineResponse definitions ==========================================</xs:documentation>
</xs:annotation>
<xs:group name="TripRefineResponseGroup">
<xs:annotation>
<xs:documentation>Trip refinement response structure.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="TripResponseContext" type="ResponseContextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Context to hold trip response objects that occur frequently.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="UnknownLegRef" type="xs:NMTOKEN" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Refers to a leg that was not found in the data of the server. If the to be refined TripResult could not be found or unequivocally determined, all RefineLegRefs are returned as UnknownLegRefs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TripResult" type="TripResultStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The trip results refined by the server.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
</xs:schema>
Loading

0 comments on commit 741f33e

Please sign in to comment.