From dd4e17635bd8780256d9beb7b7cbacf2a135988c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20G=C3=BCnter?= Date: Wed, 5 Apr 2023 10:30:04 +0200 Subject: [PATCH] Problem --> ErrorCondition (#336) The ErrorCode substitution group does not want to work for some reasons... but using the OtherError as substitution group is fully ok --- OJP/OJP_Availability.xsd | 16 +-- OJP/OJP_Common.xsd | 28 +++- OJP/OJP_Fare.xsd | 2 +- OJP/OJP_FareSupport.xsd | 16 +-- OJP/OJP_Lines.xsd | 16 +-- OJP/OJP_Locations.xsd | 4 +- OJP/OJP_PlaceSupport.xsd | 28 +--- OJP/OJP_RequestSupport.xsd | 21 +-- OJP/OJP_StopEvents.xsd | 16 +-- OJP/OJP_TripInfo.xsd | 15 +- OJP/OJP_Trips.xsd | 28 ++-- docs/generated/index.html | 134 +++++++----------- examples/functions/error/ErrorResponse_1.xml | 59 ++++++++ examples/functions/error/error_response.xml | 5 +- examples/functions/error/error_response_2.xml | 100 +++++++++++++ examples/functions/fare/FareResponse.xml | 11 +- 16 files changed, 283 insertions(+), 216 deletions(-) create mode 100644 examples/functions/error/ErrorResponse_1.xml create mode 100644 examples/functions/error/error_response_2.xml diff --git a/OJP/OJP_Availability.xsd b/OJP/OJP_Availability.xsd index 95586e344..804cff935 100644 --- a/OJP/OJP_Availability.xsd +++ b/OJP/OJP_Availability.xsd @@ -228,7 +228,7 @@ Availability result structure. - + Problems related to this AVAILABILITY result. @@ -423,17 +423,5 @@ - - - Problem that may be returned in responses to AVAILABILITY requests. - - - - - Type of the AVAILABILITY problem. - - - - - + diff --git a/OJP/OJP_Common.xsd b/OJP/OJP_Common.xsd index 792132c47..c1facbefe 100644 --- a/OJP/OJP_Common.xsd +++ b/OJP/OJP_Common.xsd @@ -14,16 +14,34 @@ ========================================== General ========================================== + + + Error: All OJP related errors. + + + + + Type for Error: OJP Error. + + + + + + + + ProblemDetailGroup + + + + + + + Detailed description of the problem. - - - Title of the problem. - - Explanation of the problem. diff --git a/OJP/OJP_Fare.xsd b/OJP/OJP_Fare.xsd index f1037cb26..62817c0a1 100644 --- a/OJP/OJP_Fare.xsd +++ b/OJP/OJP_Fare.xsd @@ -137,7 +137,7 @@ ID of this result. - + Problems related to this FARE result. diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd index 1b05d8aab..af3ae48ec 100644 --- a/OJP/OJP_FareSupport.xsd +++ b/OJP/OJP_FareSupport.xsd @@ -699,7 +699,7 @@ Structure of a Single Trip Fare Request result - + Result-specific error messages. @@ -851,17 +851,5 @@ - - - Problem that may be returned in responses to FARE requests. - - - - - Type of the FARE problem. - - - - - + diff --git a/OJP/OJP_Lines.xsd b/OJP/OJP_Lines.xsd index 1162523b7..98e368f84 100644 --- a/OJP/OJP_Lines.xsd +++ b/OJP/OJP_Lines.xsd @@ -24,7 +24,7 @@ - + Problems related to this Line result. @@ -81,17 +81,5 @@ - - - Problem that may be returned in responses to LINE information requests. - - - - - Type of the LINE information problem. - - - - - + diff --git a/OJP/OJP_Locations.xsd b/OJP/OJP_Locations.xsd index de21d34a5..6f66a4571 100644 --- a/OJP/OJP_Locations.xsd +++ b/OJP/OJP_Locations.xsd @@ -148,7 +148,7 @@ - + Problems related to this LOCATION result. @@ -405,7 +405,7 @@ - + Problems related to this EXCHANGE POINTS result. diff --git a/OJP/OJP_PlaceSupport.xsd b/OJP/OJP_PlaceSupport.xsd index 285d67a53..17a857bae 100644 --- a/OJP/OJP_PlaceSupport.xsd +++ b/OJP/OJP_PlaceSupport.xsd @@ -566,19 +566,7 @@ - - - Problem that may be returned in responses to LOCATION requests. - - - - - Type of the LOCATION problem. - - - - - + Types of problems that may be returned in responses to EXCHANGE POINTS requests @@ -606,17 +594,5 @@ - - - Problem that may be returned in responses to EXCHANGE POINTS requests. - - - - - Type of the EXCHANGE POINTS problem. - - - - - + diff --git a/OJP/OJP_RequestSupport.xsd b/OJP/OJP_RequestSupport.xsd index e241c3914..491e5765d 100644 --- a/OJP/OJP_RequestSupport.xsd +++ b/OJP/OJP_RequestSupport.xsd @@ -74,7 +74,7 @@ Calculation time. - + OJP generic problem for the whole delivery. @@ -172,6 +172,11 @@ The server cannot provide the requested data frame (data version). + + + The server was not able to work with the SystemID that was provided. + + A problem has occurred that does not have a specific problem type. @@ -179,17 +184,5 @@ - - - Problem that may be returned in case of generic problems with the request. - - - - - Type of the generic problem. - - - - - + diff --git a/OJP/OJP_StopEvents.xsd b/OJP/OJP_StopEvents.xsd index 9666c09fb..30abb753a 100644 --- a/OJP/OJP_StopEvents.xsd +++ b/OJP/OJP_StopEvents.xsd @@ -189,7 +189,7 @@ ID of this result. - + Problems related to this STOPEVENT result. @@ -302,17 +302,5 @@ - - - Problem that may be returned in responses to STOPEVENT requests. - - - - - Type of the STOPEVENT problem. - - - - - + diff --git a/OJP/OJP_TripInfo.xsd b/OJP/OJP_TripInfo.xsd index 48cfd6713..668154037 100644 --- a/OJP/OJP_TripInfo.xsd +++ b/OJP/OJP_TripInfo.xsd @@ -112,7 +112,7 @@ TripInfo result structure containing the current status of a trip. - + Problems related to this TripInfo result. @@ -187,16 +187,5 @@ - - - Problem that may be returned in responses to TripInfo requests. - - - - - Type of the TripInfo problem. - - - - + diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 004a76a55..962ac3b34 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -362,7 +362,7 @@ Id of this trip result for referencing purposes. Unique within trip response. - + Problems related to this Trip result. @@ -1363,7 +1363,7 @@ Id of this trip result for referencing purposes. Unique within multipoint-trip response. - + Problems related to this trip result. @@ -1629,6 +1629,16 @@ Too many points have been requested as departure or arrival. + + + The indicated multipoint type is not supported. + + + + + Indicated legs do not exist. + + A problem has occurred that does not have a specific problem type. @@ -1636,17 +1646,5 @@ - - - Problem that may be returned in responses to trip requests. - - - - - Type of the trip problem. - - - - - + diff --git a/docs/generated/index.html b/docs/generated/index.html index a88c5cd47..bd45bad90 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -59,18 +59,18 @@

OJP - Open API for distributed Journey 1. OJP.xsd - OJP messages as extension of SIRI
  • 2. OJP/OJP_Requests.xsd - OJP service requests and responses
    • -
  • 3. OJP/OJP_RequestSupport.xsd - Supporting definitions for OJP service requests and their responses
    • +
  • 3. OJP/OJP_RequestSupport.xsd - Supporting definitions for OJP service requests and their responses
  • 4. OJP/OJP_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information
    • -
  • 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
    • +
  • 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_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
    • +
  • 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
  • 12. OJP/OJP_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles
    • -
  • 13. OJP/OJP_Availability.xsd - Request and response definitions for availability of tickets and services on a journey leg.
    • -
  • 14. OJP/OJP_Common.xsd - Supporting definitions of common structures
    • +
  • 13. OJP/OJP_Availability.xsd - Request and response definitions for availability of tickets and services on a journey leg.
    • +
  • 14. OJP/OJP_Common.xsd - Supporting definitions of common structures
  • 15. OJP/OJP_FacilitySupport.xsd - Supporting definitions for facilities containing wrappers for SIRI
  • 16. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
  • 17. OJP/OJP_SituationSupport.xsd - Supporting definitions for situations containing wrappers for SIRI Situation Exchange service (SIRI SX)
    • @@ -93,7 +93,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    FareResponse

    FareResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    FareResult

    0:*

    +FareResult

    Fare result choice element.

    @@ -111,7 +111,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    →‍OJPLocationInformationRequest

    0:1

    →‍OJPLocationInformationRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    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.

    @@ -130,7 +130,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    →‍OJPExchangePointsRequest

    0:1

    →‍OJPExchangePointsRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    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.

    @@ -149,7 +149,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    →‍OJPStopEventRequest

    0:1

    →‍OJPStopEventRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    StopEventResponse

    StopEventResponseContext

    0:1

    +ResponseContext

    Container for data that is referenced multiple times.

    StopEventResult

    0:*

    +StopEventResult

    Enclosing element for stop event data.

    @@ -173,7 +173,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    →‍OJPTripInfoRequest

    0:1

    →‍OJPTripInfoRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    TripInfoResponse

    TripInfoResponseContext

    0:1

    +ResponseContext

    Response context.

    TripInfoResult

    0:1

    +TripInfoResult

    Result structure.

    @@ -198,7 +198,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    →‍OJPTripRequest

    0:1

    →‍OJPTripRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    TripResponse

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    TripResult

    0:*

    +TripResult

    The trip results found by the server.

    @@ -220,7 +220,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    →‍OJPMultiPointTripRequest

    0:1

    →‍OJPMultiPointTripRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    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.

    @@ -240,7 +240,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    →‍OJPTripRefineRequest

    0:1

    →‍OJPTripRefineRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    TripRefineResponse

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    UnknownLegRef

    0:*

    xs:NMTOKEN

    Refers to a leg that was not found in the data of the server. If the to be refined TripResult could not be found or unequivocally determined, all RefineLegRefs are returned as UnknownLegRefs.

    @@ -264,7 +264,7 @@

    OJP - Open API for distributed Journey

    The element contains a sequence of the following elements:

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    -

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    +

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    AvailabilityResponse

    AvailabilityResponseContext

    0:1

    +ResponseContext

    Context to hold availability response objects that occur frequently.

    AvailabilityResult

    0:1

    +AvailabilityResult

    Indication of the availability of the requested service.

    @@ -282,7 +282,7 @@

    OJP - Open API for distributed Journey

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    -

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

    3.1. Simple type definitions

    CalcTimeType

    xs:integer

    Type definition for calculation time in milliseconds.

    CertificateIdType

    xs:NMTOKEN

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

    OJPGenericProblemTypeEnumeration

    OJPGENERIC_REQUESTNOTSUPPORTED | OJPGENERIC_FEATURENOTSUPPORTED | OJPGENERIC_LANGUAGENOTSUPPORTED | OJPGENERIC_EXCEPTIONFROMREQUESTEDLANGUAGE | OJPGENERIC_DATAFRAMEREFNOTAVAILABLE | OJPGENERIC_OTHER

    Types of problems that may be returned in case of generic problems with the request.

    SignatureType

    xs:string

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

    3.2. The MessageIntegrityPropertiesGroup group

    +

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

    3.1. Simple type definitions

    MessageIntegrityPropertiesGroup

    Properties that allow checks for message integrity.

    CalcTimeType

    xs:integer

    Type definition for calculation time in milliseconds.

    CertificateIdType

    xs:NMTOKEN

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

    OJPGenericProblemTypeEnumeration

    OJPGENERIC_REQUESTNOTSUPPORTED | OJPGENERIC_FEATURENOTSUPPORTED | OJPGENERIC_LANGUAGENOTSUPPORTED | OJPGENERIC_EXCEPTIONFROMREQUESTEDLANGUAGE | OJPGENERIC_DATAFRAMEREFNOTAVAILABLE | OJPGENERIC_SYSTEMID_NOT_FOUND | OJPGENERIC_OTHER

    Types of problems that may be returned in case of generic problems with the request.

    SignatureType

    xs:string

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

    3.2. The MessageIntegrityPropertiesGroup group

    MessageIntegrityPropertiesGroup

    Properties that allow checks for message integrity.

    MessageIntegrityProperties

    Signature

    0:1

    Signature

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

    CertificateId

    0:1

    CertificateId

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

    3.3. The ServiceRequestContextGroup group

    @@ -291,7 +291,7 @@

    OJP - Open API for distributed Journey

    ServiceRequestContextGroup

    Generic context for all request messages.

    3.4. The ServiceResponseContextGroup group

    - +

    ServiceResponseContextGroup

    Generic context for all response messages.

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

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

    CalcTime

    0:1

    Calc

    Calculation time.

    Problem

    0:*

    +OJPGenericProblem

    OJP generic problem for the whole delivery.

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    3.5. The complex type AbstractOJPServiceRequestStructure

    @@ -299,18 +299,14 @@

    OJP - Open API for distributed Journey

    -

    AbstractOJPServiceRequestStructure

    siri:AbstractFunctionalServiceRequestStructure

    Basic request structure common for all OJP service requests.

    Extension

    0:1

    xs:anyType

    3.6. The complex type PlacesStructure

    PlacesStructure

    Structure providing a collection of places.

    The element contains only one element:

    Place

    1:*

    +Place

    3.7. The complex type Operators_RelStructure

    Operators_RelStructure

    Structure providing a collection of operators.

    The element contains only one element:

    Operator

    1:*

    siri:AffectedOperatorStructure

    Operator of the service.

    3.8. The complex type ResponseContextStructure

    ResponseContextStructure

    Structure providing response contexts related to journeys, containing collections of places and situations.

    The element contains a sequence of the following elements:

    Operators

    0:1

    +Operators_Rel

    Container for OPERATOR objects. Only operator objects that are referenced in the response should be put into the container.

    Places

    0:1

    +Places

    Container for place objects. Only place objects that are referenced in the response should be put into the container.

    Situations

    0:1

    +Situations

    Container for SIRI SX situation objects. Only situations that are referenced in the response should be put into the container.

    3.9. The complex type OJPGenericProblemStructure

    - - - -

    OJPGenericProblemStructure

    Problem that may be returned in case of generic problems with the request.

    The element contains a sequence of the following elements:

    Type

    1:1

    OJPGenericProblemType

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

    +

    3.6. The complex type PlacesStructure

    PlacesStructure

    Structure providing a collection of places.

    The element contains only one element:

    Place

    1:*

    +Place

    3.7. The complex type Operators_RelStructure

    Operators_RelStructure

    Structure providing a collection of operators.

    The element contains only one element:

    Operator

    1:*

    siri:AffectedOperatorStructure

    Operator of the service.

    3.8. The complex type ResponseContextStructure

    ResponseContextStructure

    Structure providing response contexts related to journeys, containing collections of places and situations.

    The element contains a sequence of the following elements:

    Operators

    0:1

    +Operators_Rel

    Container for OPERATOR objects. Only operator objects that are referenced in the response should be put into the container.

    Places

    0:1

    +Places

    Container for place objects. Only place objects that are referenced in the response should be put into the container.

    Situations

    0:1

    +Situations

    Container for SIRI SX situation objects. Only situations that are referenced in the response should be put into the container.

    3.9. The toplevel element OJPGenericProblemType

    OJPGenericProblemType

    OJPGenericProblemType (↔ ErrorType)

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

    4.1. The FareRequestGroup group

    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

    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. If no FareProductRef is specified the responding system should reply with information about all available fare products.

    4.4. The complex type TripFareRequestStructure

    TripFareRequestStructure

    Structure of a Single Trip Fare Request.

    The element contains a sequence of the following elements:

    TripContext

    0:1

    +ResponseContext

    Context to hold trip related objects that occur frequently. Especially necessary, when the system answering the fare request is not the same as the one that did the trip request.

    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 a sequence of the following elements:

    TripContext

    0:1

    +ResponseContext

    Context to hold trip related objects that occur frequently.

    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.

    FareEstimated

    0:1

    xs:boolean

    Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, TravelClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE.

    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

    ObjectId

    Identifies the "valid from" trip.

    FromLegIdRef

    0:1

    ObjectId

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

    ToTripIdRef

    1:1

    ObjectId

    Identifies the "valid to" trip.

    ToLegIdRef

    0:1

    ObjectId

    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.

    +

    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.

    ErrorCondition

    0:*

    +OJPError

    Problems related to this FARE result.

    FareEstimated

    0:1

    xs:boolean

    Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, TravelClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE.

    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

    ObjectId

    Identifies the "valid from" trip.

    FromLegIdRef

    0:1

    ObjectId

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

    ToTripIdRef

    1:1

    ObjectId

    Identifies the "valid to" trip.

    ToLegIdRef

    0:1

    ObjectId

    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.

    5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips

    5.1. Simple type definitions

    BookingAccessEnumeration

    public | authorisedPublic | staff | other

    Allowed values for Booking Access.

    BookingMethodEnumeration

    callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none

    Allowed values for Flexible Booking method.

    BookingProcessEnumeration

    xs:normalizedString

    Allowed values for Booking Process UIC 7037 Code list.

    ContactTypeEnumeration

    any | information | reservations | lostProperty | publicRelations | complaints | emergency | other

    Allowed values for CONTACT role.

    EmailAddressType

    xs:normalizedString

    Email address type a@b.

    EntitlementProductCodeType

    xs:NMTOKEN

    Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority.

    FareAuthorityCodeType

    xs:NMTOKEN

    Identifier of a Fare Authority.

    FareProblemTypeEnumeration

    FARE_OUTOFAREA | FARE_JOURNEYNOTPERMITTED | FARE_ADDITIONALCHARGES | FARE_ADDITIONALTICKETS | FARE_ROUTENOTFEASIBLE | FARE_ALREADYCOVERED | FARE_DATEOUTOFRANGE | FARE_STOPPOINTUNKNOWN | FARE_OTHER

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

    FareProductIdType

    xs:NMTOKEN

    Identifier of a FareProduct

    GroupBookingEnumeration

    xs:normalizedString

    Allowed values for Group Booking.

    PassengerCategoryEnumeration

    Adult | Child | Senior | Youth | Disabled

    [a simplified and specialised view of USER PROFILE in TM and NeTEx] classification of passengers by age or other factors that may determine the fare they will need to pay.

    Percentage

    xs:decimal

    A percentage value between 0 and 100

    PhoneType

    xs:normalizedString

    Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc.

    PurchaseMomentEnumeration

    xs:normalizedString

    Allowed values for Purchase Moment.

    PurchaseWhenEnumeration

    xs:normalizedString

    Allowed values for Purchase when.

    TariffZoneCodeType

    xs:NMTOKEN

    Identifier of a fare zone.

    TypeOfFareClassEnumeration

    all | first | second | third | business | economy

    classes of travel available on a particular service which will affect the price to be paid

    5.2. The complex type FareAuthorityRefStructure

    FareAuthorityRefStructure

    FareAuthorityCode

    Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs).

    5.3. The toplevel element FareAuthorityRef

    FareAuthorityRef

    +FareAuthorityRef

    Reference to a Fare Authority.

    5.4. The FareAuthorityGroup group

    @@ -369,7 +365,7 @@

    OJP - Open API for distributed Journey

    FareAuthorityGroup

    Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs

    FareAuthority

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    FareAuthorityText

    1:1

    xs:string

    Textual description or name of Fare authority.

    5.26. The LegRangeGroup group

    -

    LegRangeGroup

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

    LegRange

    FromLegIdRef

    1:1

    ObjectId

    Identifies the "valid from" LEG.

    ToLegIdRef

    1:1

    ObjectId

    Identifies the "valid to" LEG.

    5.27. The complex type TripFareResultStructure

    +

    TripFareResultStructure

    Structure of a Single Trip Fare Request result

    The element contains a sequence of the following elements:

    Problem

    0:*

    +FareProblem

    Result-specific error messages.

    5.27. The complex type TripFareResultStructure

    TripFareResultStructure

    Structure of a Single Trip Fare Request result

    The element contains a sequence of the following elements:

    ErrorCondition

    0:*

    +OJPError

    Result-specific error messages.

    LegRange

    FromLegIdRef

    1:1

    ObjectId

    Identifies the "valid from" LEG.

    ToLegIdRef

    1:1

    ObjectId

    Identifies the "valid to" LEG.

    PassedZones

    0:1

    +TariffZoneListInArea

    The sequence of passed fare zones.

    FareProduct

    0:*

    +FareProduct

    One ore more FareProducts that are valid for this part of the trip.

    StaticInfoUrl

    0:*

    +WebLink

    URL to static information page on the web.

    5.28. The complex type FarePassengerStructure

    FarePassengerStructure

    [a specialised form of USER PROFILE in TM and NeTEx] attributes of a passenger that influence the price to be paid by that passenger for a FARE PRODUCT.

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    Age

    -1:1

    xs:nonNegativeInteger

    Age of the passenger on the day of travel.

    b

    PassengerCategory

    -1:1

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    EntitlementProducts

    0:1

    +EntitlementProductList

    A list of ENTITLEMENT PRODUCTs.

    Then, the element contains one of the following elements:

    a

    SalesPackageElementRef

    -1:*

    +FareProductRef

    Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it.

    b

    ZonesAlreadyPaid

    -1:1

    +TariffZoneRefList

    Fare zones for which the passenger already has a valid FareProduct.

    5.29. The FareDataFilterGroup group

    @@ -380,18 +376,10 @@

    OJP - Open API for distributed Journey

    -

    FareDataFilterGroup

    Data filter group for Fare request.

    FareDataFilter

    FareAuthorityFilter

    0:*

    +FareAuthorityRef

    Fare authority for which to retrieve Fare information.

    PassengerCategory

    0:*

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class).

    Traveller

    0:*

    +FarePassenger

    Number of travellers that will make the journey and for which Fare information needs to be gathered.

    5.31. The complex type FareProblemStructure

    - - - -

    FareProblemStructure

    Problem that may be returned in responses to FARE requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    FareProblemType

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

    +

    Traveller

    0:*

    +FarePassenger

    Number of travellers that will make the journey and for which Fare information needs to be gathered.

    5.31. The toplevel element FareProblemType

    FareProblemType

    FareProblemType (↔ ErrorType)

    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

    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.

    AreaGeometry

    0:*

    +Area

    The LINE's main area. Used for MOBILITY SERVICES that cover one or more areas. The interconnection between the areas is not calculated (e.g. exclusion zones can't be modelled). Don't mix RouteGeometry and AreaGeometry in a response.

    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.

    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.

    +

    6.3. The complex type LineResultStructure

    LineResultStructure

    The element contains a sequence of the following elements:

    ErrorCondition

    0:*

    +OJPError

    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.

    AreaGeometry

    0:*

    +Area

    The LINE's main area. Used for MOBILITY SERVICES that cover one or more areas. The interconnection between the areas is not calculated (e.g. exclusion zones can't be modelled). Don't mix RouteGeometry and AreaGeometry in a response.

    Mode

    0:*

    +Mode

    List of transport modes that are supported by this line.

    6.4. The toplevel element LineInformationProblemType

    LineInformationProblemType

    LineInformationProblemType (↔ ErrorType)

    7. OJP/OJP_Location.xsd - Request and response definitions for location information

    7.1. Simple type definitions

    PlaceTypeEnumeration

    stop | address | poi | coord | location | topographicPlace

    PlaceUsageEnumeration

    origin | via | destination

    7.2. The LocationInformationRequestGroup group

    @@ -418,7 +406,7 @@

    OJP - Open API for distributed Journey

    LocationInformationRequestGroup

    The element contains one of the following elements:

    LocationInformationRequest

    a

    InitialInput

    -1:1

    +InitialLocationInput

    Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs.

    b

    PlaceRef

    -1:1

    +PlaceRef

    LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g. streets) which are to be refined in a subsequent request to the next level (e.g. house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement.

    Restrictions

    0:1

    +PlaceParam

    E.g. place types (stops, addresses, POIs) or specific place attributes

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

    +

    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.

    The element contains only one element:

    PolylinePoint

    3:*

    siri:LocationStructure

    Vertices of a polyline defining an area.

    7.10. The complex type PlaceResultStructure

    @@ -472,7 +460,7 @@

    OJP - Open API for distributed Journey

    -

    PlaceResultStructure

    The element contains a sequence of the following elements:

    ErrorCondition

    0:*

    +OJPError

    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.

    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

    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.

    +

    7.19. The complex type ExchangePointsResultStructure

    ExchangePointsResultStructure

    The element contains a sequence of the following elements:

    ErrorCondition

    0:*

    +OJPError

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

    @@ -521,15 +509,7 @@

    OJP - Open API for distributed Journey

    -

    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.

    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

    Position using WGS84/EPSG:4326 coordinates.

    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

    - - - -

    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.

    8.27. The complex type ExchangePointsProblemStructure

    - - - -

    ExchangePointsProblemStructure

    Problem that may be returned in responses to EXCHANGE POINTS requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    ExchangePointsProblemType

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

    +

    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

    Position using WGS84/EPSG:4326 coordinates.

    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 toplevel element LocationProblemType

    LocationProblemType

    LocationProblemType (↔ ErrorType)

    8.27. The toplevel element ExchangePointsProblemType

    ExchangePointsProblemType

    ExchangePointsProblemType (↔ ErrorType)

    9. OJP/OJP_StopEvents.xsd - Request and response definitions for arrivals and departures of public transport services at stops

    9.1. Simple type definitions

    HierarchyEnumeration

    local | no | down | all

    Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided (if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only @@ -593,14 +573,10 @@

    OJP - Open API for distributed Journey

    9.7. The StopEventResponseGroup group

    -

    StopEventResponseGroup

    Response structure for departure and arrival events at stops

    StopEventResponse

    StopEventResponseContext

    0:1

    +ResponseContext

    Container for data that is referenced multiple times.

    StopEventResult

    0:*

    +StopEventResult

    Enclosing element for stop event data.

    9.8. The complex type StopEventResultStructure

    StopEventResultStructure

    Wrapper element for a single stop event result.

    The element contains a sequence of the following elements:

    Id

    1:1

    ObjectId

    ID of this result.

    Problem

    0:*

    +StopEventProblem

    Problems related to this STOPEVENT result.

    StopEvent

    1:1

    +StopEvent

    Stop event data element.

    9.9. The complex type StopEventStructure

    +

    StopEventStructure

    Stop event structure.

    The element contains a sequence of the following elements:

    PreviousCall

    0:*

    +CallAtNearStop

    Calls at stops that happen before this stop event (service pattern of this vehicle journey before this stop event).

    ThisCall

    1:1

    +CallAtNearStop

    The call of this vehicle journey at this stop.

    OnwardCall

    0:*

    +CallAtNearStop

    Calls at stops that happen after this stop event (rest of the service pattern of the vehicle journey).

    Service

    1:1

    +DatedJourney

    Service that calls at this stop.

    9.8. The complex type StopEventResultStructure

    StopEventResultStructure

    Wrapper element for a single stop event result.

    The element contains a sequence of the following elements:

    Id

    1:1

    ObjectId

    ID of this result.

    ErrorCondition

    0:*

    +OJPError

    Problems related to this STOPEVENT result.

    StopEvent

    1:1

    +StopEvent

    Stop event data element.

    9.9. The complex type StopEventStructure

    -

    StopEventStructure

    Stop event structure.

    The element contains a sequence of the following elements:

    PreviousCall

    0:*

    +CallAtNearStop

    Calls at stops that happen before this stop event (service pattern of this vehicle journey before this stop event).

    ThisCall

    1:1

    +CallAtNearStop

    The call of this vehicle journey at this stop.

    OnwardCall

    0:*

    +CallAtNearStop

    Calls at stops that happen after this stop event (rest of the service pattern of the vehicle journey).

    Service

    1:1

    +DatedJourney

    Service that calls at this stop.

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

    SituationFullRefs

    0:1

    +SituationRefList

    For SITUATIONs that affect the whole StopEvent. Otherwise References for SITUATIONs can be added at the different CALL elements

    Extension

    0:1

    xs:anyType

    9.10. The complex type CallAtNearStopStructure

    CallAtNearStopStructure

    indication of the walk distance and time to a nearby stop where relevant.

    The element contains a sequence of the following elements:

    CallAtStop

    1:1

    +CallAtStop

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

    WalkDistance

    0:1

    siri:DistanceType

    Distance from request LOCATION / PLACE (f.e. address) to this stop in metres.

    WalkDuration

    0:1

    xs:duration

    Walking duration from request LOCATION / PLACE (f.e. address) to this stop. All user options taken into account (f.e. walk speed).

    9.11. The complex type StopEventProblemStructure

    - - - -

    StopEventProblemStructure

    Problem that may be returned in responses to STOPEVENT requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    StopEventProblemType

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

    +

    SituationFullRefs

    0:1

    +SituationRefList

    For SITUATIONs that affect the whole StopEvent. Otherwise References for SITUATIONs can be added at the different CALL elements

    Extension

    0:1

    xs:anyType

    9.10. The complex type CallAtNearStopStructure

    CallAtNearStopStructure

    indication of the walk distance and time to a nearby stop where relevant.

    The element contains a sequence of the following elements:

    CallAtStop

    1:1

    +CallAtStop

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

    WalkDistance

    0:1

    siri:DistanceType

    Distance from request LOCATION / PLACE (f.e. address) to this stop in metres.

    WalkDuration

    0:1

    xs:duration

    Walking duration from request LOCATION / PLACE (f.e. address) to this stop. All user options taken into account (f.e. walk speed).

    9.11. The toplevel element StopEventProblemType

    StopEventProblemType

    StopEventProblemType (↔ ErrorType)

    10. OJP/OJP_TripInfo.xsd - Request and response definitions for information on a single trip

    10.1. Simple type definitions

    TripInfoProblemTypeEnumeration

    TRIPINFO_JOURNEYREFUNKNOWN | TRIPINFO_VEHICLEUNKNOWN | TRIPINFO_NOJOURNEYFOUND | TRIPINFO_NOGEOINFO | TRIPINFO_NOREALTIME | TRIPINFO_OTHER

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

    10.2. The TripInfoRequestGroup group

    @@ -633,16 +609,16 @@

    OJP - Open API for distributed Journey

    TripInfoRequestGroup

    TripInfo request structure.

    The element contains one of the following elements:

    DatedJourneyRef

    a

    →‍JourneyRef

    1:1

    →‍JourneyRef

    Reference to a Journey

    10.6. The TripInfoResponseGroup group

    -

    TripInfoResponseGroup

    TripInfo response structure.

    TripInfoResponse

    TripInfoResponseContext

    0:1

    +ResponseContext

    Response context.

    TripInfoResult

    0:1

    +TripInfoResult

    Result structure.

    10.7. The complex type TripInfoResultStructure

    +

    TripInfoResultStructure

    TripInfo result structure containing the current status of a trip.

    The element contains a sequence of the following elements:

    Problem

    0:*

    +TripInfoProblem

    Problems related to this TripInfo result.

    PreviousCall

    0:*

    +CallAtStop

    The stops this service already has called at. Including the current stop if service is currently at stop.

    CurrentPosition

    0:1

    +VehiclePosition

    Current position of this service.

    OnwardCall

    0:*

    +CallAtStop

    The stops this service still has to call at.

    Service

    0:1

    +DatedJourney

    Description of the service.

    10.7. The complex type TripInfoResultStructure

    -

    TripInfoResultStructure

    TripInfo result structure containing the current status of a trip.

    The element contains a sequence of the following elements:

    ErrorCondition

    0:*

    +OJPError

    Problems related to this TripInfo result.

    PreviousCall

    0:*

    +CallAtStop

    The stops this service already has called at. Including the current stop if service is currently at stop.

    CurrentPosition

    0:1

    +VehiclePosition

    Current position of this service.

    OnwardCall

    0:*

    +CallAtStop

    The stops this service still has to call at.

    Service

    0:1

    +DatedJourney

    Description of the service.

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

    →‍siri:ServiceFacilityGroup

    JourneyTrack

    0:1

    +LegTrack

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

    Extension

    0:1

    xs:anyType

    10.8. The complex type TripInfoProblemStructure

    TripInfoProblemStructure

    Problem that may be returned in responses to TripInfo requests.

    The element contains only one element:

    Type

    1:1

    TripInfoProblemType

    Type of the TripInfo problem.

    +

    JourneyTrack

    0:1

    +LegTrack

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

    Extension

    0:1

    xs:anyType

    10.8. The toplevel element TripInfoProblemType

    TripInfoProblemType

    TripInfoProblemType (↔ ErrorType)

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

    11.1. Simple type definitions

    AccessFeatureStatusEnumeration

    unknown | available | partiallyAvailable | notAvailable

    Allowed values for status of the access feature.

    AccessFeatureTypeEnumeration

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

    Allowed values for a AccessFeature.

    AccessibilityFeatureTypesEnumeration

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

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

    FeasibilityEnumeration

    allAccessFeaturesAvailable | accessFeatureNotAvailable | accessFeaturePartiallyAvailable | accessFeatureWithUnknownAvailability | seeSituations

    Allowed values for the feasibility of a TRIP or part of a TRIP.

    GuidanceAdviceEnumeration

    origin | destination | continue | keep | turn | leave | enter | enter_roundabout | stay_in_roundabout | leave_roundabout | enter_builtup_area | leave_builtup_area | freewayAccessRamp | unknown_lane_choice | left_lane | middle_lane | right_lane | unknown_turning_kind

    Various types of guidance advice given to traveller. Suitable values may differ by MODE (e.g. a car driver needs different advice than a person walking for a transfer.

    MultiPointTypeEnumeration

    anyPoint | eachOrigin | eachDestination | eachOriginDestination | somePoints

    How the multiple origin/destination points should be considered. Note: Unfortunately this element was underdefined before and this resulted in different implementations. Note: MultiPointType trumps the number of results. If the algorithm thinks it necessary to provide more results, it should. -

    OptimisationMethodEnumeration

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

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

    TransitionEnumeration

    up | down | level | upAndDown | downAndUp

    Transition types for interchanges.

    TripProblemTypeEnumeration

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

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

    TurnActionEnumeration

    straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action

    The range of possible turns that can be described.

    11.2. The TripRequestGroup group

    +

    TripRequestGroup

    Trip request structure.

    OptimisationMethodEnumeration

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

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

    TransitionEnumeration

    up | down | level | upAndDown | downAndUp

    Transition types for interchanges.

    TripProblemTypeEnumeration

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

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

    TurnActionEnumeration

    straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action

    The range of possible turns that can be described.

    11.2. The TripRequestGroup group

    TripRequestGroup

    Trip request structure.

    TripRequest

    Origin

    1:*

    +PlaceContext

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

    Destination

    1:*

    +PlaceContext

    Specifies the destination situation where the user is heading to.

    Via

    0:*

    +TripVia

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

    OJP - Open API for distributed Journey

    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

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

    IsAlternativeOption

    0:1

    xs:boolean

    When the result is an alternative option from IncludeAlternativeOptions, then the flag should be set to true. If it is an alternative option this means that the server decided to add this result for its own reasons: e.g. to push a certain trip leg, because it believes that it might better suit at least some possible customers. Such options are not an optimal fit to the criteria that were in the request. The client may therefore disregard such results depending on the use case.

    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.

    ErrorCondition

    0:*

    +OJPError

    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.

    IsAlternativeOption

    0:1

    xs:boolean

    When the result is an alternative option from IncludeAlternativeOptions, then the flag should be set to true. If it is an alternative option this means that the server decided to add this result for its own reasons: e.g. to push a certain trip leg, because it believes that it might better suit at least some possible customers. Such options are not an optimal fit to the criteria that were in the request. The client may therefore disregard such results depending on the use case.

    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

    @@ -1035,7 +1011,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

    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

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

    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.

    ErrorCondition

    0:*

    +OJPError

    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

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

    11.34. The MultiPointWaitTimeGroup group

    @@ -1115,11 +1091,7 @@

    OJP - Open API for distributed Journey

    -

    MultiPointWaitTimeGroup

    Group for wait times at origin/destination.

    TripRefineResponse

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    UnknownLegRef

    0:*

    xs:NMTOKEN

    Refers to a leg that was not found in the data of the server. If the to be refined TripResult could not be found or unequivocally determined, all RefineLegRefs are returned as UnknownLegRefs.

    TripResult

    0:*

    +TripResult

    The trip results refined by the server.

    11.39. The complex type TripProblemStructure

    - - - -

    TripProblemStructure

    Problem that may be returned in responses to trip requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    TripProblemType

    Type of the trip problem.

    ProblemDetail

    Title

    0:1

    +InternationalText

    Title of the problem.

    Details

    0:1

    +InternationalText

    Explanation of the problem.

    LogData

    0:1

    xs:string

    Additional log data.

    +

    11.39. The toplevel element TripProblemType

    TripProblemType

    TripProblemType (↔ ErrorType)

    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

    @@ -1433,7 +1405,7 @@

    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

    Reference to a stop point.

    StopPointName

    1:1

    +InternationalText

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

    AvailabilityResponse

    AvailabilityResponseContext

    0:1

    +ResponseContext

    Context to hold availability response objects that occur frequently.

    AvailabilityResult

    0:1

    +AvailabilityResult

    Indication of the availability of the requested service.

    Extension

    0:1

    xs:anyType

    13.11. The complex type AvailabilityResultStructure

    +

    AvailabilityResultStructure

    Availability result structure.

    The element contains a sequence of the following elements:

    Problem

    0:*

    +AvailabilityProblem

    Problems related to this AVAILABILITY result.

    13.11. The complex type AvailabilityResultStructure

    @@ -1441,39 +1413,41 @@

    OJP - Open API for distributed Journey

    AvailabilityResultStructure

    Availability result structure.

    The element contains a sequence of the following elements:

    ErrorCondition

    0:*

    +OJPError

    Problems related to this AVAILABILITY result.

    b

    PublicTransport

    -1:1

    +BookingPTLeg

    Definition of the journey leg that should be made by public transport. Other mobility services may be added later.

    BookableTicketAndServiceInformation

    BookableTicket

    0:*

    +FareProduct

    Sequence of bookable tickets or surcharges for this part of the trip. If ticket price is zero: an already purchased/virtual ticket of this type presented to the driver would be accepted.

    Extension

    0:1

    xs:anyType

    13.12. The BookableTicketAndServiceInformationGroup group

    -

    BookableTicketAndServiceInformationGroup

    Lists those tickets or surcharges and service characteristics such as the transportation of wheelchairs, prams, luggage etc. or the provision of required child seats or booster seats that are offered in the trips transport company to be booked for the trip.

    BookableTicketAndServiceInformation

    BookableTicket

    0:*

    +FareProduct

    Sequence of bookable tickets or surcharges for this part of the trip. If ticket price is zero: an already purchased/virtual ticket of this type presented to the driver would be accepted.

    BookableServiceItem

    0:*

    +BookableServiceItem

    Sequence of bookable service items for this part of the trip.

    13.13. The complex type BookableServiceItemStructure

    BookableServiceItemStructure

    Possible service items that can be booked in the actual booking system (defined by the traffic company of charge). Only those elements with value greater 0 are bookable. The indicated capacity corresponds to the maximum number that can be booked in one booking. This number does not have to be available for the specific booking and may result in booking failure. Caution: list can vary widely from one traffic company to another.

    The element contains a sequence of the following elements:

    Type

    1:1

    BookableServiceItemType

    The type of bookable service.

    MaxBookableCapacity

    1:1

    xs:nonNegativeInteger

    Maximum number of service items that can be booked in one booking transaction. Default is 0.

    13.14. The complex type AvailabilityProblemStructure

    - - +

    AvailabilityProblemStructure

    Problem that may be returned in responses to AVAILABILITY requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    AvailabilityProblemType

    Type of the AVAILABILITY problem.

    ProblemDetail

    Title

    0:1

    +InternationalText

    Title of the problem.

    Details

    0:1

    +InternationalText

    Explanation of the problem.

    13.13. The complex type BookableServiceItemStructure

    BookableServiceItemStructure

    Possible service items that can be booked in the actual booking system (defined by the traffic company of charge). Only those elements with value greater 0 are bookable. The indicated capacity corresponds to the maximum number that can be booked in one booking. This number does not have to be available for the specific booking and may result in booking failure. Caution: list can vary widely from one traffic company to another.

    The element contains a sequence of the following elements:

    Type

    1:1

    BookableServiceItemType

    The type of bookable service.

    MaxBookableCapacity

    1:1

    xs:nonNegativeInteger

    Maximum number of service items that can be booked in one booking transaction. Default is 0.

    13.14. The toplevel element AvailabilityProblemType

    AvailabilityProblemType

    AvailabilityProblemType (↔ ErrorType)

    +

    14. OJP/OJP_Common.xsd - Supporting definitions of common structures

    14.1. Simple type definitions

    JourneyCodeType

    xs:NMTOKEN

    Identifier of a Journey

    ObjectIdType

    xs:normalizedString

    Type for identifier of a NeTEx Object.

    OperatingDayCodeType

    xs:NMTOKEN

    Identifier of an Operating Day

    OwnerCodeType

    xs:NMTOKEN

    identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE

    SharingModelEnumeration

    singleStationBased | multipleStationBased | nonStationBased

    Sharing service loan and return scheme.

    WeekdayTypeEnumeration

    Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | PublicHoliday

    [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays

    14.2. The toplevel element OJPError

    OJPError

    +OJPError (↔ siri:OtherError)

    Error: All OJP related errors.

    14.3. The complex type OJPErrorStructure

    + + + -

    OJPErrorStructure

    siri:OtherErrorStructure

    Type for Error: OJP Error.

    The element contains a sequence of the following elements:

    →‍Error

    1:1

    →‍Error

    ProblemDetail

    Details

    0:1

    +InternationalText

    Explanation of the problem.

    LogData

    0:1

    xs:string

    Additional log data.

    -

    14. OJP/OJP_Common.xsd - Supporting definitions of common structures

    14.1. Simple type definitions

    JourneyCodeType

    xs:NMTOKEN

    Identifier of a Journey

    ObjectIdType

    xs:normalizedString

    Type for identifier of a NeTEx Object.

    OperatingDayCodeType

    xs:NMTOKEN

    Identifier of an Operating Day

    OwnerCodeType

    xs:NMTOKEN

    identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE

    SharingModelEnumeration

    singleStationBased | multipleStationBased | nonStationBased

    Sharing service loan and return scheme.

    WeekdayTypeEnumeration

    Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | PublicHoliday

    [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays

    14.2. The ProblemDetailGroup group

    - - + + +

    ProblemDetailGroup

    Detailed description of the problem.

    ProblemDetail

    Title

    0:1

    +InternationalText

    Title of the problem.

    Details

    0:1

    +InternationalText

    Explanation of the problem.

    14.4. The toplevel element ErrorType

    ErrorType

    xs:string

    14.5. The ProblemDetailGroup group

    + -

    ProblemDetailGroup

    Detailed description of the problem.

    ProblemDetail

    Details

    0:1

    +InternationalText

    Explanation of the problem.

    LogData

    0:1

    xs:string

    Additional log data.

    14.3. The complex type PrivateCodeStructure

    PrivateCodeStructure

    Code within scope of a private referential system

    The element contains a sequence of the following elements:

    System

    1:1

    xs:NMTOKEN

    Code of the foreign referential system.

    Value

    1:1

    xs:NMTOKEN

    Object code within this private/foreign system.

    14.4. The complex type LinearShapeStructure

    LinearShapeStructure

    An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure.

    The element contains only one element:

    Position

    2:*

    siri:LocationStructure

    Ordered list of locations representing the geometry of the link or route.

    14.5. The complex type AreaStructure

    AreaStructure

    Area described as a polygon.

    The element contains only one element:

    Points

    3:*

    siri:LocationStructure

    Ordered list of geographic locations describing the polygon of the area.

    14.6. The toplevel element ParticipantRef

    ParticipantRef

    siri:ParticipantRefStructure

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

    14.7. The toplevel element OperatorRef

    OperatorRef

    siri:OperatorRefStructure

    Reference to an Operator ([TMv6] company providing public transport services.)

    14.8. The complex type OperatorRefs_RelStructure

    OperatorRefs_RelStructure

    The element contains only one element:

    OperatorRef

    1:*

    siri:OperatorRefStructure

    14.9. The complex type OperatorFilterStructure

    OperatorFilterStructure

    Filter for in/exclusion of transport operators.

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

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

    OperatorRef

    0:*

    siri:OperatorRefStructure

    Reference to transport operator

    14.10. The toplevel element ProductCategoryRef

    ProductCategoryRef

    siri:ProductCategoryRefStructure

    Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g. NeTEx, SIRI, OJP).

    14.11. The complex type LineDirectionFilterStructure

    LineDirectionFilterStructure

    Filter for in/exclusion of lines (and directions).

    The element contains a sequence of the following elements:

    Line

    1:*

    siri:LineDirectionStructure

    Reference to a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables.

    Exclude

    0:1

    xs:boolean

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

    14.12. The complex type JourneyRefStructure

    JourneyRefStructure

    JourneyCode

    Reference to a Journey

    14.13. The toplevel element JourneyRef

    JourneyRef

    +JourneyRef

    Reference to a Journey

    14.14. The DatedJourneyRefGroup group

    +

    DatedJourneyRefGroup

    Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day)

    14.6. The complex type PrivateCodeStructure

    PrivateCodeStructure

    Code within scope of a private referential system

    The element contains a sequence of the following elements:

    System

    1:1

    xs:NMTOKEN

    Code of the foreign referential system.

    Value

    1:1

    xs:NMTOKEN

    Object code within this private/foreign system.

    14.7. The complex type LinearShapeStructure

    LinearShapeStructure

    An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure.

    The element contains only one element:

    Position

    2:*

    siri:LocationStructure

    Ordered list of locations representing the geometry of the link or route.

    14.8. The complex type AreaStructure

    AreaStructure

    Area described as a polygon.

    The element contains only one element:

    Points

    3:*

    siri:LocationStructure

    Ordered list of geographic locations describing the polygon of the area.

    14.9. The toplevel element ParticipantRef

    ParticipantRef

    siri:ParticipantRefStructure

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

    14.10. The toplevel element OperatorRef

    OperatorRef

    siri:OperatorRefStructure

    Reference to an Operator ([TMv6] company providing public transport services.)

    14.11. The complex type OperatorRefs_RelStructure

    OperatorRefs_RelStructure

    The element contains only one element:

    OperatorRef

    1:*

    siri:OperatorRefStructure

    14.12. The complex type OperatorFilterStructure

    OperatorFilterStructure

    Filter for in/exclusion of transport operators.

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

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

    OperatorRef

    0:*

    siri:OperatorRefStructure

    Reference to transport operator

    14.13. The toplevel element ProductCategoryRef

    ProductCategoryRef

    siri:ProductCategoryRefStructure

    Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g. NeTEx, SIRI, OJP).

    14.14. The complex type LineDirectionFilterStructure

    LineDirectionFilterStructure

    Filter for in/exclusion of lines (and directions).

    The element contains a sequence of the following elements:

    Line

    1:*

    siri:LineDirectionStructure

    Reference to a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables.

    Exclude

    0:1

    xs:boolean

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

    14.15. The complex type JourneyRefStructure

    JourneyRefStructure

    JourneyCode

    Reference to a Journey

    14.16. The toplevel element JourneyRef

    JourneyRef

    +JourneyRef

    Reference to a Journey

    14.17. The DatedJourneyRefGroup group

    -

    DatedJourneyRefGroup

    Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day)

    DatedJourneyRef

    →‍JourneyRef

    1:1

    →‍JourneyRef

    Reference to a Journey

    →‍OperatingDayRef

    1:1

    →‍OperatingDayRef

    Reference to an Operating Day

    14.15. The TimedVehicleRefGroup group

    +

    TimedVehicleRefGroup

    Reference to a vehicle for a specific point in time.

    14.18. The TimedVehicleRefGroup group

    -

    TimedVehicleRefGroup

    Reference to a vehicle for a specific point in time.

    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.16. 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.17. The SharingServiceUsageGroup group

    +

    SharingServiceUsageGroup

    Usage parameters of a sharing service.

    14.19. 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.20. The SharingServiceUsageGroup group

    -

    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.

    TimeBufferAfter

    0:1

    xs:duration

    Typical time a user will need to lock the vehicle and check out.

    14.18. The complex type SharingServiceStructure

    +

    SharingServiceStructure

    Service that provides shared vehicles.

    The element contains a sequence of the following elements:

    OperatorRef

    1:1

    siri:OperatorRefStructure

    Identifier of the operator of the sharing service

    Name

    0:1

    xs:string

    Public name of the service.

    SharingModel

    0:1

    SharingModel

    Type of the sharing scheme.

    14.21. The complex type SharingServiceStructure

    -

    SharingServiceStructure

    Service that provides shared vehicles.

    The element contains a sequence of the following elements:

    OperatorRef

    1:1

    siri:OperatorRefStructure

    Identifier of the operator of the sharing service

    Name

    0:1

    xs:string

    Public name of the service.

    SharingModel

    0:1

    SharingModel

    Type of the sharing scheme.

    SharingServiceUsage

    TimeBufferBefore

    0:1

    xs:duration

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

    TimeBufferAfter

    0:1

    xs:duration

    Typical time a user will need to lock the vehicle and check out.

    InfoUrl

    0:1

    +WebLink

    Link to web page providing more details on service.

    14.19. The complex type OwnerRefStructure

    OwnerRefStructure

    OwnerCode

    Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

    14.20. The toplevel element OwnerRef

    OwnerRef

    +OwnerRef

    Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

    14.21. The complex type OperatingDayRefStructure

    OperatingDayRefStructure

    OperatingDayCode

    Reference to an Operating Day

    14.22. The toplevel element OperatingDayRef

    OperatingDayRef

    +OperatingDayRef

    Reference to an Operating Day

    14.23. The complex type OperatingDaysStructure

    OperatingDaysStructure

    [TMv6] day of public transport operation of which the characteristics are defined in a specific SERVICE CALENDAR and which may last more than 24 hours.

    The element contains a sequence of the following elements:

    From

    1:1

    xs:date

    Start date of period.

    To

    1:1

    xs:date

    End date of period.

    Pattern

    1:1

    ValidDayBit

    Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event actually happens on the day that is represented by the bit position.

    14.24. The OperatingDaysGroup group

    +

    OperatingDaysGroup

    Coded as bit pattern

    InfoUrl

    0:1

    +WebLink

    Link to web page providing more details on service.

    14.22. The complex type OwnerRefStructure

    OwnerRefStructure

    OwnerCode

    Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

    14.23. The toplevel element OwnerRef

    OwnerRef

    +OwnerRef

    Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

    14.24. The complex type OperatingDayRefStructure

    OperatingDayRefStructure

    OperatingDayCode

    Reference to an Operating Day

    14.25. The toplevel element OperatingDayRef

    OperatingDayRef

    +OperatingDayRef

    Reference to an Operating Day

    14.26. The complex type OperatingDaysStructure

    OperatingDaysStructure

    [TMv6] day of public transport operation of which the characteristics are defined in a specific SERVICE CALENDAR and which may last more than 24 hours.

    The element contains a sequence of the following elements:

    From

    1:1

    xs:date

    Start date of period.

    To

    1:1

    xs:date

    End date of period.

    Pattern

    1:1

    ValidDayBit

    Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event actually happens on the day that is represented by the bit position.

    14.27. The OperatingDaysGroup group

    -

    OperatingDaysGroup

    Coded as bit pattern

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

    14.25. The complex type WeekdayTimePeriodStructure

    WeekdayTimePeriodStructure

    [a specialisation of TIME BAND in TMv6] aggregation of TIME BAND and DAY OF WEEK (Time period on a weekday).

    The element contains a sequence of the following elements:

    Weekday

    0:*

    WeekdayType

    [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays

    StartTime

    1:1

    xs:time

    Start time of period.

    Duration

    1:1

    xs:duration

    Time duration of period.

    14.26. The complex type GeneralAttributeStructure

    +

    GeneralAttributeStructure

    Structured attribute classification with associated text. If URL is given, it refers to the whole attribute text.

    The element contains a sequence of the following elements:

    Text

    1:1

    +InternationalText

    Text of the attribute to be shown to the user.

    Code

    1:1

    xs:NMTOKEN

    Internal code of the attribute. Can be used for detection of double occurrences.

    14.28. The complex type WeekdayTimePeriodStructure

    WeekdayTimePeriodStructure

    [a specialisation of TIME BAND in TMv6] aggregation of TIME BAND and DAY OF WEEK (Time period on a weekday).

    The element contains a sequence of the following elements:

    Weekday

    0:*

    WeekdayType

    [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays

    StartTime

    1:1

    xs:time

    Start time of period.

    Duration

    1:1

    xs:duration

    Time duration of period.

    14.29. The complex type GeneralAttributeStructure

    -

    GeneralAttributeStructure

    Structured attribute classification with associated text. If URL is given, it refers to the whole attribute text.

    The element contains a sequence of the following elements:

    Text

    1:1

    +InternationalText

    Text of the attribute to be shown to the user.

    Code

    1:1

    xs:NMTOKEN

    Internal code of the attribute. Can be used for detection of double occurrences.

    →‍siri:AllFacilitiesGroup

    Mandatory

    0:1

    xs:boolean

    Defines whether the attribute has to be shown to the user.

    Importance

    0:1

    Percent

    Importance of the attribute.

    WebLink

    Url

    1:1

    xs:anyURI

    URL to resource on web.

    MimeType

    0:1

    xs:normalizedString

    MIME type of the referenced resource. To which kind of resource does the URL point to?

    Embeddable

    0:1

    xs:boolean

    Is the referenced resource meant to be embedded as a webview in a surrounding context, e.g. app or web page? If yes, the resource has to be fully responsive. Default is false.

    14.27. The SustainabilityGroup group

    +

    SustainabilityGroup

    Elements about sustainability. Primarily for TRIPs and LEGs.

    14.30. The SustainabilityGroup group

    -

    SustainabilityGroup

    Elements about sustainability. Primarily for TRIPs and LEGs.

    Sustainability

    EmissionCO2

    0:1

    +EmissionCO2

    Estimation of CO2 emissions.

    14.28. The complex type EmissionCO2Structure

    +

    EmissionCO2Structure

    Estimation of CO2 emissions.

    The element contains a sequence of the following elements:

    KilogramPerPersonKm

    1:1

    Kilograms of CO2 emission by person and by kilometre.

    14.31. The complex type EmissionCO2Structure

    diff --git a/examples/functions/error/ErrorResponse_1.xml b/examples/functions/error/ErrorResponse_1.xml new file mode 100644 index 000000000..60f76e3ad --- /dev/null +++ b/examples/functions/error/ErrorResponse_1.xml @@ -0,0 +1,59 @@ + + + + + 2022-12-01T17:54:38Z + OJPCH_Prod + true + + 2022-12-01T17:54:38Z + 4711 + true + + + Error text + OJPGENERIC_DATAFRAMEREFNOTAVAILABLE + + + + + + Main error text + LINEINFORMATION_LINEUNKNOWN + + Line is no longer valid. + + Internal error 5051231: line not valid. + + ch:slnid:123123 + IC8 + + + 7.48464 + 46.93150 + + + 7.48447 + 46.93141 + + + 7.48441 + 46.93138 + + + 7.48437 + 46.93134 + + + + rail + longDistanceTrain + + Intercity + + + + + + + diff --git a/examples/functions/error/error_response.xml b/examples/functions/error/error_response.xml index 39fa1bafb..e3219b06a 100644 --- a/examples/functions/error/error_response.xml +++ b/examples/functions/error/error_response.xml @@ -14,7 +14,10 @@ STOPEVENT_NOEVENTFOUND - 78 + 23 + + STOPEVENT_NOEVENTFOUND + diff --git a/examples/functions/error/error_response_2.xml b/examples/functions/error/error_response_2.xml new file mode 100644 index 000000000..d7f75c88a --- /dev/null +++ b/examples/functions/error/error_response_2.xml @@ -0,0 +1,100 @@ + + + + + 2020-11-30T10:07:19Z + OJPCH_Prod + true + + 2020-11-30T10:07:19Z + 756 + true + 60 + + TRIPINFO_NOGEOINFO + + + + TRIPINFO_NOGEOINFO + + + 8591315 + + Zürich, Rehalp + + + 2020-12-01T12:15:00Z + + 1 + + + + 8591049 + + Zürich, Auzelg + + + 2020-12-01T13:01:00Z + + 34 + + + Unknown + ojp:91011:A:R:j20:719 + ojp:91011:A + R + + tram + cityTram + + Tram + + + T + + + + 11 + + + ojp:3849 + + 8591315 + + Zürich, Rehalp + + 8591049 + + Basel, St-Louis Grenze + + + + + + 8591315 + + Zürich, Rehalp + + + + 8591049 + + Zürich, Auzelg + + + 55032 + + + + + + + + 8527 + + + + + + + diff --git a/examples/functions/fare/FareResponse.xml b/examples/functions/fare/FareResponse.xml index 5edeb45c1..f9f770b80 100644 --- a/examples/functions/fare/FareResponse.xml +++ b/examples/functions/fare/FareResponse.xml @@ -2,10 +2,12 @@ 2001-12-17T09:30:47Z true + + + FARE_ADDITIONALCHARGES + + 2001-12-18T09:30:47Z - - OJPGENERIC_OTHER - @@ -20,6 +22,9 @@ 1231231112231 + + FARE_ADDITIONALTICKETS + 1 1

    EmissionCO2Structure

    Estimation of CO2 emissions.

    The element contains a sequence of the following elements:

    KilogramPerPersonKm

    1:1

    Kilograms of CO2 emission by person and by kilometre.