From 26f8423547881df7fe498b107853f5c72070174b Mon Sep 17 00:00:00 2001 From: Travis CI User Date: Tue, 18 Oct 2022 10:55:06 +0000 Subject: [PATCH] Travis CI update [skip ci] --- docs/generated/OJP.html | 52 ++++++++++++++++++++--------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index 8438bed9..a19abc4d 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
    • @@ -892,31 +892,31 @@

    OJP - Open API for distributed Journey

    IncludePlacesContext

    0:1

    xs:boolean

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

    IncludeSituationsContext

    0:1

    xs:boolean

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

    - TripContentFilter

    IncludeIntermediateStops

    0:1

    xs:boolean

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

    -

    IncludeFare

    0:1

    xs:boolean

    Whether the result should include fare information.

    -

    IncludeOperatingDays

    0:1

    xs:boolean

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

    -

    TripSummaryOnly

    0:1

    xs:boolean

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

    -

    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.

    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.

    PTLegs

    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.

    Leg

    1:*

    +Leg

    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.

    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.

    Extension

    0:1

    xs:anyType

    15.14. The complex type LegStructure

    LegStructure

    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.

    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

    TimeWindow

    TimeWindowStart

    0:1

    xs:dateTime

    Time at which window begins.

    TimeWindowEnd

    0:1

    xs:dateTime

    Time at which window ends.

    TripContentFilter

    IncludeIntermediateStops

    0:1

    xs:boolean

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

    IncludeFare

    0:1

    xs:boolean

    Whether the result should include fare information.

    IncludeOperatingDays

    0:1

    xs:boolean

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

    TripSummaryOnly

    0:1

    xs:boolean

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

    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.

    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.

    PTLegs

    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.

    Leg

    1:*

    +Leg

    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.

    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.

    Extension

    0:1

    xs:anyType

    15.14. The complex type LegStructure

    LegStructure

    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.

    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

    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.