From cf663d0d9affded1d9bcf403972be0e26efc91df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20G=C3=BCnter?= Date: Thu, 19 Jan 2023 17:10:00 +0100 Subject: [PATCH] Necessary low level elements for User Preferences (#271) * Necessary low level elements for User Preferences No UserPreference for the time being. New optimisation methods, walking and cycling profile and includeAlternativeOptions all for Trips --- OJP/OJP_Trips.xsd | 100 +++++++++++++++- docs/generated/index.html | 242 +++++++++++++++++++++++++++++++++----- 2 files changed, 306 insertions(+), 36 deletions(-) diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index d33db13ea..be3bd18ea 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -106,11 +106,14 @@ The maximum number of interchanges the user will accept per trip. - - - the types of algorithm that can be used for planning a journey (fastest, least walking, etc) - - + + + + + the types of algorithm that can be used for planning a journey (fastest, least walking, etc) + + + For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. @@ -162,6 +165,11 @@ Whether the result should include intermediate stops (between the passenger's board and alight stops). + + + Whether altnerative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second best route. Should be optimised for the user expectance (see. e.g https://tel.archives-ouvertes.fr/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. + + Whether the result should include fare information. @@ -172,6 +180,54 @@ Whether the result should include operating day information - as encoded bit string and in natural language. + + + Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen#:~:text=Die%20Kategorie%20Blau,Sturzes%20drastische%20Konsequenzen%20haben%20w%C3%BCrden + + + + + + Regular hiking/walking in valleys and plains and easy mountain trails e.g. yellow hiking signs in Switzerland or blue in Germany + + + + + Medium difficulty mountain trails. E.g. white-red-white hiking signs in Switzerland or red in Germany. + + + + + Difficult mountain trails. E.g. white-blue-white hiking signs in Switzerland or black in Germany. + + + + + + + + Users cycling profile (especially for sportive activities). + + + + + + fastest cycle route + + + + + greenest cycle route + + + + + family friendly and leisurely route + + + + + If true, then the response will contain only summaries of the found trips. Default is false. @@ -179,6 +235,14 @@ + + + List of OptimisationMethods. The order of precedence - if used at all - is high to low. In single criteria optimisers the optimisation methods may be used in parallel and not truely used to score the results. + + + + + the types of algorithm that can be used for planning a journey (fastest, least walking, etc). If multiple optimisation methods are needed, then several requests should be performed in parallel. @@ -196,6 +260,32 @@ + + + If set, favour "green" modes/lines such as bike sharing and (electric) trains, avoid or restrict modes/lines known for higher CO2 emissions such as (conventional) taxi, ridehailing or coach. + + + + + High level of safety (refering to crime, hazards or prone to accidents). If used, certain modes, lines or zones/districts known for lower safety, i.e. higher risk of accidents and crime, may be avoided, others may be preferred. This may depend on the actual, local or time of day situation. E.g. bike or scooter may be considered unsafe in some cities/districts while safe in others. + + + + + Low probability of delays, cancellations etc. If used, modes known for their (un)reliability may be avoided/preferred, and extra time added for transfers. This may depend on the actual, local or time of day situation, +based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis in a given city might be known to be unreliable during at 8-10 and 16-19 hours, otherwise reliable. + + + + + Scenic (or touristic) travel. Different by modes or by the surrounding. + + + + + E.g. first class or quiet compartments preferred. Journeys that are with low occupancy. + + diff --git a/docs/generated/index.html b/docs/generated/index.html index 39cb56ca0..6801ca423 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -67,7 +67,7 @@

OJP - Open API for distributed Journey 8. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information
  • 9. OJP/OJP_StopEvents.xsd - Request and response definitions for arrivals and departures of public transport services at stops
  • 10. OJP/OJP_TripInfo.xsd - Request and response definitions for information on a single trip
    • -
  • 11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
    • +
  • 11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
  • 12. OJP/OJP_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles
  • 13. OJP/OJP_Availability.xsd - Request and response definitions for availability of tickets and services on a journey leg.
  • 14. OJP/OJP_Common.xsd - Supporting definitions of common structures
    • @@ -640,7 +640,7 @@

    OJP - Open API for distributed Journey

    →‍siri:ServiceFacilityGroup

    JourneyTrack

    0:1

    +LegTrack

    Geographic embedding of this journey. The entire journey is regarded as one leg.

    Extension

    0:1

    xs:anyType

    10.8. The complex type TripInfoProblemStructure

    TripInfoProblemStructure

    Problem that may be returned in responses to TripInfo requests.

    The element contains only one element:

    Type

    1:1

    TripInfoProblemType

    Type of the TripInfo problem.

    -

    11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning

    11.1. Simple type definitions

    AccessFeatureTypeEnumeration

    elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown

    Allowed values for a AccessFeature.

    AccessibilityFeatureTypesEnumeration

    lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator

    Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to).

    GuidanceAdviceEnumeration

    origin | destination | continue | keep | turn | leave | enter

    various types of guidance advice given to travelle

    MultiPointTypeEnumeration

    anyPoint | eachOrigin | eachDestination

    How the multiple origin/destination points should be considered

    OptimisationMethodEnumeration

    fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture

    the types of algorithm that can be used for planning a journey (fastest, least walking, etc). If multiple optimisation methods are needed, then several requests should be performed in parallel.

    TransitionEnumeration

    up | down | level | upAndDown | downAndUp

    Transition types for interchanges.

    TripProblemTypeEnumeration

    TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_OTHER

    Types of problems that may be returned in responses to Trip requests.

    TurnActionEnumeration

    sharp left | left | half left | straight on | half right | right | sharp right | uturn

    the range of alternative turns that can be described

    11.2. The TripRequestGroup group

    +

    11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning

    11.1. Simple type definitions

    TripRequestGroup

    Trip request structure.

    AccessFeatureTypeEnumeration

    elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown

    Allowed values for a AccessFeature.

    AccessibilityFeatureTypesEnumeration

    lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator

    Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to).

    GuidanceAdviceEnumeration

    origin | destination | continue | keep | turn | leave | enter

    various types of guidance advice given to travelle

    MultiPointTypeEnumeration

    anyPoint | eachOrigin | eachDestination

    How the multiple origin/destination points should be considered

    OptimisationMethodEnumeration

    fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | environmentalSafety | extraSafe | extraReliable | scenic | quietTravel

    the types of algorithm that can be used for planning a journey (fastest, least walking, etc). If multiple optimisation methods are needed, then several requests should be performed in parallel.

    TransitionEnumeration

    up | down | level | upAndDown | downAndUp

    Transition types for interchanges.

    TripProblemTypeEnumeration

    TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_OTHER

    Types of problems that may be returned in responses to Trip requests.

    TurnActionEnumeration

    sharp left | left | half left | straight on | half right | right | sharp right | uturn

    the range of alternative turns that can be described

    11.2. The TripRequestGroup group

    @@ -676,8 +676,8 @@

    OJP - Open API for distributed Journey

    - - + + @@ -689,9 +689,54 @@

    OJP - Open API for distributed Journey

    - + + + + + | | `easy` +| + + + + + | | `medium` +| + + + + + | | `difficult` +| + + + + + + + + + | | `fast` +| + + + + + | | `green` +| + + + + + | | `comfortable` +| + + + + + +

    TripRequestGroup

    Trip request structure.

    TripRequest

    Origin

    1:*

    +PlaceContext

    Specifies the origin situation from where the user wants to start.

    Destination

    1:*

    +PlaceContext

    Specifies the destination situation where the user is heading to.

    Via

    0:*

    +TripVia

    Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops.

    IgnoreRealtimeData

    0:1

    xs:boolean

    The trip calculation should not use any realtime or incident data.

    ImmediateTripStart

    0:1

    xs:boolean

    Whether the trip calculation should find a solution that starts immediately (f.e. because the user is already on the way) instead of finding the latest possible start opportunity.

    TripPolicy

    TransferLimit

    0:1

    xs:nonNegativeInteger

    The maximum number of interchanges the user will accept per trip.

    OptimisationMethod

    0:1

    OptimisationMethod

    the types of algorithm that can be used for planning a journey (fastest, least walking, etc)

    TripPolicy

    TransferLimit

    0:1

    xs:nonNegativeInteger

    The maximum number of interchanges the user will accept per trip.

    Then, the element contains one of the following elements:

    a

    OptimisationMethod

    -1:1

    OptimisationMethod

    b

    OptimisationMethods

    -0:1

    +OptimisationMethodList

    the types of algorithm that can be used for planning a journey (fastest, least walking, etc)

    ItModesToCover

    0:*

    IndividualModes

    For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.

    ConsiderElevationData

    0:1

    xs:boolean

    Trip calculation takes elevation data into account (bike, walk)

    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).

    TripContentFilter

    IncludeIntermediateStops

    0:1

    xs:boolean

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

    IncludeAlternativeOptions

    0:1

    xs:boolean

    Whether altnerative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second best route. Should be optimised for the user expectance (see. e.g https://tel.archives-ouvertes.fr/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters.

    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.

    HikingProfile

    0:1

    Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen#:~:text=Die%20Kategorie%20Blau,Sturzes%20drastische%20Konsequenzen%20haben%20w%C3%BCrden

    CyclingProfile

    0:1

    Users cycling profile (especially for sportive activities).

    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

    Extension

    0:1

    xs:anyType

    11.4. The TripDataFilterGroup group

    @@ -709,8 +754,8 @@

    OJP - Open API for distributed Journey

    - - + +

    TripDataFilterGroup

    Data to be included/excluded from search, f.e. modes, operators.

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes (VEHICLE MODE) to be excluded or included in trip calculation.

    IgnoreRealtimeData

    0:1

    xs:boolean

    The trip calculation should not use any realtime or incident data.

    ImmediateTripStart

    0:1

    xs:boolean

    Whether the trip calculation should find a solution that starts immediately (f.e. because the user is already on the way) instead of finding the latest possible start opportunity.

    TripPolicy

    TransferLimit

    0:1

    xs:nonNegativeInteger

    The maximum number of interchanges the user will accept per trip.

    OptimisationMethod

    0:1

    OptimisationMethod

    the types of algorithm that can be used for planning a journey (fastest, least walking, etc)

    TripPolicy

    TransferLimit

    0:1

    xs:nonNegativeInteger

    The maximum number of interchanges the user will accept per trip.

    The element contains one of the following elements:

    a

    OptimisationMethod

    -1:1

    OptimisationMethod

    b

    OptimisationMethods

    -0:1

    +OptimisationMethodList

    the types of algorithm that can be used for planning a journey (fastest, least walking, etc)

    ItModesToCover

    0:*

    IndividualModes

    For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.

    ConsiderElevationData

    0:1

    xs:boolean

    Trip calculation takes elevation data into account (bike, walk)

    11.6. The TripMobilityFilterGroup group

    @@ -735,17 +780,62 @@

    OJP - Open API for distributed Journey

    - + + + + + | | `easy` +| + + + + + | | `medium` +| + + + + + | | `difficult` +| + + + + + + + + + | | `fast` +| + + + + + | | `green` +| + + + + + | | `comfortable` +| + + + + + + -

    TripMobilityFilterGroup

    Parameters the user can set to restrict the mobility options - particularly for interchanging.

    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).

    TripContentFilter

    IncludeIntermediateStops

    0:1

    xs:boolean

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

    IncludeAlternativeOptions

    0:1

    xs:boolean

    Whether altnerative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second best route. Should be optimised for the user expectance (see. e.g https://tel.archives-ouvertes.fr/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters.

    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.

    HikingProfile

    0:1

    Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen#:~:text=Die%20Kategorie%20Blau,Sturzes%20drastische%20Konsequenzen%20haben%20w%C3%BCrden

    CyclingProfile

    0:1

    Users cycling profile (especially for sportive activities).

    TripSummaryOnly

    0:1

    xs:boolean

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

    11.8. The complex type NotViaStructure

    NotViaStructure

    NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    11.9. The complex type NoChangeAtStructure

    NoChangeAtStructure

    no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP.

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    11.10. The complex type TariffzoneFilterStructure

    TariffzoneFilterStructure

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

    Whether to include or exclude given tariff zones in the list from the search. Default is to include.

    TariffZones

    1:1

    +TariffZoneListInArea

    11.11. The TripResponseGroup group

    +

    TripResponseGroup

    Trip response structure.

    11.8. The complex type OptimisationMethodList

    OptimisationMethodList

    List of OptimisationMethods. The order of precedence - if used at all - is high to low. In single criteria optimisers the optimisation methods may be used in parallel and not truely used to score the results.

    The element contains only one element:

    OptimisationMethod

    1:*

    OptimisationMethod

    11.9. The complex type NotViaStructure

    NotViaStructure

    NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    11.10. The complex type NoChangeAtStructure

    NoChangeAtStructure

    no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP.

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    11.11. The complex type TariffzoneFilterStructure

    TariffzoneFilterStructure

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

    Whether to include or exclude given tariff zones in the list from the search. Default is to include.

    TariffZones

    1:1

    +TariffZoneListInArea

    11.12. The TripResponseGroup group

    -

    TripResponseGroup

    Trip response structure.

    TripResponse

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    TripResult

    0:*

    +TripResult

    The trip results found by the server.

    11.12. The complex type TripResultStructure

    TripResultStructure

    Structure for a single trip result and associated problems.

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    Id of this trip result for referencing purposes. Unique within trip response.

    Problem

    0:*

    +TripProblem

    Problems related to this Trip result.

    Then, the element contains one of the following elements:

    a

    Trip

    -1:1

    +Trip

    Detailed information on trip.

    b

    TripSummary

    -1:1

    +TripSummary

    Summary on trip. Only if requestor set TripSummaryOnly in request.

    TripFare

    0:*

    +TripFareResult

    11.13. The complex type TripSummaryStructure

    +

    TripSummaryStructure

    Structure for trip overview information.

    The element contains a sequence of the following elements:

    TripId

    1:1

    xs:NMTOKEN

    Id of this trip for referencing purposes. Unique within trip response.

    Origin

    0:1

    +PlaceRef

    Describes the origin situation of this trip.

    Destination

    0:1

    +PlaceRef

    Describes the arrival situation of this trip.

    Duration

    0:1

    xs:duration

    Overall duration of the trip.

    StartTime

    0:1

    xs:dateTime

    Departure time at origin.

    EndTime

    0:1

    xs:dateTime

    Arrival time at destination.

    PTTripLegs

    0:1

    xs:nonNegativeInteger

    Number of public transport trip legs.

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    11.13. The complex type TripResultStructure

    TripResultStructure

    Structure for a single trip result and associated problems.

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    Id of this trip result for referencing purposes. Unique within trip response.

    Problem

    0:*

    +TripProblem

    Problems related to this Trip result.

    Then, the element contains one of the following elements:

    a

    Trip

    -1:1

    +Trip

    Detailed information on trip.

    b

    TripSummary

    -1:1

    +TripSummary

    Summary on trip. Only if requestor set TripSummaryOnly in request.

    TripFare

    0:*

    +TripFareResult

    11.14. The complex type TripSummaryStructure

    -

    TripSummaryStructure

    Structure for trip overview information.

    The element contains a sequence of the following elements:

    TripId

    1:1

    xs:NMTOKEN

    Id of this trip for referencing purposes. Unique within trip response.

    Origin

    0:1

    +PlaceRef

    Describes the origin situation of this trip.

    Destination

    0:1

    +PlaceRef

    Describes the arrival situation of this trip.

    Duration

    0:1

    xs:duration

    Overall duration of the trip.

    StartTime

    0:1

    xs:dateTime

    Departure time at origin.

    EndTime

    0:1

    xs:dateTime

    Arrival time at destination.

    PTTripLegs

    0:1

    xs:nonNegativeInteger

    Number of public transport trip legs.

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    OperatingDays

    OperatingDays

    0:1

    +OperatingDays

    Bit string definition of operating days.

    OperatingDaysDescription

    0:1

    +InternationalText

    Textual description of the operation days, e.g. "monday to friday" or "not on holidays".

    →‍SituationFullRef

    0:*

    →‍SituationFullRef

    Reference to situation message. Message details might be found in response context or through other communication channels.

    Extension

    0:1

    xs:anyType

    11.14. The complex type TripStructure

    +

    TripStructure

    [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs

    The element contains a sequence of the following elements:

    TripId

    1:1

    xs:NMTOKEN

    Id of this trip for referencing purposes. Unique within trip response.

    Duration

    1:1

    xs:duration

    Overall duration of the trip.

    StartTime

    1:1

    xs:dateTime

    Departure time at origin.

    EndTime

    1:1

    xs:dateTime

    Arrival time at destination.

    Transfers

    1:1

    xs:nonNegativeInteger

    Number of interchanges.

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    TripLeg

    1:*

    +TripLeg

    Legs of the trip

    →‍SituationFullRef

    0:*

    →‍SituationFullRef

    Reference to situation message. Message details might be found in response context or through other communication channels.

    Extension

    0:1

    xs:anyType

    11.15. The complex type TripStructure

    @@ -754,20 +844,20 @@

    OJP - Open API for distributed Journey

    -

    TripStructure

    [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs

    The element contains a sequence of the following elements:

    TripId

    1:1

    xs:NMTOKEN

    Id of this trip for referencing purposes. Unique within trip response.

    Duration

    1:1

    xs:duration

    Overall duration of the trip.

    StartTime

    1:1

    xs:dateTime

    Departure time at origin.

    EndTime

    1:1

    xs:dateTime

    Arrival time at destination.

    Transfers

    1:1

    xs:nonNegativeInteger

    Number of interchanges.

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    TripLeg

    1:*

    +TripLeg

    Legs of the trip

    OperatingDays

    OperatingDays

    0:1

    +OperatingDays

    Bit string definition of operating days.

    OperatingDaysDescription

    0:1

    +InternationalText

    Textual description of the operation days, e.g. "monday to friday" or "not on holidays".

    →‍SituationFullRef

    0:*

    →‍SituationFullRef

    Reference to situation message. Message details might be found in response context or through other communication channels.

    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.

    Extension

    0:1

    xs:anyType

    11.15. The complex type TripLegStructure

    TripLegStructure

    a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)

    The element contains a sequence of the following elements:

    LegId

    1:1

    xs:NMTOKEN

    Id of this trip leg. Unique within trip result.

    ParticipantRef

    0:1

    siri:ParticipantRefStructure

    [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)

    Then, the element contains one of the following elements:

    a

    ContinuousLeg

    -1:1

    +ContinuousLeg

    b

    TimedLeg

    -1:1

    +TimedLeg

    c

    TransferLeg

    -1:1

    +TransferLeg

    11.16. The complex type TimedLegStructure

    +

    TimedLegStructure

    passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE.

    The element contains a sequence of the following elements:

    LegBoard

    1:1

    +LegBoard

    Stop/Station where boarding is done

    LegIntermediates

    0:*

    +LegIntermediate

    information about the intermediate passed stop points.

    LegAlight

    1:1

    +LegAlight

    Stop/Station to alight

    Service

    1:1

    +DatedJourney

    Service that is used for this trip leg.

    LegAttribute

    0:*

    +LegAttribute

    Attributes that are not valid on the whole service, but only on parts of the journey leg.

    Extension

    0:1

    xs:anyType

    11.16. The complex type TripLegStructure

    TripLegStructure

    a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)

    The element contains a sequence of the following elements:

    LegId

    1:1

    xs:NMTOKEN

    Id of this trip leg. Unique within trip result.

    ParticipantRef

    0:1

    siri:ParticipantRefStructure

    [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)

    Then, the element contains one of the following elements:

    a

    ContinuousLeg

    -1:1

    +ContinuousLeg

    b

    TimedLeg

    -1:1

    +TimedLeg

    c

    TransferLeg

    -1:1

    +TransferLeg

    11.17. The complex type TimedLegStructure

    -

    TimedLegStructure

    passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE.

    The element contains a sequence of the following elements:

    LegBoard

    1:1

    +LegBoard

    Stop/Station where boarding is done

    LegIntermediates

    0:*

    +LegIntermediate

    information about the intermediate passed stop points.

    LegAlight

    1:1

    +LegAlight

    Stop/Station to alight

    Service

    1:1

    +DatedJourney

    Service that is used for this trip leg.

    LegAttribute

    0:*

    +LegAttribute

    Attributes that are not valid on the whole service, but only on parts of the journey leg.

    OperatingDays

    OperatingDays

    0:1

    +OperatingDays

    Bit string definition of operating days.

    OperatingDaysDescription

    0:1

    +InternationalText

    Textual description of the operation days, e.g. "monday to friday" or "not on holidays".

    LegTrack

    0:1

    +LegTrack

    Geographic embedding of this leg.

    Extension

    0:1

    xs:anyType

    11.17. The complex type TransferLegStructure

    +

    TransferLegStructure

    [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    ContinuousMode

    -1:1

    ContinuousModes

    Mode that is used for this interchange between public services.

    b

    TransferMode

    -1:1

    TransferModes

    Mode that is used for this interchange between public services.

    LegStart

    1:1

    +PlaceRef

    Stop/Station where boarding is done

    LegEnd

    1:1

    +PlaceRef

    Stop/Station to alight

    LegTrack

    0:1

    +LegTrack

    Geographic embedding of this leg.

    Extension

    0:1

    xs:anyType

    11.18. The complex type TransferLegStructure

    -

    TransferLegStructure

    [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    ContinuousMode

    -1:1

    ContinuousModes

    Mode that is used for this interchange between public services.

    b

    TransferMode

    -1:1

    TransferModes

    Mode that is used for this interchange between public services.

    LegStart

    1:1

    +PlaceRef

    Stop/Station where boarding is done

    LegEnd

    1:1

    +PlaceRef

    Stop/Station to alight

    TimeWindow

    TimeWindowStart

    0:1

    xs:dateTime

    Time at which window begins.

    TimeWindowEnd

    0:1

    xs:dateTime

    Time at which window ends.

    TransferDuration

    Duration

    1:1

    xs:duration

    Overall duration of this interchange.

    WalkDuration

    0:1

    xs:duration

    Walk time as part of the overall interchange duration.

    BufferTime

    0:1

    xs:duration

    Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

    LegDescription

    0:1

    +InternationalText

    Text that describes this interchange.

    Length

    0:1

    Length

    Length of this interchange path.

    Attribute

    0:*

    +GeneralAttribute

    Note or service attribute.

    PathGuidance

    0:1

    +PathGuidance

    Structured model further describing this interchange, its geographic embedding and accessibility.

    →‍SituationFullRef

    0:*

    →‍SituationFullRef

    Reference to situation message. Message details might be found in response context or through other communication channels.

    Extension

    0:1

    xs:anyType

    11.18. The complex type ContinuousLegStructure

    +

    ContinuousLegStructure

    [relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable

    The element contains a sequence of the following elements:

    LegStart

    1:1

    +PlaceRef

    Stop/Station where boarding is done

    LegEnd

    1:1

    +PlaceRef

    Stop/Station to alight

    Service

    1:1

    +ContinuousService

    Service of this leg. May be "walk" in most cases, but also cycling or taxi etc.

    LegDescription

    0:1

    +InternationalText

    Text that describes this interchange.

    Length

    0:1

    Length

    Length of this interchange path.

    Attribute

    0:*

    +GeneralAttribute

    Note or service attribute.

    PathGuidance

    0:1

    +PathGuidance

    Structured model further describing this interchange, its geographic embedding and accessibility.

    →‍SituationFullRef

    0:*

    →‍SituationFullRef

    Reference to situation message. Message details might be found in response context or through other communication channels.

    Extension

    0:1

    xs:anyType

    11.19. The complex type ContinuousLegStructure

    -

    ContinuousLegStructure

    [relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable

    The element contains a sequence of the following elements:

    LegStart

    1:1

    +PlaceRef

    Stop/Station where boarding is done

    LegEnd

    1:1

    +PlaceRef

    Stop/Station to alight

    Service

    1:1

    +ContinuousService

    Service of this leg. May be "walk" in most cases, but also cycling or taxi etc.

    TimeWindow

    TimeWindowStart

    0:1

    xs:dateTime

    Time at which window begins.

    TimeWindowEnd

    0:1

    xs:dateTime

    Time at which window ends.

    Duration

    1:1

    xs:duration

    Duration of this leg according to user preferences like walk speed.

    LegDescription

    0:1

    +InternationalText

    Title or summary of this leg for overview.

    Length

    0:1

    Length

    Length of the leg.

    LegTrack

    0:1

    +LegTrack

    Detailed description of each element of this leg including geometric projection.

    PathGuidance

    0:1

    +PathGuidance

    Structured model further describing this interchange, its geographic embedding and accessibility.

    →‍SituationFullRef

    0:*

    →‍SituationFullRef

    Reference to situation message. Message details might be found in response context or through other communication channels.

    Extension

    0:1

    xs:anyType

    11.19. The complex type LegBoardStructure

    +

    LegBoardStructure

    Describes the the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information.

    The element contains a sequence of the following elements:

    Duration

    1:1

    xs:duration

    Duration of this leg according to user preferences like walk speed.

    LegDescription

    0:1

    +InternationalText

    Title or summary of this leg for overview.

    Length

    0:1

    Length

    Length of the leg.

    LegTrack

    0:1

    +LegTrack

    Detailed description of each element of this leg including geometric projection.

    PathGuidance

    0:1

    +PathGuidance

    Structured model further describing this interchange, its geographic embedding and accessibility.

    →‍SituationFullRef

    0:*

    →‍SituationFullRef

    Reference to situation message. Message details might be found in response context or through other communication channels.

    Extension

    0:1

    xs:anyType

    11.20. The complex type LegBoardStructure

    @@ -780,7 +870,7 @@

    OJP - Open API for distributed Journey

    -

    LegBoardStructure

    Describes the the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information.

    The element contains a sequence of the following elements:

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    StopPointName

    1:1

    +InternationalText

    Name or description of stop point for use in passenger information.

    NameSuffix

    0:1

    +InternationalText

    Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance".

    NotServicedStop

    0:1

    xs:boolean

    The vehicle will not call at this stop despite earlier planning.

    NoBoardingAtStop

    0:1

    xs:boolean

    Boarding will not be allowed at this stop of this journey.

    NoAlightingAtStop

    0:1

    xs:boolean

    Alighting will not be allowed at this stop of this journey.

    11.20. The complex type LegAlightStructure

    +

    LegAlightStructure

    Describes the situation at a stop or station at which the passenger alights from a Leg of a trip including time-related information

    The element contains a sequence of the following elements:

    11.21. The complex type LegAlightStructure

    @@ -793,7 +883,7 @@

    OJP - Open API for distributed Journey

    -

    LegAlightStructure

    Describes the situation at a stop or station at which the passenger alights from a Leg of a trip including time-related information

    The element contains a sequence of the following elements:

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    StopPointName

    1:1

    +InternationalText

    Name or description of stop point for use in passenger information.

    NameSuffix

    0:1

    +InternationalText

    Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance".

    NotServicedStop

    0:1

    xs:boolean

    The vehicle will not call at this stop despite earlier planning.

    NoBoardingAtStop

    0:1

    xs:boolean

    Boarding will not be allowed at this stop of this journey.

    NoAlightingAtStop

    0:1

    xs:boolean

    Alighting will not be allowed at this stop of this journey.

    11.21. The complex type LegIntermediateStructure

    +

    LegIntermediateStructure

    Describes the situation at a stop or station that lies between the LegBoard and LegAlight stop or station including time-related information.

    The element contains a sequence of the following elements:

    11.22. The complex type LegIntermediateStructure

    @@ -806,18 +896,18 @@

    OJP - Open API for distributed Journey

    -

    LegIntermediateStructure

    Describes the situation at a stop or station that lies between the LegBoard and LegAlight stop or station including time-related information.

    The element contains a sequence of the following elements:

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    StopPointName

    1:1

    +InternationalText

    Name or description of stop point for use in passenger information.

    NameSuffix

    0:1

    +InternationalText

    Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance".

    NotServicedStop

    0:1

    xs:boolean

    The vehicle will not call at this stop despite earlier planning.

    NoBoardingAtStop

    0:1

    xs:boolean

    Boarding will not be allowed at this stop of this journey.

    NoAlightingAtStop

    0:1

    xs:boolean

    Alighting will not be allowed at this stop of this journey.

    11.22. The complex type PathGuidanceStructure

    PathGuidanceStructure

    description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

    The element contains only one element:

    PathGuidanceSection

    1:*

    +PathGuidanceSection

    one or more path guidance sections that build the trip Leg

    11.23. The complex type PathGuidanceSectionStructure

    PathGuidanceSectionStructure

    [an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

    The element contains a sequence of the following elements:

    TrackSection

    0:1

    +TrackSection

    LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

    TurnDescription

    0:1

    +InternationalText

    Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName.

    GuidanceAdvice

    0:1

    GuidanceAdvice

    various types of guidance advice given to travelle.

    TurnAction

    0:1

    TurnAction

    the range of alternative turns that can be described.

    DirectionHint

    0:1

    +InternationalText

    Textual direction hint for better understanding, e.g. "follow signs to Hamburg".

    Bearing

    0:1

    siri:AbsoluteBearingType

    Absolute bearing after the described manoeuvre.

    PathLink

    0:1

    +PathLink

    Description of the type of accessibility on this navigation section.

    SituationFullRef

    0:*

    +SituationFullRef

    11.24. The TransferDurationGroup group

    +

    TransferDurationGroup

    [an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time..

    11.23. The complex type PathGuidanceStructure

    PathGuidanceStructure

    description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

    The element contains only one element:

    PathGuidanceSection

    1:*

    +PathGuidanceSection

    one or more path guidance sections that build the trip Leg

    11.24. The complex type PathGuidanceSectionStructure

    PathGuidanceSectionStructure

    [an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

    The element contains a sequence of the following elements:

    TrackSection

    0:1

    +TrackSection

    LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

    TurnDescription

    0:1

    +InternationalText

    Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName.

    GuidanceAdvice

    0:1

    GuidanceAdvice

    various types of guidance advice given to travelle.

    TurnAction

    0:1

    TurnAction

    the range of alternative turns that can be described.

    DirectionHint

    0:1

    +InternationalText

    Textual direction hint for better understanding, e.g. "follow signs to Hamburg".

    Bearing

    0:1

    siri:AbsoluteBearingType

    Absolute bearing after the described manoeuvre.

    PathLink

    0:1

    +PathLink

    Description of the type of accessibility on this navigation section.

    SituationFullRef

    0:*

    +SituationFullRef

    11.25. The TransferDurationGroup group

    -

    TransferDurationGroup

    [an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time..

    TransferDuration

    Duration

    1:1

    xs:duration

    Overall duration of this interchange.

    WalkDuration

    0:1

    xs:duration

    Walk time as part of the overall interchange duration.

    BufferTime

    0:1

    xs:duration

    Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

    11.25. The complex type PathLinkStructure

    PathLinkStructure

    [TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE.

    The element contains a sequence of the following elements:

    Transition

    0:1

    Transition

    Whether path is up down or level .

    AccessFeatureType

    0:1

    AccessFeatureType

    Type of physical feature of PATH LINK.

    Count

    0:1

    xs:positiveInteger

    Number how often the access feature occurs in this PathLink

    AccessibilityFeature

    0:*

    AccessibilityFeatureTypes

    Presence of an accessibility feature on the PathLink.

    From

    0:1

    +PathLinkEnd

    Designations of level and place where this PathLink starts.

    To

    0:1

    +PathLinkEnd

    Designations of level and place where this PathLink ends.

    11.26. The complex type PathLinkEndStructure

    PathLinkEndStructure

    Designations of a floor/level.

    The element contains a sequence of the following elements:

    LevelPublicCode

    0:1

    xs:normalizedString

    Public identifier of the level as found on elevators and signs.

    LevelName

    0:1

    +InternationalText

    Official name of the level.

    Id

    0:1

    xs:normalizedString

    Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located).

    11.27. The MultiPointTripRequestGroup group

    +

    MultiPointTripRequestGroup

    Multi-point trip request structure.

    11.26. The complex type PathLinkStructure

    PathLinkStructure

    [TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE.

    The element contains a sequence of the following elements:

    Transition

    0:1

    Transition

    Whether path is up down or level .

    AccessFeatureType

    0:1

    AccessFeatureType

    Type of physical feature of PATH LINK.

    Count

    0:1

    xs:positiveInteger

    Number how often the access feature occurs in this PathLink

    AccessibilityFeature

    0:*

    AccessibilityFeatureTypes

    Presence of an accessibility feature on the PathLink.

    From

    0:1

    +PathLinkEnd

    Designations of level and place where this PathLink starts.

    To

    0:1

    +PathLinkEnd

    Designations of level and place where this PathLink ends.

    11.27. The complex type PathLinkEndStructure

    PathLinkEndStructure

    Designations of a floor/level.

    The element contains a sequence of the following elements:

    LevelPublicCode

    0:1

    xs:normalizedString

    Public identifier of the level as found on elevators and signs.

    LevelName

    0:1

    +InternationalText

    Official name of the level.

    Id

    0:1

    xs:normalizedString

    Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located).

    11.28. The MultiPointTripRequestGroup group

    -

    MultiPointTripRequestGroup

    Multi-point trip request structure.

    MultiPointTripRequest

    Origin

    1:*

    +PlaceContext

    Specifies the origin situation from where the user wants to start.

    Destination

    1:*

    +PlaceContext

    Specifies the destination situation where the user is heading to.

    Via

    0:*

    +TripVia

    Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops.

    NotVia

    0:*

    +NotVia

    Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

    NoChangeAt

    0:*

    +NoChangeAt

    no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP

    Params

    0:1

    +MultiPointTripParam

    Options to control the search behaviour and response contents.

    11.28. The complex type MultiPointTripParamStructure

    +

    MultiPointTripParamStructure

    Multi-point trip request parameter structure.

    The element contains a sequence of the following elements:

    11.29. The complex type MultiPointTripParamStructure

    @@ -858,11 +948,56 @@

    OJP - Open API for distributed Journey

    - + + + + + | | `easy` +| + + + + + | | `medium` +| + + + + + | | `difficult` +| + + + + + + + + + | | `fast` +| + + + + + | | `green` +| + + + + + | | `comfortable` +| + + + + + + -

    MultiPointTripParamStructure

    Multi-point trip request parameter structure.

    The element contains a sequence of the following elements:

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes (VEHICLE MODE) to be excluded or included in trip calculation.

    LineFilter

    0:1

    +LineDirectionFilter

    Lines/Directions to include/exclude.

    OperatorFilter

    0:1

    +OperatorFilter

    Transport operators to include/exclude.

    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).

    TripContentFilter

    IncludeIntermediateStops

    0:1

    xs:boolean

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

    IncludeAlternativeOptions

    0:1

    xs:boolean

    Whether altnerative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second best route. Should be optimised for the user expectance (see. e.g https://tel.archives-ouvertes.fr/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters.

    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.

    HikingProfile

    0:1

    Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen#:~:text=Die%20Kategorie%20Blau,Sturzes%20drastische%20Konsequenzen%20haben%20w%C3%BCrden

    CyclingProfile

    0:1

    Users cycling profile (especially for sportive activities).

    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

    Extension

    0:1

    xs:anyType

    11.29. The MultiPointTripPolicyGroup group

    +

    MultiPointTripPolicyGroup

    Policies that control the multi-point trip search behaviour.

    FareParam

    0:1

    +FareParam

    Extension

    0:1

    xs:anyType

    11.30. The MultiPointTripPolicyGroup group

    @@ -874,26 +1009,26 @@

    OJP - Open API for distributed Journey

    -

    MultiPointTripPolicyGroup

    Policies that control the multi-point trip search behaviour.

    The element contains one of the following elements:

    NumberOfResults

    a

    NumberOfResultsBefore

    1:1

    xs:nonNegativeInteger

    The desired number of trip results before the given time (at origin or destination).

    MultiPointTripPolicy

    TransferLimit

    0:1

    xs:nonNegativeInteger

    The maximum number of interchanges the user will accept per trip.

    OptimisationMethod

    0:1

    OptimisationMethod

    the types of algorithm that can be used for planning a journey (fastest, least walking, etc)

    MultiPointType

    0:1

    MultiPointType

    If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

    11.30. The MultiPointTripResponseGroup group

    +

    MultiPointTripResponseGroup

    Multi-point trip response structure.

    11.31. The MultiPointTripResponseGroup group

    -

    MultiPointTripResponseGroup

    Multi-point trip response structure.

    MultiPointTripResponse

    MultiPointTripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    MultiPointTripResult

    0:*

    +MultiPointTripResult

    The trip results found by the server.

    11.31. The complex type MultiPointTripResultStructure

    +

    MultiPointTripResultStructure

    Structure for a multipoint trip result and associated problems

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    Id of this trip result for referencing purposes. Unique within multipoint-trip response.

    Problem

    0:*

    +TripProblem

    Problems related to this trip result.

    Then, the element contains one of the following elements:

    a

    Trip

    -1:1

    +Trip

    Information on the trip.

    b

    TripSummary

    -1:1

    +TripSummary

    11.32. The complex type MultiPointTripResultStructure

    -

    MultiPointTripResultStructure

    Structure for a multipoint trip result and associated problems

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    Id of this trip result for referencing purposes. Unique within multipoint-trip response.

    Problem

    0:*

    +TripProblem

    Problems related to this trip result.

    Then, the element contains one of the following elements:

    a

    Trip

    -1:1

    +Trip

    Information on the trip.

    b

    TripSummary

    -1:1

    +TripSummary

    MultiPointWaitTime

    OriginWaitTime

    0:1

    xs:duration

    Additional wait time at origin of this trip.

    DestinationWaitTime

    0:1

    xs:duration

    Additional wait time at destination of this trip.

    TripFare

    0:*

    +TripFareResult

    11.32. The MultiPointWaitTimeGroup group

    +

    MultiPointWaitTimeGroup

    Group for wait times at origin/destination.

    TripFare

    0:*

    +TripFareResult

    11.33. The MultiPointWaitTimeGroup group

    -

    MultiPointWaitTimeGroup

    Group for wait times at origin/destination.

    MultiPointWaitTime

    OriginWaitTime

    0:1

    xs:duration

    Additional wait time at origin of this trip.

    DestinationWaitTime

    0:1

    xs:duration

    Additional wait time at destination of this trip.

    11.33. The TripStatusGroup group

    +

    TripStatusGroup

    Parameters which describe the current status of a TRIP

    11.34. The TripStatusGroup group

    -

    TripStatusGroup

    Parameters which describe the current status of a TRIP

    TripStatus

    Unplanned

    0:1

    xs:boolean

    Whether this trip is an additional one that has not been planned. Default is false.

    Cancelled

    0:1

    xs:boolean

    Whether this trip is cancelled and will not be run. Default is false.

    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.

    11.34. The TripRefineRequestGroup group

    +

    TripRefineRequestGroup

    Trip refinement request structure.

    11.35. 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.

    11.35. 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.

    11.36. The complex type TripRefineParamStructure

    @@ -902,15 +1037,60 @@

    OJP - Open API for distributed Journey

    - + + + + + | | `easy` +| + + + + + | | `medium` +| + + + + + | | `difficult` +| + + + + + + + + + | | `fast` +| + + + + + | | `green` +| + + + + + | | `comfortable` +| + + + + + + -

    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.

    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).

    TripContentFilter

    IncludeIntermediateStops

    0:1

    xs:boolean

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

    IncludeAlternativeOptions

    0:1

    xs:boolean

    Whether altnerative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second best route. Should be optimised for the user expectance (see. e.g https://tel.archives-ouvertes.fr/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters.

    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.

    HikingProfile

    0:1

    Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen#:~:text=Die%20Kategorie%20Blau,Sturzes%20drastische%20Konsequenzen%20haben%20w%C3%BCrden

    CyclingProfile

    0:1

    Users cycling profile (especially for sportive activities).

    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

    11.36. The TripRefineResponseGroup group

    +

    TripRefineResponseGroup

    Trip refinement response structure.

    FareParam

    0:1

    +FareParam

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

    Extension

    0:1

    xs:anyType

    11.37. 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.

    11.37. The complex type TripProblemStructure

    +

    TripProblemStructure

    Problem that may be returned in responses to trip requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    TripProblemType

    Type of the trip problem.

    11.38. The complex type TripProblemStructure

    TripProblemStructure

    Problem that may be returned in responses to trip requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    TripProblemType

    Type of the trip problem.

    ProblemDetail

    Title

    0:1

    +InternationalText

    Title of the problem.

    Details

    0:1

    +InternationalText

    Explanation of the problem.

    LogData

    0:1

    xs:string

    Additional log data.