From e3780019b87d34579bc2405fbaab0ec989ccfee6 Mon Sep 17 00:00:00 2001 From: trurlurl <82838870+trurlurl@users.noreply.github.com> Date: Thu, 9 Mar 2023 11:47:44 +0100 Subject: [PATCH] Missing annotations (#332) * several annotations added * OJP_Trips.xsd - missing end tag --- OJP/OJP_Availability.xsd | 12 ++++- OJP/OJP_Common.xsd | 6 ++- OJP/OJP_Fare.xsd | 6 ++- OJP/OJP_FareSupport.xsd | 32 +++++++++--- OJP/OJP_JourneySupport.xsd | 18 +++++-- OJP/OJP_Lines.xsd | 6 ++- OJP/OJP_Locations.xsd | 62 +++++++++++++++++++---- OJP/OJP_PlaceSupport.xsd | 14 ++++-- OJP/OJP_SituationSupport.xsd | 8 ++- OJP/OJP_Trips.xsd | 90 ++++++++++++++++++++++++++------- docs/generated/index.html | 98 ++++++++++++++++++------------------ 11 files changed, 256 insertions(+), 96 deletions(-) diff --git a/OJP/OJP_Availability.xsd b/OJP/OJP_Availability.xsd index e02d2be5f..c2bc44c13 100644 --- a/OJP/OJP_Availability.xsd +++ b/OJP/OJP_Availability.xsd @@ -106,8 +106,16 @@ Earliest possible departure time from a start location and latest possible arrival at a different destination location. - - + + + Earliest possible departure time from start location. + + + + + Latest possible arrival time at destination location. + + diff --git a/OJP/OJP_Common.xsd b/OJP/OJP_Common.xsd index 768df88a3..497054ad6 100644 --- a/OJP/OJP_Common.xsd +++ b/OJP/OJP_Common.xsd @@ -196,7 +196,11 @@ Reference to a vehicle for a specific point in time. - + + + Reference to vehicle. + + Time stamp when the vehicle is operating. In most use cases equal to "now". diff --git a/OJP/OJP_Fare.xsd b/OJP/OJP_Fare.xsd index 0b4c0d1bc..9feecc7fc 100644 --- a/OJP/OJP_Fare.xsd +++ b/OJP/OJP_Fare.xsd @@ -47,7 +47,11 @@ Sub-request: stop-related fare information. - + + + Reference to the stop point. + + Date for which to retrieve Fare information. diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd index eb2937d5d..5d7f4deab 100644 --- a/OJP/OJP_FareSupport.xsd +++ b/OJP/OJP_FareSupport.xsd @@ -223,7 +223,11 @@ List of values for Flexible Booking values. - + + + Flexible booking methods. + + @@ -326,7 +330,11 @@ List of Purchase Moment values. - + + + Possibilities when to pay. + + @@ -372,7 +380,11 @@ List of Booking Process values. - + + + Ways how to book (UIC 7037 codes). + + @@ -390,10 +402,14 @@ - List of Group Booking values. + Possibilites and restrictions for group booking. - + + + Group booking policies. + + @@ -651,7 +667,11 @@ URL to buy the FareProduct online. - + + + Multiple sets of multiple booking arrangements for different legs of a journey. + + diff --git a/OJP/OJP_JourneySupport.xsd b/OJP/OJP_JourneySupport.xsd index ab1cf5302..372055134 100644 --- a/OJP/OJP_JourneySupport.xsd +++ b/OJP/OJP_JourneySupport.xsd @@ -171,8 +171,16 @@ Vehicle journey that runs at a specific date. - - + + + Reference to an Operating Day. + + + + + Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. + + @@ -436,7 +444,11 @@ - + + + Shared mobility offer. + + diff --git a/OJP/OJP_Lines.xsd b/OJP/OJP_Lines.xsd index af3b45aa8..4b8b272e8 100644 --- a/OJP/OJP_Lines.xsd +++ b/OJP/OJP_Lines.xsd @@ -34,7 +34,11 @@ Reference to the LINE. - + + + Name or Number by which the LINE is known to the public. + + DIRECTION of LINE. diff --git a/OJP/OJP_Locations.xsd b/OJP/OJP_Locations.xsd index 70de3840b..3571ef3f1 100644 --- a/OJP/OJP_Locations.xsd +++ b/OJP/OJP_Locations.xsd @@ -45,7 +45,11 @@ If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. - + + + The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best. + + @@ -84,18 +88,30 @@ - - + + + Area defined by a circle. + + + + + Area defined by a rectangle. + + - Area is defined by a polyline + Area defined by a polyline. - + + + Centre position of the circle. + + Radius in metres. @@ -105,8 +121,16 @@ - - + + + Upper-left (north-west) corner of the rectangle. + + + + + Lower-right (south-east) corner of the rectangle. + + @@ -115,7 +139,11 @@ - + + + Vertices of a polyline defining an area. + + @@ -125,7 +153,11 @@ Problems related to this LOCATION result. - + + + The Place / Location object. + + States whether the included location/place is complete or needs further refinement. Only complete locations/places are fully resolved and can be used in e.g. trip requests. Incomplete locations/places have to be refined entering them once again into a LocationInformationRequest. @@ -340,7 +372,11 @@ Preferred language in which to return text values. - + + + Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g. in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response. + + Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response. @@ -360,7 +396,11 @@ If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. - + + + The exchange points found by the service. + + diff --git a/OJP/OJP_PlaceSupport.xsd b/OJP/OJP_PlaceSupport.xsd index 9ed2fbec5..53e71c955 100644 --- a/OJP/OJP_PlaceSupport.xsd +++ b/OJP/OJP_PlaceSupport.xsd @@ -1,7 +1,7 @@ - OJP/OJP_LocationSupport.xsd - Supporting definitions for location information + OJP/OJP_PlaceSupport.xsd - Supporting definitions for location information @@ -13,7 +13,11 @@ A stop point with id and name - + + + Reference to a stop point. + + Name or description of stop point for use in passenger information. @@ -476,7 +480,11 @@ - + + + Reference to a stop point. + + diff --git a/OJP/OJP_SituationSupport.xsd b/OJP/OJP_SituationSupport.xsd index ea0a13b2d..02570a2a5 100644 --- a/OJP/OJP_SituationSupport.xsd +++ b/OJP/OJP_SituationSupport.xsd @@ -12,10 +12,14 @@ - SIRI situation details. + SIRI situation details in public transport, see CEN/TS 15531-5. + + + + + SIRI situation details in individual transport, see CEN/TS 15531-5. - diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 9f1b3ef8d..ae0a49c23 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -61,7 +61,11 @@ - + + + Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). + + @@ -114,10 +118,14 @@ - + + + The type of algorithm to be used for planning a journey (fastest, least walking, etc.). + + - The types of algorithm that can be used for planning a journey (fastest, least walking, etc.) + The types of algorithm that should be used for planning a journey. @@ -296,23 +304,39 @@ - NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through + Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through - - + + + Reference to a not-via stop point. + + + + + Reference to a not-via stop place. + + - no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. + No-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. - - + + + Reference to a no-change stop point. + + + + + Reference to a no-change stop place. + + @@ -323,7 +347,11 @@ Whether to include or exclude given tariff zones in the list from the search. Default is to include. - + + + List of fare zones to include or exclude. + + @@ -373,7 +401,11 @@ - + + + Fare and fare product information for this trip as a whole or parts of it. + + @@ -506,9 +538,21 @@ - - - + + + Timetabled Leg. + + + + + Leg to connect between different services or modes of transport (interchanges). + + + + + Leg by a continuously available service or mode of transport. + + @@ -1245,7 +1289,11 @@ - + + + Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). + + @@ -1353,10 +1401,18 @@ Information on the trip. - + + + Summary on trip. Only if requestor set TripSummaryOnly in request. + + - + + + Fare and fare product information for this trip as a whole or parts of it. + + diff --git a/docs/generated/index.html b/docs/generated/index.html index ca466ea0e..b35b02914 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -64,7 +64,7 @@

OJP - Open API for distributed Journey 5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
  • 6. OJP/OJP_Lines.xsd - Request and response definitions for information on lines
  • 7. OJP/OJP_Location.xsd - Request and response definitions for location information
  • -
  • 8. OJP/OJP_LocationSupport.xsd - Supporting definitions for location information
  • +
  • 8. OJP/OJP_PlaceSupport.xsd - Supporting definitions for location information
  • 9. OJP/OJP_StopEvents.xsd - Request and response definitions for arrivals and departures of public transport services at stops
  • 10. OJP/OJP_TripInfo.xsd - Request and response definitions for information on a single trip
  • 11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
  • @@ -115,7 +115,7 @@

    OJP - Open API for distributed Journey LocationInformationResponse

    LocationInformationResponseContext

    0:1

    +ResponseContext

    Context to hold response objects that occur frequently.

    ContinueAt

    0:1

    xs:nonNegativeInteger

    If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.

    -

    PlaceResult

    0:*

    +PlaceResult

    +

    PlaceResult

    0:*

    +PlaceResult

    The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.9. The toplevel element OJPExchangePointsRequest

    OJPExchangePointsRequest

    +OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.10. The complex type OJPExchangePointsRequestStructure

    @@ -134,7 +134,7 @@

    OJP - Open API for distributed Journey

    - +

    OJPExchangePointsRequestStructure

    +AbstractOJPServiceRequest

    ExchangePointsResponse

    ExchangePointsResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    ContinueAt

    0:1

    xs:nonNegativeInteger

    If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.

    ExchangePointsResult

    0:*

    +ExchangePointsResult

    ExchangePointsResult

    0:*

    +ExchangePointsResult

    The exchange points found by the service.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.13. The toplevel element OJPStopEventRequest

    OJPStopEventRequest

    +OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.14. The complex type OJPStopEventRequestStructure

    @@ -162,7 +162,7 @@

    OJP - Open API for distributed Journey

    - + @@ -253,8 +253,8 @@

    OJP - Open API for distributed Journey

    - - + + @@ -306,7 +306,7 @@

    OJP - Open API for distributed Journey

    4. OJP/OJP_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information

    4.1. The FareRequestGroup group

    OJPStopEventRequestStructure

    +AbstractOJPServiceRequest

    DatedJourneyRef

    a

    →‍JourneyRef

    1:1

    →‍JourneyRef

    Reference to a Journey

    a

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day

    TimedVehicleRef

    b

    →‍siri:VehicleRef

    1:1

    →‍siri:VehicleRef

    TimedVehicleRef

    b

    →‍siri:VehicleRef

    1:1

    →‍siri:VehicleRef

    Reference to vehicle.

    b

    TimeOfOperation

    1:1

    xs:dateTime

    Time stamp when the vehicle is operating. In most use cases equal to "now".

    TripInfoRequest

    Params

    0:1

    +TripInfoParam

    Request parameter.

    Then, the element contains one of the following elements:

    AvailabilityRequest

    a

    PublicTransport

    -1:1

    +BookingPTLeg

    Definition of the journey leg to be covered by public transport. Other mobility services can be added later.

    MobilityUser

    1:*

    +BookingUser

    Passenger(s) for whom the service needs to be booked, one MobilityUser per passenger.

    MinMaxTimeBand

    EarliestDepartureTime

    0:1

    xs:dateTime

    LatestArrivalTime

    0:1

    xs:dateTime

    MinMaxTimeBand

    EarliestDepartureTime

    0:1

    xs:dateTime

    Earliest possible departure time from start location.

    LatestArrivalTime

    0:1

    xs:dateTime

    Latest possible arrival time at destination location.

    AvailabilityRequest

    Extension

    0:1

    xs:anyType

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    -

    FareRequestGroup

    Fare request structure.

    The element contains one of the following elements:

    FareRequest

    a

    MultiTripFareRequest

    -1:1

    +MultiTripFareRequest

    A request to calculate aggregated Fare information of multiple single trips

    b

    StaticFareRequest

    -1:1

    +StaticFareRequest

    A request for general/static Fare information.

    c

    StopFareRequest

    -1:1

    +StopFareRequest

    A request for stop-related Fare information.

    d

    TripFareRequest

    -1:1

    +TripFareRequest

    A request to calculate the Fare information of a single trip

    Params

    0:1

    +FareParam

    Parameter to filter the response contents.

    4.2. The complex type StopFareRequestStructure

    StopFareRequestStructure

    Sub-request: stop-related fare information.

    The element contains a sequence of the following elements:

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Date

    0:1

    xs:date

    Date for which to retrieve Fare information.

    4.3. The complex type StaticFareRequestStructure

    StaticFareRequestStructure

    General Fare information. May depend on date.

    The element contains a sequence of the following elements:

    Date

    0:1

    xs:date

    Date for which to retrieve Fare information.

    →‍FareProductRef

    0:*

    →‍FareProductRef

    Reference to a FareProduct.

    4.4. The complex type TripFareRequestStructure

    TripFareRequestStructure

    Structure of a Single Trip Fare Request.

    The element contains only one element:

    Trip

    1:1

    +Trip

    A complete trip from origin to destination

    4.5. The complex type MultiTripFareRequestStructure

    MultiTripFareRequestStructure

    Structure of a Multi Trip Fare Request.

    The element contains only one element:

    Trip

    1:*

    +Trip

    Multiple complete trips from multiple origins and multiple destination

    4.6. The FareResponseGroup group

    +

    FareResponseGroup

    4.2. The complex type StopFareRequestStructure

    StopFareRequestStructure

    Sub-request: stop-related fare information.

    The element contains a sequence of the following elements:

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Reference to the stop point.

    Date

    0:1

    xs:date

    Date for which to retrieve Fare information.

    4.3. The complex type StaticFareRequestStructure

    StaticFareRequestStructure

    General Fare information. May depend on date.

    The element contains a sequence of the following elements:

    Date

    0:1

    xs:date

    Date for which to retrieve Fare information.

    →‍FareProductRef

    0:*

    →‍FareProductRef

    Reference to a FareProduct.

    4.4. The complex type TripFareRequestStructure

    TripFareRequestStructure

    Structure of a Single Trip Fare Request.

    The element contains only one element:

    Trip

    1:1

    +Trip

    A complete trip from origin to destination

    4.5. The complex type MultiTripFareRequestStructure

    MultiTripFareRequestStructure

    Structure of a Multi Trip Fare Request.

    The element contains only one element:

    Trip

    1:*

    +Trip

    Multiple complete trips from multiple origins and multiple destination

    4.6. The FareResponseGroup group

    FareResponseGroup

    FareResponse

    FareResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    FareResult

    0:*

    +FareResult

    Fare result choice element.

    4.7. The complex type FareResultStructure

    FareResultStructure

    Wrapper element for Fare results.

    The element contains a sequence of the following elements:

    Id

    1:1

    ObjectId

    ID of this result.

    Problem

    0:*

    +FareProblem

    Problems related to this FARE result.

    Then, the element contains one of the following elements:

    a

    MultiTripFareResult

    -1:*

    +MultiTripFareResult

    Fare and FareProducts for multiple trips.

    b

    StaticFareResult

    -1:1

    +StaticFareResult

    Static Fare information.

    c

    StopFareResult

    -1:1

    +StopFareResult

    Stop-related Fare information.

    d

    TripFareResult

    -1:*

    +TripFareResult

    Fare and FareProducts for a given trip.

    4.8. The complex type StopFareResultStructure

    StopFareResultStructure

    Stop-related Fare information.

    The element contains a sequence of the following elements:

    TariffZoneListInArea

    1:*

    +TariffZoneListInArea

    One or more lists of Fare zones that belong to a Fare authority/area.

    Extension

    0:1

    xs:anyType

    4.9. The complex type StaticFareResultStructure

    StaticFareResultStructure

    General Fare information.

    The element contains a sequence of the following elements:

    FareProduct

    0:*

    +FareProduct

    [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information.

    StaticInfoUrl

    0:*

    +WebLink

    URL to information page on the web.

    Extension

    0:1

    xs:anyType

    4.10. The complex type TripFareProductReferenceStructure

    TripFareProductReferenceStructure

    Element that connects FareProducts to trips. A TripFareProduct is a FAREPRODUCT covering a part or the whole of a TRIP from boarding the first public transport vehicle to alighting from the last public transport vehicle (corresponds to a package of PREASSIGNED FARE PRODUCTs)

    The element contains a sequence of the following elements:

    →‍FareProductRef

    1:1

    →‍FareProductRef

    Reference to a FareProduct.

    FromTripIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" trip.

    FromLegIdRef

    0:1

    xs:NMTOKEN

    Identifies the "valid from" LEG. If missing, then valid from the first LEG.

    ToTripIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" trip.

    ToLegIdRef

    0:1

    xs:NMTOKEN

    Identifies the "valid to" LEG. If missing, then valid to the last LEG.

    4.11. The complex type MultiTripFareResultStructure

    MultiTripFareResultStructure

    Structure of a Multi Trip Fare Request result

    The element contains a sequence of the following elements:

    TripFareProductReference

    1:*

    +TripFareProductReference

    Non-empty list of trip references in the corresponding MultiTripFareRequestStructure

    FareProduct

    0:*

    +FareProduct

    Zero, one or more FareProducts that are valid for the referenced trips / part of trips.

    PassedZones

    0:1

    +TariffZoneListInArea

    The set of passed zones.

    StaticInfoUrl

    0:*

    +WebLink

    URL to Fare information pages on the web.

    @@ -316,7 +316,7 @@

    OJP - Open API for distributed Journey

    5.5. The complex type TariffZoneRefStructure

    TariffZoneRefStructure

    Reference to a fare zone.

    5.6. The toplevel element TariffZoneRef

    TariffZoneRef

    +TariffZoneRef

    Reference to a fare zone.

    5.7. The complex type TariffZoneStructure

    TariffZoneStructure

    [a more clearly defined equivalent of TARIFF ZONE in TM and NeTEx] A ZONE used to define a zonal fare structure in a zone-counting or zone-matrix system.

    The element contains a sequence of the following elements:

    →‍TariffZoneRef

    1:1

    →‍TariffZoneRef

    Reference to a fare zone.

    TariffZoneText

    1:1

    xs:string

    Text describing the fare zone. Passengers will recognize the fare zone by this text. Often published on Fare Zone Maps.

    5.8. The complex type TariffZoneListInAreaStructure

    -

    TariffZoneListInAreaStructure

    List of fare zones within the area of a Fare Authority.

    The element contains a sequence of the following elements:

    FareAuthority

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    FareAuthorityText

    1:1

    xs:string

    Textual description or name of Fare authority.

    TariffZone

    1:*

    +TariffZone

    Fare zone in area.

    5.9. The complex type TariffZoneRefListStructure

    TariffZoneRefListStructure

    List of fare zones references within the area of a Fare Authority.

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    →‍TariffZoneRef

    1:*

    →‍TariffZoneRef

    Reference to a fare zone.

    5.10. The complex type ContactDetailsStructure

    ContactDetailsStructure

    Type for contact details.

    The element contains a sequence of the following elements:

    ContactPerson

    0:1

    +InternationalText

    Name of contact person.

    Email

    0:1

    EmailAddress

    The email address of the contact.

    Phone

    0:1

    Phone

    Contact telephone number.

    Fax

    0:1

    Phone

    Contact fax number.

    Url

    0:1

    +WebLink

    The web site address of the contact.

    FurtherDetails

    0:1

    +InternationalText

    Further details about contact process.

    5.11. The complex type BookingMethodListOfEnumerations

    BookingMethodListOfEnumerations

    List of values for Flexible Booking values.

    The element contains only one element:

    BookingMethod

    1:*

    BookingMethod

    5.12. The complex type PurchaseMomentListOfEnumerations

    PurchaseMomentListOfEnumerations

    List of Purchase Moment values.

    The element contains only one element:

    PurchaseMoment

    1:*

    PurchaseMoment

    5.13. The complex type BookingProcessListOfEnumerations

    BookingProcessListOfEnumerations

    List of Booking Process values.

    The element contains only one element:

    BookingProcess

    1:*

    BookingProcess

    5.14. The complex type GroupBookingListOfEnumerations

    GroupBookingListOfEnumerations

    List of Group Booking values.

    The element contains only one element:

    GroupBooking

    1:*

    GroupBooking

    5.15. The complex type BookingArrangementsStructure

    BookingArrangementsStructure

    Type for BOOKING ARRANGEMENTs modified from NeTEx.

    5.16. The BookingArrangementsGroup group

    +

    BookingArrangementsGroup

    Elements for BOOKING ARRANGEMENTs.

    TariffZone

    1:*

    +TariffZone

    Fare zone in area.

    5.9. The complex type TariffZoneRefListStructure

    TariffZoneRefListStructure

    List of fare zones references within the area of a Fare Authority.

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    →‍TariffZoneRef

    1:*

    →‍TariffZoneRef

    Reference to a fare zone.

    5.10. The complex type ContactDetailsStructure

    ContactDetailsStructure

    Type for contact details.

    The element contains a sequence of the following elements:

    ContactPerson

    0:1

    +InternationalText

    Name of contact person.

    Email

    0:1

    EmailAddress

    The email address of the contact.

    Phone

    0:1

    Phone

    Contact telephone number.

    Fax

    0:1

    Phone

    Contact fax number.

    Url

    0:1

    +WebLink

    The web site address of the contact.

    FurtherDetails

    0:1

    +InternationalText

    Further details about contact process.

    5.11. The complex type BookingMethodListOfEnumerations

    BookingMethodListOfEnumerations

    List of values for Flexible Booking values.

    The element contains only one element:

    BookingMethod

    1:*

    BookingMethod

    Flexible booking methods.

    5.12. The complex type PurchaseMomentListOfEnumerations

    PurchaseMomentListOfEnumerations

    List of Purchase Moment values.

    The element contains only one element:

    PurchaseMoment

    1:*

    PurchaseMoment

    Possibilities when to pay.

    5.13. The complex type BookingProcessListOfEnumerations

    BookingProcessListOfEnumerations

    List of Booking Process values.

    The element contains only one element:

    BookingProcess

    1:*

    BookingProcess

    Ways how to book (UIC 7037 codes).

    5.14. The complex type GroupBookingListOfEnumerations

    GroupBookingListOfEnumerations

    Possibilites and restrictions for group booking.

    The element contains only one element:

    GroupBooking

    1:*

    GroupBooking

    Group booking policies.

    5.15. The complex type BookingArrangementsStructure

    BookingArrangementsStructure

    Type for BOOKING ARRANGEMENTs modified from NeTEx.

    5.16. The BookingArrangementsGroup group

    @@ -347,7 +347,7 @@

    OJP - Open API for distributed Journey

    - +

    BookingArrangementsGroup

    Elements for BOOKING ARRANGEMENTs.

    BookingArrangements

    BookingContact

    0:1

    +ContactDetails

    Contact for Booking.

    BookingMethods

    0:1

    +BookingMethodListOf

    Allowed Ways of Making a BOOKING.

    BookingAccess

    0:1

    BookingAccess

    Who can make a booking. Default is public.

    FareProductBooking

    InfoUrl

    0:*

    +WebLink

    URL to information for this FareProduct

    SaleUrl

    0:*

    +WebLink

    URL to buy the FareProduct online.

    BookingArrangements

    0:*

    +BookingArrangementsContainer

    BookingArrangements

    0:*

    +BookingArrangementsContainer

    Multiple sets of multiple booking arrangements for different legs of a journey.

    Extension

    0:1

    xs:anyType

    5.23. The FareProductPriceGroup group

    @@ -364,7 +364,7 @@

    OJP - Open API for distributed Journey

    FareProductPriceGroup

    [related to FARE PRODUCT PRICE in TM and NeTEx] price at which a FARE PRODUCT can be purchased.

    FareProductPrice

    Price

    0:1

    xs:decimal

    FareProduct price as decimal number.

    NetPrice

    0:1

    xs:decimal

    Net FareProduct price as decimal number for accounting purposes.

    5.25. The FareProductBookingGroup group

    - +

    FareProductBookingGroup

    [aggregation of DISTRIBUTION CHANNEL and BOOKING ARRANGEMENT in TM and NeTEx] Group of information elements related to information to support the process of booking a FARE PRODUCT.

    FareProductBooking

    InfoUrl

    0:*

    +WebLink

    URL to information for this FareProduct

    SaleUrl

    0:*

    +WebLink

    URL to buy the FareProduct online.

    BookingArrangements

    0:*

    +BookingArrangementsContainer

    BookingArrangements

    0:*

    +BookingArrangementsContainer

    Multiple sets of multiple booking arrangements for different legs of a journey.

    5.26. The LegRangeGroup group

    @@ -386,7 +386,7 @@

    OJP - Open API for distributed Journey

    LegRangeGroup

    Range of LEGs (from - to) for which a Fare result (ticket) is valid.

    LegRange

    FromLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" LEG.

    ToLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" LEG.

    6. OJP/OJP_Lines.xsd - Request and response definitions for information on lines

    6.1. Simple type definitions

    LineInformationProblemTypeEnumeration

    LINEINFORMATION_LINEUNKNOWN | LINEINFORMATION_OTHER

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

    6.2. The LineInformationResponseGroup group

    -

    LineInformationResponseGroup

    Line Information response group.

    LineInformationResponse

    LineResult

    0:*

    +LineResult

    6.3. The complex type LineResultStructure

    LineResultStructure

    The element contains a sequence of the following elements:

    Problem

    0:*

    +LineInformationProblem

    Problems related to this Line result.

    LineRef

    1:1

    siri:LineRefStructure

    Reference to the LINE.

    →‍siri:PublishedLineName

    0:1

    →‍siri:PublishedLineName

    DirectionRef

    0:1

    siri:DirectionRefStructure

    DIRECTION of LINE.

    RouteGeometry

    0:*

    +LinearShape

    The LINE's route geometry. A line can have multiple ROUTEs and each has its own geometry. The first should be the "main" geometry.

    Mode

    0:*

    +Mode

    List of transport modes that are supported by this line.

    6.4. The complex type LineInformationProblemStructure

    +

    LineInformationProblemStructure

    Problem that may be returned in responses to LINE information requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    LineInformationProblemType

    Type of the LINE information problem.

    6.3. The complex type LineResultStructure

    LineResultStructure

    The element contains a sequence of the following elements:

    Problem

    0:*

    +LineInformationProblem

    Problems related to this Line result.

    LineRef

    1:1

    siri:LineRefStructure

    Reference to the LINE.

    →‍siri:PublishedLineName

    0:1

    →‍siri:PublishedLineName

    Name or Number by which the LINE is known to the public.

    DirectionRef

    0:1

    siri:DirectionRefStructure

    DIRECTION of LINE.

    RouteGeometry

    0:*

    +LinearShape

    The LINE's route geometry. A line can have multiple ROUTEs and each has its own geometry. The first should be the "main" geometry.

    Mode

    0:*

    +Mode

    List of transport modes that are supported by this line.

    6.4. The complex type LineInformationProblemStructure

    @@ -397,7 +397,7 @@

    OJP - Open API for distributed Journey

    LineInformationProblemStructure

    Problem that may be returned in responses to LINE information requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    LineInformationProblemType

    Type of the LINE information 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.

    7.3. The LocationInformationResponseGroup group

    - +

    LocationInformationResponseGroup

    LocationInformationResponse

    LocationInformationResponseContext

    0:1

    +ResponseContext

    Context to hold response objects that occur frequently.

    ContinueAt

    0:1

    xs:nonNegativeInteger

    If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.

    PlaceResult

    0:*

    +PlaceResult

    PlaceResult

    0:*

    +PlaceResult

    The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best.

    7.4. The complex type InitialLocationInputStructure

    InitialLocationInputStructure

    The element contains a sequence of the following elements:

    Name

    0:1

    xs:string

    Name of the LOCATION object which is looked for. This is usually the user's input. If not given, the name of the resulting location objects is not relevant.

    GeoPosition

    0:1

    siri:LocationStructure

    Coordinate where to look for locations/places. If given, the result should prefer locations/place objects near to this GeoPosition.

    GeoRestriction

    0:1

    +GeoRestrictions

    Restricts the resulting location/place objects to the given geographical area.

    AllowedSystem

    0:*

    siri:ParticipantRefStructure

    Used in distributed environments. e.g. EU-Spirit. If none is given, the location/place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location/place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/

    7.5. The complex type PlaceParamStructure

    @@ -416,8 +416,8 @@

    OJP - Open API for distributed Journey

    -

    PlaceParamStructure

    The element contains a sequence of the following elements:

    PlaceDataFilter

    Type

    0:*

    PlaceType

    Allowed location/place object types. If none is given, all types are allowed.

    Usage

    0:1

    PlaceUsage

    Defines, whether location/place objects for origin, via, or destination are searched.

    PlaceSorting

    SortingMethod

    0:1

    xs:string

    If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore use with care.

    GeoPosition

    0:1

    siri:LocationStructure

    WGS84 coordinates position. Locations closer to this GeoPosition are preferred.

    MinimalProbability

    0:1

    xs:float

    Ignore locations with a lower probability.

    7.6. The complex type GeoRestrictionsStructure

    GeoRestrictionsStructure

    The element contains one of the following elements:

    a

    Area

    -1:1

    +GeoArea

    Area is defined by a polyline

    b

    Circle

    -1:1

    +GeoCircle

    c

    Rectangle

    -1:1

    +GeoRectangle

    7.7. The complex type GeoCircleStructure

    GeoCircleStructure

    The element contains a sequence of the following elements:

    Center

    1:1

    siri:LocationStructure

    Radius

    1:1

    siri:DistanceType

    Radius in metres.

    7.8. The complex type GeoRectangleStructure

    GeoRectangleStructure

    The element contains a sequence of the following elements:

    UpperLeft

    1:1

    siri:LocationStructure

    LowerRight

    1:1

    siri:LocationStructure

    7.9. The complex type GeoAreaStructure

    GeoAreaStructure

    [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE -

    The element contains only one element:

    PolylinePoint

    3:*

    siri:LocationStructure

    7.10. The complex type PlaceResultStructure

    +

    PlaceResultStructure

    The element contains a sequence of the following elements:

    Problem

    0:*

    +LocationProblem

    Problems related to this LOCATION result.

    Place

    1:1

    +Place

    Complete

    1:1

    xs:boolean

    States whether the included location/place is complete or needs further refinement. Only complete locations/places are fully resolved and can be used in e.g. trip requests. Incomplete locations/places have to be refined entering them once again into a LocationInformationRequest.

    Probability

    0:1

    Probability, that this result is the one meant by the user's input. Value should be between 0 and 1.

    7.6. The complex type GeoRestrictionsStructure

    GeoRestrictionsStructure

    The element contains one of the following elements:

    a

    Area

    -1:1

    +GeoArea

    Area defined by a polyline.

    b

    Circle

    -1:1

    +GeoCircle

    Area defined by a circle.

    c

    Rectangle

    -1:1

    +GeoRectangle

    Area defined by a rectangle.

    7.7. The complex type GeoCircleStructure

    GeoCircleStructure

    The element contains a sequence of the following elements:

    Center

    1:1

    siri:LocationStructure

    Centre position of the circle.

    Radius

    1:1

    siri:DistanceType

    Radius in metres.

    7.8. The complex type GeoRectangleStructure

    GeoRectangleStructure

    The element contains a sequence of the following elements:

    UpperLeft

    1:1

    siri:LocationStructure

    Upper-left (north-west) corner of the rectangle.

    LowerRight

    1:1

    siri:LocationStructure

    Lower-right (south-east) corner of the rectangle.

    7.9. The complex type GeoAreaStructure

    GeoAreaStructure

    [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE +

    The element contains only one element:

    PolylinePoint

    3:*

    siri:LocationStructure

    Vertices of a polyline defining an area.

    7.10. The complex type PlaceResultStructure

    @@ -453,7 +453,7 @@

    OJP - Open API for distributed Journey

    - +

    PlaceResultStructure

    The element contains a sequence of the following elements:

    Problem

    0:*

    +LocationProblem

    Problems related to this LOCATION result.

    Place

    1:1

    +Place

    The Place / Location object.

    Complete

    1:1

    xs:boolean

    States whether the included location/place is complete or needs further refinement. Only complete locations/places are fully resolved and can be used in e.g. trip requests. Incomplete locations/places have to be refined entering them once again into a LocationInformationRequest.

    Probability

    0:1

    Probability, that this result is the one meant by the user's input. Value should be between 0 and 1.

    AdjacentSystem

    0:*

    siri:ParticipantRefStructure

    One or more adjacent systems to which the exchange points should be retrieved.

    ExchangePointsPolicy

    Language

    0:*

    xs:language

    Preferred language in which to return text values.

    NumberOfResults

    0:1

    xs:positiveInteger

    NumberOfResults

    0:1

    xs:positiveInteger

    Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g. in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response.

    ContinueAt

    0:1

    xs:nonNegativeInteger

    Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response.

    7.16. The ExchangePointsDataFilterGroup group

    @@ -465,21 +465,21 @@

    OJP - Open API for distributed Journey

    ExchangePointsDataFilterGroup

    ExchangePointsDataFilter

    Type

    0:*

    PlaceType

    Allowed location/place object types. If none is given, all types are allowed.

    AdjacentSystem

    0:*

    siri:ParticipantRefStructure

    One or more adjacent systems to which the exchange points should be retrieved.

    7.17. The ExchangePointsPolicyGroup group

    - +

    ExchangePointsPolicyGroup

    ExchangePointsPolicy

    Language

    0:*

    xs:language

    Preferred language in which to return text values.

    NumberOfResults

    0:1

    xs:positiveInteger

    NumberOfResults

    0:1

    xs:positiveInteger

    Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g. in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response.

    ContinueAt

    0:1

    xs:nonNegativeInteger

    Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response.

    7.18. The ExchangePointsResponseGroup group

    - +

    ExchangePointsResponseGroup

    ExchangePointsResponse

    ExchangePointsResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    ContinueAt

    0:1

    xs:nonNegativeInteger

    If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.

    ExchangePointsResult

    0:*

    +ExchangePointsResult

    ExchangePointsResult

    0:*

    +ExchangePointsResult

    The exchange points found by the service.

    7.19. The complex type ExchangePointsResultStructure

    ExchangePointsResultStructure

    The element contains a sequence of the following elements:

    Problem

    0:*

    +ExchangePointsProblem

    Problems related to this EXCHANGE POINTS result.

    Place

    1:1

    +Place

    Place object that describes this exchange point.

    TravelDurationEstimate

    0:1

    xs:duration

    Rough estimate of the travel duration from the specified reference location/place to this exchange point.

    WaitDuration

    0:1

    xs:duration

    Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it has to take care, that feeding arrival and fetching departure are at least this duration apart.

    BorderPoint

    0:1

    xs:boolean

    Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE.

    Mode

    0:*

    +Mode

    List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested.

    Priority

    0:1

    Percent

    The priority of the exchange point. 100 is the maximum.

    -

    8. OJP/OJP_LocationSupport.xsd - Supporting definitions for location information

    8.1. Simple type definitions

    AddressCodeType

    xs:normalizedString

    Identifier of an Address

    ExchangePointsProblemTypeEnumeration

    EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER

    Types of problems that may be returned in responses to EXCHANGE POINTS requests

    LocationProblemTypeEnumeration

    LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_UNSUPPORTEDSORTINGMETHOD | LOCATION_OTHER

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

    PointOfInterestCodeType

    xs:normalizedString

    Identifier of a Point of Interest

    StopPlaceCodeType

    xs:normalizedString

    Identifier of a Stop Place

    TopographicPlaceCodeType

    xs:normalizedString

    Identifier of a TopographicPlace

    8.2. The StopPointGroup group

    - +

    8. OJP/OJP_PlaceSupport.xsd - Supporting definitions for location information

    8.1. Simple type definitions

    StopPointGroup

    A stop point with id and name

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    AddressCodeType

    xs:normalizedString

    Identifier of an Address

    ExchangePointsProblemTypeEnumeration

    EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER

    Types of problems that may be returned in responses to EXCHANGE POINTS requests

    LocationProblemTypeEnumeration

    LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_UNSUPPORTEDSORTINGMETHOD | LOCATION_OTHER

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

    PointOfInterestCodeType

    xs:normalizedString

    Identifier of a Point of Interest

    StopPlaceCodeType

    xs:normalizedString

    Identifier of a Stop Place

    TopographicPlaceCodeType

    xs:normalizedString

    Identifier of a TopographicPlace

    8.2. The StopPointGroup group

    +

    StopPointGroup

    A stop point with id and name

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Reference to a stop point.

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

    PlannedQuay

    0:1

    +InternationalText

    Name of the bay where to board/alight from the vehicle. According to planned timetable.

    EstimatedQuay

    0:1

    +InternationalText

    Name of the bay where to board/alight from the vehicle. As to the latest realtime status.

    8.3. The complex type StopPointStructure

    - + @@ -520,7 +520,7 @@

    OJP - Open API for distributed Journey

    -

    StopPointStructure

    [an extended view of SCHEDULED STOP POINT in TMv6] a SCHEDULED STOP POINT extended by ACCESSIBILITY LIMITATION attributes and with identifier and name where passengers can board or alight from vehicles

    The element contains a sequence of the following elements:

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Reference to a stop point.

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

    PlannedQuay

    0:1

    +InternationalText

    Name of the bay where to board/alight from the vehicle. According to planned timetable.

    Street

    0:1

    xs:string

    Street name of the address.

    HouseNumber

    0:1

    xs:string

    House number of the address. If none is given, either a crossing street can be given, or the whole street is meant.

    CrossRoad

    0:1

    xs:string

    Crossing. This can be used to be more specific without using house numbers.

    8.24. The complex type PlaceStructure

    PlaceStructure

    geographic PLACE of any type which may be specified as the origin or destination of a trip

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    Address

    -1:1

    +Address

    Model of an address

    b

    PointOfInterest

    -1:1

    +PointOfInterest

    Model of a POI

    c

    StopPlace

    -1:1

    +StopPlace

    Model of a stop place

    d

    StopPoint

    -1:1

    +StopPoint

    Model of a stop point

    e

    TopographicPlace

    -1:1

    +TopographicPlace

    TopographicPlace. Region, village, or city.

    Name

    1:1

    +InternationalText

    Public name of the place.

    GeoPosition

    1:1

    siri:LocationStructure

    SituationFullRefs

    0:1

    +SituationRefList

    SITUATION reference. Mostly used for STOP PLACE, SCHEDULED STOP POINT (StopPoint). However, in future a situation reference may occur on many geographic elements (e.g. roads) as well.

    Attribute

    0:*

    +GeneralAttribute

    Attribute associated with this place.

    Extension

    0:1

    xs:anyType

    8.25. The complex type PlaceRefStructure

    PlaceRefStructure

    Reference to a geographic PLACE of any type which may be specified as the origin or destination of a trip

    The element contains a sequence of the following elements:

    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

    c

    →‍TopographicPlaceRef

    -1:1

    →‍TopographicPlaceRef

    If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace

    d

    →‍PointOfInterestRef

    -1:1

    →‍PointOfInterestRef

    Reference to a Point of Interest

    e

    →‍AddressRef

    -1:1

    →‍AddressRef

    Reference to an Address

    f

    GeoPosition

    -1:1

    siri:LocationStructure

    WGS84 coordinates position.

    Name

    1:1

    +InternationalText

    Public name of the place.

    AllowedSystemId

    0:*

    xs:normalizedString

    Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/

    8.26. The complex type LocationProblemStructure

    +

    LocationProblemStructure

    Problem that may be returned in responses to LOCATION requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    LocationProblemType

    Type of the LOCATION problem.

    8.24. The complex type PlaceStructure

    PlaceStructure

    geographic PLACE of any type which may be specified as the origin or destination of a trip

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    Address

    -1:1

    +Address

    Model of an address

    b

    PointOfInterest

    -1:1

    +PointOfInterest

    Model of a POI

    c

    StopPlace

    -1:1

    +StopPlace

    Model of a stop place

    d

    StopPoint

    -1:1

    +StopPoint

    Model of a stop point

    e

    TopographicPlace

    -1:1

    +TopographicPlace

    TopographicPlace. Region, village, or city.

    Name

    1:1

    +InternationalText

    Public name of the place.

    GeoPosition

    1:1

    siri:LocationStructure

    SituationFullRefs

    0:1

    +SituationRefList

    SITUATION reference. Mostly used for STOP PLACE, SCHEDULED STOP POINT (StopPoint). However, in future a situation reference may occur on many geographic elements (e.g. roads) as well.

    Attribute

    0:*

    +GeneralAttribute

    Attribute associated with this place.

    Extension

    0:1

    xs:anyType

    8.25. The complex type PlaceRefStructure

    PlaceRefStructure

    Reference to a geographic PLACE of any type which may be specified as the origin or destination of a trip

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    Reference to a stop point.

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    c

    →‍TopographicPlaceRef

    -1:1

    →‍TopographicPlaceRef

    If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace

    d

    →‍PointOfInterestRef

    -1:1

    →‍PointOfInterestRef

    Reference to a Point of Interest

    e

    →‍AddressRef

    -1:1

    →‍AddressRef

    Reference to an Address

    f

    GeoPosition

    -1:1

    siri:LocationStructure

    WGS84 coordinates position.

    Name

    1:1

    +InternationalText

    Public name of the place.

    AllowedSystemId

    0:*

    xs:normalizedString

    Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/

    8.26. The complex type LocationProblemStructure

    @@ -605,7 +605,7 @@

    OJP - Open API for distributed Journey

    - + @@ -681,7 +681,7 @@

    OJP - Open API for distributed Journey

    - + @@ -744,7 +744,7 @@

    OJP - Open API for distributed Journey

    -

    LocationProblemStructure

    Problem that may be returned in responses to LOCATION requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    LocationProblemType

    Type of the LOCATION 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.

    DatedJourneyRef

    a

    →‍JourneyRef

    1:1

    →‍JourneyRef

    Reference to a Journey

    a

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day

    TimedVehicleRef

    b

    →‍siri:VehicleRef

    1:1

    →‍siri:VehicleRef

    TimedVehicleRef

    b

    →‍siri:VehicleRef

    1:1

    →‍siri:VehicleRef

    Reference to vehicle.

    b

    TimeOfOperation

    1:1

    xs:dateTime

    Time stamp when the vehicle is operating. In most use cases equal to "now".

    TripInfoRequest

    Params

    0:1

    +TripInfoParam

    Request parameter.

    ImmediateTripStart

    0:1

    xs:boolean

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

    TripPolicy

    TransferLimit

    0:1

    xs:nonNegativeInteger

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

    Then, the element contains one of the following elements:

    a

    OptimisationMethod

    -1:1

    OptimisationMethod

    b

    OptimisationMethods

    -0:1

    +OptimisationMethodList

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

    Then, the element contains one of the following elements:

    a

    OptimisationMethod

    -1:1

    OptimisationMethod

    The type of algorithm to be used for planning a journey (fastest, least walking, etc.).

    b

    OptimisationMethods

    -0:1

    +OptimisationMethodList

    The types of algorithm that should be used for planning a journey.

    ItModesToCover

    0:*

    IndividualModes

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

    ConsiderElevationData

    0:1

    xs:boolean

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

    TripSummaryOnly

    0:1

    xs:boolean

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

    FareParam

    0:1

    +FareParam

    Extension

    0:1

    xs:anyType

    11.4. The TripDataFilterGroup group

    +

    TripDataFilterGroup

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

    FareParam

    0:1

    +FareParam

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

    Extension

    0:1

    xs:anyType

    11.4. The TripDataFilterGroup group

    @@ -761,7 +761,7 @@

    OJP - Open API for distributed Journey

    - +

    TripDataFilterGroup

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

    TripDataFilter

    PtModeFilter

    0:1

    +PtModeFilter

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

    LineFilter

    0:1

    +LineDirectionFilter

    Lines/Directions to include/exclude.

    OperatorFilter

    0:1

    +OperatorFilter

    Transport operators to include/exclude.

    ImmediateTripStart

    0:1

    xs:boolean

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

    TripPolicy

    TransferLimit

    0:1

    xs:nonNegativeInteger

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

    The element contains one of the following elements:

    a

    OptimisationMethod

    -1:1

    OptimisationMethod

    b

    OptimisationMethods

    -0:1

    +OptimisationMethodList

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

    The element contains one of the following elements:

    a

    OptimisationMethod

    -1:1

    OptimisationMethod

    The type of algorithm to be used for planning a journey (fastest, least walking, etc.).

    b

    OptimisationMethods

    -0:1

    +OptimisationMethodList

    The types of algorithm that should be used for planning a journey.

    ItModesToCover

    0:*

    IndividualModes

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

    ConsiderElevationData

    0:1

    xs:boolean

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

    11.6. The TripMobilityFilterGroup group

    @@ -837,10 +837,10 @@

    OJP - Open API for distributed Journey

    -

    TripMobilityFilterGroup

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

    TripSummaryOnly

    0:1

    xs:boolean

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

    11.8. The complex type OptimisationMethodList

    OptimisationMethodList

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

    The element contains only one element:

    OptimisationMethod

    1:*

    OptimisationMethod

    11.9. The complex type NotViaStructure

    NotViaStructure

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

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    11.10. The complex type NoChangeAtStructure

    NoChangeAtStructure

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

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    11.11. The complex type TariffzoneFilterStructure

    TariffzoneFilterStructure

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

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

    TariffZones

    1:1

    +TariffZoneListInArea

    11.12. The TripResponseGroup group

    +

    TripResponseGroup

    Trip response structure.

    11.8. The complex type OptimisationMethodList

    OptimisationMethodList

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

    The element contains only one element:

    OptimisationMethod

    1:*

    OptimisationMethod

    11.9. The complex type NotViaStructure

    NotViaStructure

    Not-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

    Reference to a not-via stop point.

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a not-via stop place.

    11.10. The complex type NoChangeAtStructure

    NoChangeAtStructure

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

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    Reference to a no-change stop point.

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a no-change stop place.

    11.11. The complex type TariffzoneFilterStructure

    TariffzoneFilterStructure

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

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

    TariffZones

    1:1

    +TariffZoneListInArea

    List of fare zones to include or exclude.

    11.12. The TripResponseGroup group

    -

    TripResponseGroup

    Trip response structure.

    TripResponse

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    TripResult

    0:*

    +TripResult

    The trip results found by the server.

    11.13. The complex type TripResultStructure

    TripResultStructure

    Structure for a single trip result and associated problems.

    The element contains a sequence of the following elements:

    Id

    1:1

    ObjectId

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

    Problem

    0:*

    +TripProblem

    Problems related to this Trip result.

    Then, the element contains one of the following elements:

    a

    Trip

    -1:1

    +Trip

    Detailed information on trip.

    b

    TripSummary

    -1:1

    +TripSummary

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

    TripFare

    0:*

    +TripFareResult

    11.14. The complex type TripSummaryStructure

    +

    TripSummaryStructure

    Structure for trip overview information.

    The element contains a sequence of the following elements:

    TripId

    1:1

    ObjectId

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

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    11.13. The complex type TripResultStructure

    TripResultStructure

    Structure for a single trip result and associated problems.

    The element contains a sequence of the following elements:

    Id

    1:1

    ObjectId

    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

    Fare and fare product information for this trip as a whole or parts of it.

    11.14. The complex type TripSummaryStructure

    TripSummaryStructure

    Structure for trip overview information.

    The element contains a sequence of the following elements:

    TripId

    1:1

    ObjectId

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

    Feasibility

    0:*

    Feasibility

    Information about the feasibility of the TRIP, in particular with respect to the access features used.

    SituationFullRefs

    0:1

    +SituationRefList

    A list of references to SITUATIONs.

    Extension

    0:1

    xs:anyType

    11.15. The complex type TripStructure

    @@ -852,7 +852,7 @@

    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 LEGs

    The element contains a sequence of the following elements:

    Id

    1:1

    ObjectId

    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

    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.

    Feasibility

    0:*

    Feasibility

    Information about the feasibility of the TRIP, in particular with respect to the access features used.

    SituationFullRefs

    0:1

    +SituationRefList

    A list of references to SITUATIONs.

    Extension

    0:1

    xs:anyType

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

    Id

    1:1

    ObjectId

    Id of this 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

    Feasibility

    0:*

    Feasibility

    Information about the feasibility of the TRIP, in particular with respect to the access features used.

    SituationFullRefs

    0:1

    +SituationRefList

    A list of references to SITUATIONs.

    Extension

    0:1

    xs:anyType

    11.16. The complex type LegStructure

    @@ -884,7 +884,7 @@

    OJP - Open API for distributed Journey

    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:

    Id

    1:1

    ObjectId

    Id of this 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

    Leg by a continuously available service or mode of transport.

    b

    TimedLeg

    -1:1

    +TimedLeg

    Timetabled Leg.

    c

    TransferLeg

    -1:1

    +TransferLeg

    Leg to connect between different services or modes of transport (interchanges).

    Sustainability

    EmissionCO2

    0:1

    The element contains a sequence of the following elements:

    KilogramPerPersonKm

    1:1

    Kilogram by person and by kilometer of CO2 emission.

    ConfidenceLevel

    0:1

    Percentage

    Confidence level of the emission value in percent.

    Extension

    0:1

    xs:anyType

    11.20. The complex type LegBoardStructure

    - + @@ -897,7 +897,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

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Reference to a stop point.

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

    PlannedQuay

    0:1

    +InternationalText

    Name of the bay where to board/alight from the vehicle. According to planned timetable.

    NoBoardingAtStop

    0:1

    xs:boolean

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

    NoAlightingAtStop

    0:1

    xs:boolean

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

    11.21. The complex type LegAlightStructure

    - + @@ -910,7 +910,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

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Reference to a stop point.

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

    PlannedQuay

    0:1

    +InternationalText

    Name of the bay where to board/alight from the vehicle. According to planned timetable.

    NoBoardingAtStop

    0:1

    xs:boolean

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

    NoAlightingAtStop

    0:1

    xs:boolean

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

    11.22. The complex type LegIntermediateStructure

    - + @@ -1025,7 +1025,7 @@

    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

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Reference to a stop point.

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

    PlannedQuay

    0:1

    +InternationalText

    Name of the bay where to board/alight from the vehicle. According to planned timetable.

    TripSummaryOnly

    0:1

    xs:boolean

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

    FareParam

    0:1

    +FareParam

    Extension

    0:1

    xs:anyType

    11.31. The MultiPointTripPolicyGroup group

    +

    MultiPointTripPolicyGroup

    Policies that control the multi-point trip search behaviour.

    FareParam

    0:1

    +FareParam

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

    Extension

    0:1

    xs:anyType

    11.31. The MultiPointTripPolicyGroup group

    @@ -1041,10 +1041,10 @@

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

    MultiPointTripResponse

    MultiPointType

    0:1

    MultiPointType

    The MultiPointType should be returned, because it may differ from the one asked. Many systems will support only a subset of the MultiPointTypes and it is important to know, what the result is based on.

    MultiPointTripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    MultiPointTripResult

    0:*

    +MultiPointTripResult

    The trip results found by the server.

    11.33. The complex type MultiPointTripResultStructure

    +

    MultiPointTripResultStructure

    Structure for a multipoint trip result and associated problems

    The element contains a sequence of the following elements:

    Id

    1:1

    ObjectId

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

    Problem

    0:*

    +TripProblem

    Problems related to this trip result.

    Then, the element contains one of the following elements:

    a

    Trip

    -1:1

    +Trip

    Information on the trip.

    b

    TripSummary

    -1:1

    +TripSummary

    11.33. The complex type MultiPointTripResultStructure

    -

    MultiPointTripResultStructure

    Structure for a multipoint trip result and associated problems

    The element contains a sequence of the following elements:

    Id

    1:1

    ObjectId

    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

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

    MultiPointWaitTime

    OriginWaitTime

    0:1

    xs:duration

    Additional wait time at origin of this trip.

    DestinationWaitTime

    0:1

    xs:duration

    Additional wait time at destination of this trip.

    TripFare

    0:*

    +TripFareResult

    11.34. The MultiPointWaitTimeGroup group

    +

    MultiPointWaitTimeGroup

    Group for wait times at origin/destination.

    TripFare

    0:*

    +TripFareResult

    Fare and fare product information for this trip as a whole or parts of it.

    11.34. The MultiPointWaitTimeGroup group

    MultiPointWaitTimeGroup

    Group for wait times at origin/destination.

    MultiPointWaitTime

    OriginWaitTime

    0:1

    xs:duration

    Additional wait time at origin of this trip.

    DestinationWaitTime

    0:1

    xs:duration

    Additional wait time at destination of this trip.

    11.35. The TripStatusGroup group

    @@ -1127,7 +1127,7 @@

    OJP - Open API for distributed Journey

    TripStatusGroup

    Parameters which describe the current status of a TRIP

    LogData

    0:1

    xs:string

    Additional log data.

    12. OJP/OJP_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles

    12.1. Simple type definitions

    AccessibilityDetailsProfileEnumeration

    visualImpairment | auditoryImpairment | mobilityImpairment | bicycle | general

    Allowed values for AccessibilityDetails.

    ReservationNeededEnumeration

    none | service | stop

    Possible types of reservation needed for services.

    UseRealtimeDataEnumeration

    full | explanatory | none

    VehicleProgressEnumeration

    Not yet operated | Operation finished | At stop | Between stops

    Vehicle progress relative to timetable service pattern.

    12.2. The complex type ServiceViaPointStructure

    - + @@ -1167,8 +1167,8 @@

    OJP - Open API for distributed Journey

    ServiceViaPointStructure

    [a specialisation of VIA in TMv6] STOP PLACE or SCHEDULED STOP POINT as a VIA for a particular SERVICE PATTERN. Specialisation of a VIA.

    The element contains a sequence of the following elements:

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Reference to a stop point.

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

    PlannedQuay

    0:1

    +InternationalText

    Name of the bay where to board/alight from the vehicle. According to planned timetable.

    12.9. The RouteDescriptionGroup group

    RouteDescriptionGroup

    Descriptive text for a route, f.e. "Airport via City Centre"

    RouteDescription

    RouteDescriptionText

    1:1

    +InternationalText

    12.10. The DatedJourneyGroup group

    - - + + @@ -1191,8 +1191,8 @@

    OJP - Open API for distributed Journey

    DatedJourneyGroup

    Vehicle journey that runs at a specific date.

    DatedJourney

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

    DatedJourney

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day.

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

    Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id.

    ScheduledJourney

    →‍JourneyRef

    1:1

    →‍JourneyRef

    Reference to a Journey

    PublicCode

    0:1

    xs:normalizedString

    Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488".

    OrganisationRef

    0:1

    siri:OperatorRefStructure

    InfoUrl

    0:1

    +WebLink

    Link to web page providing more details on service.

    12.12. The complex type DatedJourneyStructure

    - - + + @@ -1256,7 +1256,7 @@

    OJP - Open API for distributed Journey

    DatedJourneyStructure

    [equivalent to DATED VEHICLE JOURNEY in TMv6] passenger carrying VEHICLE JOURNEY for one specified DAY TYPE for which the pattern of working is in principle defined by a SERVICE JOURNEY PATTERN. DatedJourney details of a service include its operating days.

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    DatedJourney

    a

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day

    a

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

    DatedJourney

    a

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day.

    a

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

    Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id.

    ScheduledJourney

    a

    →‍JourneyRef

    1:1

    →‍JourneyRef

    Reference to a Journey

    a

    PublicCode

    0:1

    xs:normalizedString

    Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488".

    EstimatedTimeHigh

    0:1

    xs:dateTime

    Estimated upper limit for time.

    12.19. The complex type CallAtStopStructure

    - + @@ -1281,8 +1281,8 @@

    OJP - Open API for distributed Journey

    CallAtStopStructure

    [same as CALL in SIRI] the meeting of a VEHICLE JOURNEY with a specific SCHEDULED STOP POINT

    The element contains a sequence of the following elements:

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    StopPoint

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Reference to a stop point.

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

    PlannedQuay

    0:1

    +InternationalText

    Name of the bay where to board/alight from the vehicle. According to planned timetable.

    Deviation

    0:1

    xs:boolean

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

    Occupancy

    0:1

    siri:OccupancyEnumeration

    [equivalent to OCCUPANCY in SIRI] passenger load status of a VEHICLE. If omitted, not known.

    12.22. The complex type ContinuousServiceStructure

    - - + + @@ -1299,7 +1299,7 @@

    OJP - Open API for distributed Journey

    - + @@ -1340,8 +1340,8 @@

    OJP - Open API for distributed Journey

    - - + +

    ContinuousServiceStructure

    [a special form of SERVICE JOURNEY in TMv6] a vehicle movement on a continuous, non-timetabled service.

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    ContinuousMode

    -1:1

    ContinuousModes

    Continuous transport options.

    b

    IndividualMode

    -1:1

    IndividualModes

    Individual transport options.

    Then, the element contains one of the following elements:

    DatedJourney

    a

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day

    a

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

    DatedJourney

    a

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day.

    a

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

    Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id.

    ScheduledJourney

    a

    →‍JourneyRef

    1:1

    →‍JourneyRef

    Reference to a Journey

    a

    PublicCode

    0:1

    xs:normalizedString

    Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488".

    a

    Attribute

    0:*

    +GeneralAttribute

    Note or service attribute.

    b

    SharingService

    -0:1

    +SharingService

    b

    SharingService

    -0:1

    +SharingService

    Shared mobility offer.

    ServiceOrigin

    OriginStopPointRef

    0:1

    siri:StopPointRefStructure

    First stop of the vehicle journey; origin stop point.

    OriginText

    1:1

    +InternationalText

    Label for first stop.

    The element contains one of the following elements:

    AvailabilityRequest

    a

    PublicTransport

    -1:1

    +BookingPTLeg

    Definition of the journey leg to be covered by public transport. Other mobility services can be added later.

    MobilityUser

    1:*

    +BookingUser

    Passenger(s) for whom the service needs to be booked, one MobilityUser per passenger.

    MinMaxTimeBand

    EarliestDepartureTime

    0:1

    xs:dateTime

    LatestArrivalTime

    0:1

    xs:dateTime

    MinMaxTimeBand

    EarliestDepartureTime

    0:1

    xs:dateTime

    Earliest possible departure time from start location.

    LatestArrivalTime

    0:1

    xs:dateTime

    Latest possible arrival time at destination location.

    AvailabilityRequest

    Extension

    0:1

    xs:anyType

    13.3. The complex type BookingPTLegStructure

    @@ -1395,8 +1395,8 @@

    OJP - Open API for distributed Journey

    BookingPTLegStructure

    Journey leg by public transport.

    The element contains a sequence of the following elements:

    PickUpLocation

    1:1

    +ProvisionedCallAtPlace

    Location where passenger intends to enter the service.

    SetDownLocation

    1:1

    +ProvisionedCallAtPlace

    Location where passenger intends to leave the service.

    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.

    13.6. The MinMaxTimeBandGroup group

    - - + +

    MinMaxTimeBandGroup

    Earliest possible departure time from a start location and latest possible arrival at a different destination location.

    MinMaxTimeBand

    EarliestDepartureTime

    0:1

    xs:dateTime

    LatestArrivalTime

    0:1

    xs:dateTime

    MinMaxTimeBand

    EarliestDepartureTime

    0:1

    xs:dateTime

    Earliest possible departure time from start location.

    LatestArrivalTime

    0:1

    xs:dateTime

    Latest possible arrival time at destination location.

    13.7. The PassengerProfileGroup group

    @@ -1453,7 +1453,7 @@

    OJP - Open API for distributed Journey

    PassengerProfileGroup

    Profile of the passenger's abilities.

    PassengerProfile

    WheelchairUser

    0:1

    xs:boolean

    Passenger uses a wheelchair. Default is FALSE.

    WalkingFrame

    0:1

    xs:boolean

    Passenger uses a walking frame. Default is FALSE.

    DatedJourneyRef

    →‍JourneyRef

    1:1

    →‍JourneyRef

    Reference to a Journey

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day

    14.16. The TimedVehicleRefGroup group

    - +

    TimedVehicleRefGroup

    Reference to a vehicle for a specific point in time.

    TimedVehicleRef

    →‍siri:VehicleRef

    1:1

    →‍siri:VehicleRef

    TimedVehicleRef

    →‍siri:VehicleRef

    1:1

    →‍siri:VehicleRef

    Reference to vehicle.

    TimeOfOperation

    1:1

    xs:dateTime

    Time stamp when the vehicle is operating. In most use cases equal to "now".

    14.17. The complex type VehicleFilterStructure

    VehicleFilterStructure

    Filter for Vehicles

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

    Whether to include or exclude given VehicleRefs and TRAIN NUMBERS in the list from the search. Default is exclude.

    VehicleRef

    0:*

    siri:VehicleRefStructure

    Reference to VEHICLE

    TrainNumber

    0:*

    xs:normalizedString

    TRAIN NUMBERs

    14.18. The SharingServiceUsageGroup group

    @@ -1491,7 +1491,7 @@

    OJP - Open API for distributed Journey

    SharingServiceUsageGroup

    Usage parameters of a sharing service.

    SharingServiceUsage

    TimeBufferBefore

    0:1

    xs:duration

    Typical time a user will need to check in and unlock the vehicle.

    Mode

    PtMode

    1:1

    siri:VehicleModesOfTransportEnumeration

    Categorisation of mode

    →‍siri:PtModeChoiceGroup

    16.5. The complex type PtModeFilterStructure

    PtModeFilterStructure

    List of public transport modes ([from SIRI] mode of public transport service, corresponds to VEHICLE MODE) to exclude or include.

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

    Whether VEHICLE MODEs in list are to be excluded or included from search. Default is to exclude.

    PtMode

    0:*

    siri:VehicleModesOfTransportEnumeration

    List of PT Transport modes to include/exclude.

    →‍siri:PtModeChoiceGroup

    16.6. The complex type PrivateModeFilterStructure

    PrivateModeFilterStructure

    List of private mobility offers to include or exclude.

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

    Whether modes in list are to include or exclude from search. Default is exclude.

    PrivateMode

    0:*

    PrivateModes

    List of private mobility offers to include/exclude.

    -

    17. OJP/OJP_SituationSupport.xsd - Supporting definitions for situations containing wrappers for SIRI Situation Exchange service (SIRI SX)

    17.1. The complex type SituationsStructure

    SituationsStructure

    Wrapper type for SIRI PtSituationsElementStructure

    The element contains a sequence of the following elements:

    PtSituation

    0:*

    siri:PtSituationElementStructure

    SIRI situation details.

    RoadSituation

    0:*

    siri:RoadSituationElementStructure

    17.2. The toplevel element SituationFullRef

    SituationFullRef

    +SituationFullRef

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

    17.3. The complex type SituationFullRefStructure

    +

    17. OJP/OJP_SituationSupport.xsd - Supporting definitions for situations containing wrappers for SIRI Situation Exchange service (SIRI SX)

    17.1. The complex type SituationsStructure

    SituationFullRefStructure

    siri:SituationFullRefStructure

    Reference structure for situation message. Situation details might be found in response context or through other communication channels.

    SituationsStructure

    Wrapper type for SIRI PtSituationsElementStructure

    The element contains a sequence of the following elements:

    PtSituation

    0:*

    siri:PtSituationElementStructure

    SIRI situation details in public transport, see CEN/TS 15531-5.

    RoadSituation

    0:*

    siri:RoadSituationElementStructure

    SIRI situation details in individual transport, see CEN/TS 15531-5.

    17.2. The toplevel element SituationFullRef

    SituationFullRef

    +SituationFullRef

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

    17.3. The complex type SituationFullRefStructure

    SituationFullRefStructure

    siri:SituationFullRefStructure

    Reference structure for situation message. Situation details might be found in response context or through other communication channels.

    17.4. The complex type SituationRefList

    SituationRefList

    List of references to SITUATIONs.

    The element contains only one element:

    →‍SituationFullRef

    1:*

    →‍SituationFullRef

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

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

    18.1. Simple type definitions

    EMailAddressType

    xs:normalizedString

    Type definition for e-mail addresses.

    LengthType

    xs:nonNegativeInteger

    Data type for lengths, in meters.

    OpenPercentType

    xs:nonNegativeInteger

    Percent value as integer, no upper limit.

    PercentType

    xs:nonNegativeInteger

    Percent value as integer, limited to max value 100.

    PhoneNumberType

    xs:normalizedString

    Type definition for phone numbers

    PriorityType

    xs:nonNegativeInteger

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

    ValidDayBitType

    xs:string

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

    18.2. The complex type InternationalTextStructure

    InternationalTextStructure

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

    The element contains a sequence of the following elements:

    Text

    1:*

    siri:NaturalLanguageStringStructure

    Text content.

    TextId

    0:1

    xs:NMTOKEN

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

    18.3. The WebLinkGroup group

    WebLinkGroup

    URL of a web resource including type of resource.