From 33455191678815b9af1e0434d2ed6c7a8fa2d683 Mon Sep 17 00:00:00 2001 From: Malte Herlitze Date: Wed, 14 Dec 2022 12:53:51 +0100 Subject: [PATCH 1/4] added TariffzoneFilter to TripDataFilterGroup --- OJP/OJP_Trips.xsd | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 1be315e9d..0820dae31 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -88,6 +88,11 @@ Filter for VEHICLE and TRAIN NUMBERs. + + + Filter for trips using only specific tariff zones. + + @@ -210,6 +215,16 @@ + + + + + Whether to include or exclude given tariff zones in the list from the search. Default is include. + + + + + ========================================== TripResponse definitions ========================================== From 6a89e684da6d4c9627d5b7e0b579f2115d3fa3c5 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 14 Dec 2022 11:55:50 +0000 Subject: [PATCH 2/4] Lint and update documentation tables --- docs/generated/OJP.html | 51 ++++++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index 630d83c67..8447ac381 100644 --- a/docs/generated/OJP.html +++ b/docs/generated/OJP.html @@ -70,7 +70,7 @@

OJP - Open API for distributed Journey 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
    • @@ -818,11 +818,12 @@

    OJP - Open API for distributed Journey

    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

    +TripParam

    Options to control the search behaviour and response contents.

    15.3. The complex type TripParamStructure

    - + + @@ -862,11 +863,12 @@

    OJP - Open API for distributed Journey

    TripParamStructure

    Trip request parameter structure.

    The element contains a sequence of the following elements:

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    LineFilter

    0:1

    +LineDirectionFilter

    Lines/Directions to include/exclude.

    OperatorFilter

    0:1

    +OperatorFilter

    Transport operators to include/exclude.

    PrivateModeFilter

    0:1

    +PrivateModeFilter

    Private mobility options to include/exclude.

    VehicleFilter

    0:1

    +VehicleFilter

    Filter for VEHICLE and TRAIN NUMBERs.

    TariffzoneFilter

    0:1

    +TariffzoneFilter

    Filter for trips using only specific tariff zones.

    BaseTripMobilityFilter

    NoSingleStep

    0:1

    xs:boolean

    The user is not able to climb one step.

    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

    Extension

    0:1

    xs:anyType

    15.4. The TripDataFilterGroup group

    - + +

    TripDataFilterGroup

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

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    LineFilter

    0:1

    +LineDirectionFilter

    Lines/Directions to include/exclude.

    OperatorFilter

    0:1

    +OperatorFilter

    Transport operators to include/exclude.

    PrivateModeFilter

    0:1

    +PrivateModeFilter

    Private mobility options to include/exclude.

    VehicleFilter

    0:1

    +VehicleFilter

    Filter for VEHICLE and TRAIN NUMBERs.

    TariffzoneFilter

    0:1

    +TariffzoneFilter

    Filter for trips using only specific tariff zones.

    15.5. The TripPolicyGroup group

    @@ -905,13 +907,13 @@

    OJP - Open API for distributed Journey

    -

    TripPolicyGroup

    Policies that control the trip search behaviour.

    The element contains one of the following elements:

    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.

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

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

    15.10. The TripResponseGroup group

    +

    TripResponseGroup

    Trip response structure.

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

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

    15.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 include.

    TariffZones

    1:1

    +TariffZoneListInArea

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

    15.11. The complex type TripResultStructure

    TripResultStructure

    Structure for a single trip result and its accompanying error messages.

    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.

    ErrorMessage

    0:*

    +ErrorMessage

    Error messages 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

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

    15.12. The complex type TripResultStructure

    TripResultStructure

    Structure for a single trip result and its accompanying error messages.

    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.

    ErrorMessage

    0:*

    +ErrorMessage

    Error messages 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

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

    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

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

    15.14. The complex type TripStructure

    @@ -920,20 +922,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

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

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

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

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

    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

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

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

    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

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

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

    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

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

    15.19. The complex type LegBoardStructure

    @@ -946,7 +948,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.

    15.19. 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:

    15.20. The complex type LegAlightStructure

    @@ -959,7 +961,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.

    15.20. 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:

    15.21. The complex type LegIntermediateStructure

    @@ -972,23 +974,24 @@

    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.

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

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

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

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

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

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

    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.

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

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

    15.26. The MultiPointTripRequestGroup group

    +

    MultiPointTripRequestGroup

    Multi-point trip request structure.

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

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

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

    15.27. The complex type MultiPointTripParamStructure

    - +

    MultiPointTripParamStructure

    Multi-point trip request parameter structure.

    The element contains a sequence of the following elements:

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    15.28. The complex type MultiPointTripParamStructure

    + + @@ -1027,7 +1030,7 @@

    OJP - Open API for distributed Journey

    -

    MultiPointTripParamStructure

    Multi-point trip request parameter structure.

    The element contains a sequence of the following elements:

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    LineFilter

    0:1

    +LineDirectionFilter

    Lines/Directions to include/exclude.

    OperatorFilter

    0:1

    +OperatorFilter

    Transport operators to include/exclude.

    PrivateModeFilter

    0:1

    +PrivateModeFilter

    Private mobility options to include/exclude.

    VehicleFilter

    0:1

    +VehicleFilter

    Filter for VEHICLE and TRAIN NUMBERs.

    TariffzoneFilter

    0:1

    +TariffzoneFilter

    Filter for trips using only specific tariff zones.

    BaseTripMobilityFilter

    NoSingleStep

    0:1

    xs:boolean

    The user is not able to climb one step.

    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

    Extension

    0:1

    xs:anyType

    15.28. The MultiPointTripPolicyGroup group

    +

    MultiPointTripPolicyGroup

    Policies that control the multi-point trip search behaviour.

    FareParam

    0:1

    +FareParam

    Extension

    0:1

    xs:anyType

    15.29. The MultiPointTripPolicyGroup group

    @@ -1039,26 +1042,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.

    15.29. The MultiPointTripResponseGroup group

    +

    MultiPointTripResponseGroup

    Multi-point trip response structure.

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

    15.30. The complex type MultiPointTripResultStructure

    +

    MultiPointTripResultStructure

    Structure for a single trip result and its accompanying error messages.

    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.

    ErrorMessage

    0:*

    +ErrorMessage

    Error messages related to 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

    15.31. The complex type MultiPointTripResultStructure

    -

    MultiPointTripResultStructure

    Structure for a single trip result and its accompanying error messages.

    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.

    ErrorMessage

    0:*

    +ErrorMessage

    Error messages related to 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

    15.31. The MultiPointWaitTimeGroup group

    +

    MultiPointWaitTimeGroup

    Group for wait times at origin/destination.

    TripFare

    0:*

    +TripFareResult

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

    15.32. The TripStatusGroup group

    +

    TripStatusGroup

    Parameters which describe the current status of a TRIP

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

    15.33. The TripRefineRequestGroup group

    +

    TripRefineRequestGroup

    Trip refinement request structure.

    15.34. 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.34. 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.

    15.35. The complex type TripRefineParamStructure

    @@ -1071,7 +1074,7 @@

    OJP - Open API for distributed Journey

    -

    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.

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

    15.36. The TripRefineResponseGroup group

    From 99ac6f8f0925ca598c39dfdbeae43c945f591b9d Mon Sep 17 00:00:00 2001 From: Stefan de Konink Date: Fri, 16 Dec 2022 11:10:31 +0100 Subject: [PATCH 3/4] Update OJP/OJP_Trips.xsd --- OJP/OJP_Trips.xsd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 0820dae31..4492ec59a 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -219,7 +219,7 @@ - Whether to include or exclude given tariff zones in the list from the search. Default is include. + Whether to include or exclude given tariff zones in the list from the search. Default is to include. From abcb58961ec7afeb616617a2a23784b4887dc925 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 16 Dec 2022 10:13:30 +0000 Subject: [PATCH 4/4] Lint and update documentation tables --- docs/generated/index.html | 53 +++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/docs/generated/index.html b/docs/generated/index.html index a6fb5817c..45321b8e8 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -70,7 +70,7 @@

    OJP - Open API for distributed Journey 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
    • @@ -851,11 +851,12 @@

    OJP - Open API for distributed Journey

    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.

    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

    +TripParam

    Options to control the search behaviour and response contents.

    15.3. The complex type TripParamStructure

    - + + @@ -896,11 +897,12 @@

    OJP - Open API for distributed Journey

    TripParamStructure

    Trip request parameter structure.

    The element contains a sequence of the following elements:

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    LineFilter

    0:1

    +LineDirectionFilter

    Lines/Directions to include/exclude.

    OperatorFilter

    0:1

    +OperatorFilter

    Transport operators to include/exclude.

    PrivateModeFilter

    0:1

    +PrivateModeFilter

    Private mobility options to include/exclude.

    VehicleFilter

    0:1

    +VehicleFilter

    Filter for VEHICLE and TRAIN NUMBERs.

    TariffzoneFilter

    0:1

    +TariffzoneFilter

    Filter for trips using only specific tariff zones.

    BaseTripMobilityFilter

    NoSingleStep

    0:1

    xs:boolean

    The user is not able to climb one step.

    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

    Extension

    0:1

    xs:anyType

    15.4. The TripDataFilterGroup group

    - + +

    TripDataFilterGroup

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

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    LineFilter

    0:1

    +LineDirectionFilter

    Lines/Directions to include/exclude.

    OperatorFilter

    0:1

    +OperatorFilter

    Transport operators to include/exclude.

    PrivateModeFilter

    0:1

    +PrivateModeFilter

    Private mobility options to include/exclude.

    VehicleFilter

    0:1

    +VehicleFilter

    Filter for VEHICLE and TRAIN NUMBERs.

    TariffzoneFilter

    0:1

    +TariffzoneFilter

    Filter for trips using only specific tariff zones.

    15.5. The TripPolicyGroup group

    @@ -940,13 +942,13 @@

    OJP - Open API for distributed Journey

    -

    TripPolicyGroup

    Policies that control the trip search behaviour.

    The element contains one of the following elements:

    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.

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

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

    15.10. The TripResponseGroup group

    +

    TripResponseGroup

    Trip response structure.

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

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

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

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

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

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

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

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

    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

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

    15.14. The complex type TripStructure

    @@ -955,20 +957,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

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

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

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

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

    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

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

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

    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

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

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

    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

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

    15.19. The complex type LegBoardStructure

    @@ -981,7 +983,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.

    15.19. 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:

    15.20. The complex type LegAlightStructure

    @@ -994,7 +996,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.

    15.20. 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:

    15.21. The complex type LegIntermediateStructure

    @@ -1007,23 +1009,24 @@

    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.

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

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

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

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

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

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

    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.

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

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

    15.26. The MultiPointTripRequestGroup group

    +

    MultiPointTripRequestGroup

    Multi-point trip request structure.

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

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

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

    15.27. The complex type MultiPointTripParamStructure

    - +

    MultiPointTripParamStructure

    Multi-point trip request parameter structure.

    The element contains a sequence of the following elements:

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    15.28. The complex type MultiPointTripParamStructure

    + + @@ -1062,7 +1065,7 @@

    OJP - Open API for distributed Journey

    -

    MultiPointTripParamStructure

    Multi-point trip request parameter structure.

    The element contains a sequence of the following elements:

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

    Modes to be considered in trip calculation.

    LineFilter

    0:1

    +LineDirectionFilter

    Lines/Directions to include/exclude.

    OperatorFilter

    0:1

    +OperatorFilter

    Transport operators to include/exclude.

    PrivateModeFilter

    0:1

    +PrivateModeFilter

    Private mobility options to include/exclude.

    VehicleFilter

    0:1

    +VehicleFilter

    Filter for VEHICLE and TRAIN NUMBERs.

    TariffzoneFilter

    0:1

    +TariffzoneFilter

    Filter for trips using only specific tariff zones.

    BaseTripMobilityFilter

    NoSingleStep

    0:1

    xs:boolean

    The user is not able to climb one step.

    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

    Extension

    0:1

    xs:anyType

    15.28. The MultiPointTripPolicyGroup group

    +

    MultiPointTripPolicyGroup

    Policies that control the multi-point trip search behaviour.

    FareParam

    0:1

    +FareParam

    Extension

    0:1

    xs:anyType

    15.29. The MultiPointTripPolicyGroup group

    @@ -1074,26 +1077,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.

    15.29. The MultiPointTripResponseGroup group

    +

    MultiPointTripResponseGroup

    Multi-point trip response structure.

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

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

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

    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

    15.31. The MultiPointWaitTimeGroup group

    +

    MultiPointWaitTimeGroup

    Group for wait times at origin/destination.

    TripFare

    0:*

    +TripFareResult

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

    15.32. The TripStatusGroup group

    +

    TripStatusGroup

    Parameters which describe the current status of a TRIP

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

    15.33. The TripRefineRequestGroup group

    +

    TripRefineRequestGroup

    Trip refinement request structure.

    15.34. 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.34. 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.

    15.35. The complex type TripRefineParamStructure

    @@ -1106,11 +1109,11 @@

    OJP - Open API for distributed Journey

    -

    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.

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

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

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

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

    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.