From 741f33e2c706e666aac77152bea85bb974977381 Mon Sep 17 00:00:00 2001 From: trurlurl <82838870+trurlurl@users.noreply.github.com> Date: Tue, 4 Oct 2022 09:47:27 +0200 Subject: [PATCH] TripRefineRequest (#247) * TripRefine service TripRefine service added. * Update OJP_Trips.xsd annotation was not correctly placed in xml tree. --- OJP/OJP_Requests.xsd | 27 ++++++++++++++ OJP/OJP_Trips.xsd | 78 +++++++++++++++++++++++++++++++++++++++-- docs/generated/OJP.html | 44 +++++++++++++++++++++-- 3 files changed, 145 insertions(+), 4 deletions(-) diff --git a/OJP/OJP_Requests.xsd b/OJP/OJP_Requests.xsd index cc1d2ac1c..a9600ffca 100644 --- a/OJP/OJP_Requests.xsd +++ b/OJP/OJP_Requests.xsd @@ -194,4 +194,31 @@ + + ========================================== TripRefine Service ========================================== + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 03671577f..d99667020 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -6,7 +6,7 @@ - ========================================== Request definitions ========================================== + ========================================== TripRequest definitions ========================================== @@ -201,7 +201,7 @@ - ========================================== Response definitions ========================================== + ========================================== TripResponse definitions ========================================== @@ -927,4 +927,78 @@ + + ========================================== TripRefineRequest definitions ========================================== + + + + Trip refinement request structure. + + + + + Options to control the refine + + + + + The trip result to be refined by the server. + + + + + Context to hold objects, which are referenced within the response. + + + + + + + Trip refinement request parameter structure. + + + + + If true, then the request may contain object references from another system. Default is FALSE. + + + + + Refers to a leg to be refined by the server. + + + + + + Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). + + + + + + + ========================================== TripRefineResponse definitions ========================================== + + + + Trip refinement response structure. + + + + + Context to hold trip response objects that occur frequently. + + + + + 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. + + + + + The trip results refined by the server. + + + + diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index ce43c80f6..addc922af 100644 --- a/docs/generated/OJP.html +++ b/docs/generated/OJP.html @@ -23,12 +23,12 @@

OJP - Open API for distributed Journey 7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
  • 8. OJP/OJP_Places.xsd - Request and response definitions for place information
  • 9. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information
  • -
  • 10. OJP/OJP_Requests.xsd - OJP service requests and responses
  • +
  • 10. OJP/OJP_Requests.xsd - OJP service requests and responses
  • 11. OJP/OJP_RequestSupport.xsd - Supporting definitions for OJP service requests and their responses
  • 12. OJP/OJP_SituationSupport.xsd - Supporting definitions for situations containing wrappers for SIRI Situation Exchange service (SIRI SX)
  • 13. OJP/OJP_StopEvents.xsd - Request and response definitions for arrivals and departures of public transport services at stops
  • 14. OJP/OJP_TripInfo.xsd - Request and response definitions for information on a single trip
  • -
  • 15. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
  • +
  • 15. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
  • 16. OJP/OJP_Utility.xsd - Support definitions not specifically related to the public transport domain
  • @@ -588,6 +588,25 @@

    OJP - Open API for distributed Journey

    MultiPointTripResult

    0:*

    +MultiPointTripResult

    The trip results found by the server.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    +

    10.29. The toplevel element OJPTripRefineRequest

    OJPTripRefineRequest

    +OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest)

    10.30. The complex type OJPTripRefineRequestStructure

    + + + + + + + +

    OJPTripRefineRequestStructure

    +AbstractOJPServiceRequest

    The element contains a sequence of the following elements:

    TripRefineRequest

    RefineParams

    0:1

    +TripRefineParam

    Options to control the refine

    TripResult

    1:1

    +TripResult

    The trip result to be refined by the server.

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold objects, which are referenced within the response.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    10.31. The toplevel element OJPTripRefineDelivery

    OJPTripRefineDelivery

    +OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery)

    10.32. The complex type OJPTripRefineDeliveryStructure

    + + + + + + + + + +

    OJPTripRefineDeliveryStructure

    siri:AbstractServiceDeliveryStructure

    The element contains a sequence of the following elements:

    →‍OJPTripRefineRequest

    0:1

    →‍OJPTripRefineRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

    identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems.

    CalcTime

    0:1

    Calc

    Calculation time.

    TripRefineResponse

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    UnknownLegRef

    0:*

    xs:NMTOKEN

    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.

    TripResult

    0:*

    +TripResult

    The trip results refined by the server.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    11. OJP/OJP_RequestSupport.xsd - Supporting definitions for OJP service requests and their responses

    11.1. Simple type definitions

    CalcTimeType

    xs:integer

    Type definition for calculation time in milliseconds.

    CertificateIdType

    xs:NMTOKEN

    Type definition for the form of identification that can be used as a Message Integrity Property (public key cryptography)

    SignatureType

    xs:string

    data for transmission of message signatures (public key cryptography), used to prove Message Integrity

    11.2. The MessageIntegrityPropertiesGroup group

    @@ -981,6 +1000,27 @@

    OJP - Open API for distributed Journey

    +

    MessageIntegrityPropertiesGroup

    Properties that allow checks for message integrity.

    MessageIntegrityProperties

    Signature

    0:1

    Signature

    Authorisation signature (data for transmission of message signatures (public key cryptography), used to prove Message Integrity).

    Deviation

    0:1

    xs:boolean

    Whether this trip deviates from the planned service pattern. Default is false.

    Delayed

    0:1

    xs:boolean

    Whether this trip is delayed. Default is false.

    Infeasible

    0:1

    xs:boolean

    Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

    15.32. The TripRefineRequestGroup group

    + + + +

    TripRefineRequestGroup

    Trip refinement request structure.

    TripRefineRequest

    RefineParams

    0:1

    +TripRefineParam

    Options to control the refine

    TripResult

    1:1

    +TripResult

    The trip result to be refined by the server.

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold objects, which are referenced within the response.

    15.33. The complex type TripRefineParamStructure

    + + + + + + + + + + + + +

    TripRefineParamStructure

    Trip refinement request parameter structure.

    The element contains a sequence of the following elements:

    ForeignObjectRefs

    0:1

    xs:boolean

    If true, then the request may contain object references from another system. Default is FALSE.

    RefineLegRef

    1:*

    xs:NMTOKEN

    Refers to a leg to be refined by the server.

    BaseTripContentFilter

    IncludeTrackSections

    0:1

    xs:boolean

    Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

    IncludeLegProjection

    0:1

    xs:boolean

    Whether the result should include the geographic projection (coordinates) of each journey leg.

    IncludeTurnDescription

    0:1

    xs:boolean

    Whether the result should include turn-by-turn instructions for each journey leg.

    IncludeAccessibility

    0:1

    xs:boolean

    Whether the result should include accessibility information.

    IncludePlacesContext

    0:1

    xs:boolean

    Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true.

    IncludeSituationsContext

    0:1

    xs:boolean

    Wheter the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true

    TripContentFilter

    IncludeIntermediateStops

    0:1

    xs:boolean

    Whether the result should include intermediate stops (between the passenger's board and alight stops).

    IncludeFare

    0:1

    xs:boolean

    Whether the result should include fare information.

    IncludeOperatingDays

    0:1

    xs:boolean

    Whether the result should include operating day information - as encoded bit string and in natural language.

    TripSummaryOnly

    0:1

    xs:boolean

    If true, then the response will contain only summaries of the found trips. Default is false.

    FareParam

    0:1

    +FareParam

    Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup).

    Extension

    0:1

    xs:anyType

    15.34. The TripRefineResponseGroup group

    + + +

    TripRefineResponseGroup

    Trip refinement response structure.

    TripRefineResponse

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    UnknownLegRef

    0:*

    xs:NMTOKEN

    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.

    TripResult

    0:*

    +TripResult

    The trip results refined by the server.

    16. OJP/OJP_Utility.xsd - Support definitions not specifically related to the public transport domain

    16.1. Simple type definitions

    LengthType

    xs:nonNegativeInteger

    Data type for lengths, in meters.

    OpenPercentType

    xs:nonNegativeInteger

    Percent value as integer, no upper limit.

    PercentType

    xs:nonNegativeInteger

    Percent value as integer, limited to max value 100.

    PhoneNumberType

    xs:normalizedString

    Type definition for phone numbers

    PriorityType

    xs:nonNegativeInteger

    Data type for priority values, from 1 (highest) to 5 (lowest).

    ValidDayBitType

    xs:string

    sequence of bits (values 0 or 1) coded as a text string and representing days

    16.2. The complex type InternationalTextStructure

    InternationalTextStructure

    [a restricted view of ALTERNATIVE NAME in TMv6] alternative identified text to be used in specified languages.

    The element contains a sequence of the following elements:

    Text

    1:*

    siri:NaturalLanguageStringStructure

    Text content.

    TextId

    0:1

    xs:NMTOKEN

    Id of this text. May be used for matching to pre-recorded audio files.

    16.3. The WebLinkGroup group

    WebLinkGroup

    URL of a web resource including type of resource.

    WebLink

    Url

    1:1

    xs:anyURI

    URL to resource on web.