diff --git a/OJP/OJP_Common.xsd b/OJP/OJP_Common.xsd index a61932047..187fe0f6a 100644 --- a/OJP/OJP_Common.xsd +++ b/OJP/OJP_Common.xsd @@ -8,23 +8,28 @@ ========================================== General ========================================== - + - Structured error messages + Detailed description of the problem. - + - Code of the error situation. + Title of the problem. - + - Description of the error situation. + Explanation of the problem. + + + + + Additional log data. - + Code within scope of a private referential system diff --git a/OJP/OJP_Fare.xsd b/OJP/OJP_Fare.xsd index f1734a98a..6280723c9 100644 --- a/OJP/OJP_Fare.xsd +++ b/OJP/OJP_Fare.xsd @@ -119,6 +119,11 @@ ID of this result. + + + Problems related to this FARE result. + + @@ -207,11 +212,6 @@ Structure of a Multi Trip Fare Request result - - - Result-specific error messages. - - Non-empty list of trip references in the corresponding MultiTripFareRequestStructure diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd index 2c7b32b17..505e6e080 100644 --- a/OJP/OJP_FareSupport.xsd +++ b/OJP/OJP_FareSupport.xsd @@ -389,11 +389,6 @@ Structure of a Single Trip Fare Request result - - - Result-specific error messages - - @@ -486,4 +481,72 @@ + + ========================================== Problems ========================================== + + + + Types of problems that may be returned in responses to FARE requests. + + + + + The trip planning has found a route that leaves the area of the fare authority. + + + + + The trip planning result suggests a service which is not permitted by the fare authority. + + + + + Passengers may be charged additional fees (e.g.: for road tolls or seat reservation). + + + + + Additional tickets may be necessary because only parts of the passenger trip could be covered. + + + + + Fare calculation is not possible because the suggested trip is not in compliance with the fare regulations, e.g. because of round trips, TripLegs that go forth and return or exceed the maximal total trip duration. + + + + + The ticket that has been specified in the request is valid for the suggested trip (or parts of it as defined by TripLegRange). + + + + + The fare request cannot be processed because there is no information available for the requested date. + + + + + The fare request cannot be processed because the requested stop is unknown. + + + + + A problem has occurred that does not have a specific problem type. + + + + + + + Problem that may be returned in responses to FARE requests. + + + + + Type of the FARE problem. + + + + + diff --git a/OJP/OJP_PlaceSupport.xsd b/OJP/OJP_PlaceSupport.xsd index 7be90d98b..a42640476 100644 --- a/OJP/OJP_PlaceSupport.xsd +++ b/OJP/OJP_PlaceSupport.xsd @@ -467,4 +467,107 @@ + + ========================================== Problems ========================================== + + + + Types of problems that may be returned in responses to LOCATION requests. + + + + + No location objects could be found that match the input data. + + + + + The requested location types are not supported by the service. + + + + + The combination of input data (text string, coordinates, geographical restrictions) cannot be processed by the service. + + + + + The given location object could not be refined. + + + + + The usage type has been ignored. + + + + + The service does not support any restrictions by transport modes. + + + + + The service does not support any restrictions by localities. + + + + + A problem has occurred that does not have a specific problem type. + + + + + + + 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 + + + + + No exchange points could be found that match the query criteria. + + + + + The destination system given in the request parameters is unknown. + + + + + One or more of the adjacent systems given in the request parameters are unknown. + + + + + A problem has occurred that does not have a specific problem type. + + + + + + + Problem that may be returned in responses to EXCHANGE POINTS requests. + + + + + Type of the EXCHANGE POINTS problem. + + + + + diff --git a/OJP/OJP_Places.xsd b/OJP/OJP_Places.xsd index 610227c2d..bbfbce493 100644 --- a/OJP/OJP_Places.xsd +++ b/OJP/OJP_Places.xsd @@ -119,6 +119,11 @@ + + + Problems related to this LOCATION result. + + @@ -152,7 +157,7 @@ - Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (eg: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response. + Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g.: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response. @@ -324,6 +329,11 @@ + + + Problems related to this EXCHANGE POINTS result. + + Place object that describes this exchange point. @@ -331,7 +341,7 @@ - Rough estimate of the travel duration from the specified refrence place to this exchange point. + Rough estimate of the travel duration from the specified reference place to this exchange point. diff --git a/OJP/OJP_RequestSupport.xsd b/OJP/OJP_RequestSupport.xsd index 175111ae1..05f573235 100644 --- a/OJP/OJP_RequestSupport.xsd +++ b/OJP/OJP_RequestSupport.xsd @@ -74,6 +74,11 @@ Calculation time. + + + OJP generic problem for the whole delivery. + + @@ -178,4 +183,57 @@ + + ========================================== Problems ========================================== + + + + Types of problems that may be returned in case of generic problems with the request. + + + + + The server does not support the specific request (e.g.: MultiPointTripRequest). + + + + + The server does not support the requested feature (e.g.: parameter NotVia in TripRequest). + + + + + For the display of texts within the result, the server (at least in the context of this request) does not support the requested language. + + + + + When displaying texts within the result, the server does not support the requested language for all occurring text elements. + + + + + The server cannot provide the requested data frame (data version). + + + + + A problem has occurred that does not have a specific problem type. + + + + + + + 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 dac130ac0..fcfeaaff2 100644 --- a/OJP/OJP_StopEvents.xsd +++ b/OJP/OJP_StopEvents.xsd @@ -189,9 +189,9 @@ ID of this result. - + - Error messages that refer to this stop event. + Problems related to this STOPEVENT result. @@ -252,4 +252,62 @@ + + ========================================== Problems ========================================== + + + + Types of problems that may be returned in responses to STOPEVENT requests. + + + + + No departure/arrival could be found within the requested period of time that meets the given restrictions. + + + + + At the locations (address, stop, etc.) for which stop events have been requested, there is no public transport service at all. + + + + + The location (address, stop, etc.) for which stop events were requested is unknown. + + + + + There are no timetables available for the requested date. + + + + + This departure/arrival event is the last one of this line for this operating day. + + + + + There is no realtime or forecast data available for this departure/arrival event. + + + + + A problem has occurred that does not have a specific problem type. + + + + + + + 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 5fcc1dd46..e1705429c 100644 --- a/OJP/OJP_TripInfo.xsd +++ b/OJP/OJP_TripInfo.xsd @@ -112,6 +112,11 @@ TripInfo result structure containing the current status of a trip. + + + Problems related to this TripInfo result. + + The stops this service already has called at. Including the current stop if service is currently at stop. @@ -142,4 +147,51 @@ + + ========================================== Problems ========================================== + + + + Types of problems that may be returned in responses to TripInfo requests. + + + + + The journey reference used in the request is unknown. + + + + + The vehicle reference used in the request is unknown. + + + + + No matching journey could be found for the requested time and journey/vehicle identifiers. + + + + + No geographic information available for this vehicle journey. + + + + + A problem has occurred that does not have a specific problem type. + + + + + + + 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 1be315e9d..1de03163b 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -232,7 +232,7 @@ - Structure for a single trip result and its accompanying error messages. + Structure for a single trip result and associated problems. @@ -240,9 +240,9 @@ Id of this trip result for referencing purposes. Unique within trip response. - + - Error messages related to this trip result. + Problems related to this Trip result. @@ -943,7 +943,7 @@ - Structure for a single trip result and its accompanying error messages. + Structure for a multipoint trip result and associated problems @@ -951,9 +951,9 @@ Id of this trip result for referencing purposes. Unique within multipoint-trip response. - + - Error messages related to trip result. + Problems related to this trip result. @@ -1091,4 +1091,137 @@ + + ========================================== Problems ========================================== + + + + Types of problems that may be returned in responses to Trip requests. + + + + + No trip plan could be found that meets all the parameters as they have been set by the user (start and end locations, departure/arrival time and further options possibly set by the user). + + + + + The start location (address, stop place, …) for the requested trip is unknown. + + + + + The end location (address, stop place, …) for the requested trip is unknown. + + + + + One of the via points is unknown. + + + + + One of the not-via points is unknown. + + + + + One of the no-change-at stations is unknown. + + + + + No start location has been defined for the trip. + + + + + No end location has been defined for the trip. + + + + + Start and end of the trip are identical. + + + + + The requested date and/or time do not make sense. + + + + + The requested departure time at each origin is after the requested arrival time at any destination. + + + + + There is no timetable data available for the requested date. + + + + + The requested origin stop place has been replaced by an equivalent stop place. + + + + + The requested destination stop place has been replaced by an equivalent stop place. + + + + + One of the requested via stop places has been replaced by an equivalent stop place. + + + + + There is no realtime information available for at least one of the services within this trip result. + + + + + The maximum time allowed for using modes of individual transport (mostly walking or cycling) has been extended by the system because otherwise no trip could be found. + + + + + The mode of individual transport specified by the user has been replaced by the system because otherwise no trip could be found. Usually this means taking a taxi instead of walking. + + + + + The trip plan in this trip result contains a long waiting time. + + + + + No trip solution was found covering each of the requested points. + + + + + Too many points have been requested as departure or arrival. + + + + + A problem has occurred that does not have a specific problem type. + + + + + + + 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 630d83c67..134e72211 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -57,27 +57,31 @@

OJP - Open API for distributed Journey Table of Contents

1. OJP.xsd - OJP messages as extension of SIRI

1.1. The toplevel element OJP

OJP

Root element for OJP messages based on SIRI message exchange protocol.

@version

1:1

xs:NMTOKEN

Fixed value: "1.1-dev"

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

→‍OJPRequest

-1:1

→‍OJPRequest

OJP Request - Groups individual functional requests.

b

→‍OJPResponse

-1:1

→‍OJPResponse

OJP Request - Groups individual functional responses.

→‍Extensions

0:1

→‍Extensions

1.2. The toplevel element OJPRequest

OJPRequest

+OJPRequest

OJP Request - Groups individual functional requests.

1.3. The complex type OJPRequestStructure

OJPRequestStructure

Type for OJP Request - Groups individual functional requests.

The element contains only one element:

→‍RequestGroup

1.4. The toplevel element OJPResponse

OJPResponse

+OJPResponse

OJP Request - Groups individual functional responses.

1.5. The complex type OJPResponseStructure

OJPResponseStructure

Type for OJP Response - Groups individual functional responses.

The element contains only one element:

→‍ResponseGroup

-

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

2.1. Simple type definitions

JourneyCodeType

xs:NMTOKEN

Identifier of a Journey

OperatingDayCodeType

xs:NMTOKEN

Identifier of an Operating Day

OwnerCodeType

xs:NMTOKEN

identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE

ProductCategoryCodeType

xs:NMTOKEN

Type for identifier of an product category code.

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

2.2. The complex type ErrorMessageStructure

ErrorMessageStructure

Structured error messages

The element contains a sequence of the following elements:

Code

1:1

xs:normalizedString

Code of the error situation.

Text

0:1

+InternationalText

Description of the error situation.

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

2.4. The complex type LinkProjectionStructure

LinkProjectionStructure

An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE.

The element contains only one element:

Position

2:*

siri:LocationStructure

Ordered list of locations representing the geogemtry of the link.

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

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

2.7. The toplevel element OperatorRef

OperatorRef

siri:OperatorRefStructure

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

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

2.9. The complex type ProductCategoryRefStructure

ProductCategoryRefStructure

ProductCategoryCode

Reference to a product category. As defined in NeTEx and SIRI, a product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products, e.g. to identify boats that run with steam in Switzerland ("BAV")

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

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

2.12. The complex type JourneyRefStructure

JourneyRefStructure

JourneyCode

Reference to a Journey

2.13. The toplevel element JourneyRef

JourneyRef

+JourneyRef

Reference to a Journey

2.14. The DatedJourneyRefGroup group

+

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

2.1. Simple type definitions

DatedJourneyRefGroup

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

JourneyCodeType

xs:NMTOKEN

Identifier of a Journey

OperatingDayCodeType

xs:NMTOKEN

Identifier of an Operating Day

OwnerCodeType

xs:NMTOKEN

identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE

ProductCategoryCodeType

xs:NMTOKEN

Type for identifier of an product category code.

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

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

LogData

0:1

xs:string

Additional log data.

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

2.4. The complex type LinkProjectionStructure

LinkProjectionStructure

An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE.

The element contains only one element:

Position

2:*

siri:LocationStructure

Ordered list of locations representing the geogemtry of the link.

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

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

2.7. The toplevel element OperatorRef

OperatorRef

siri:OperatorRefStructure

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

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

2.9. The complex type ProductCategoryRefStructure

ProductCategoryRefStructure

ProductCategoryCode

Reference to a product category. As defined in NeTEx and SIRI, a product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products, e.g. to identify boats that run with steam in Switzerland ("BAV")

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

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

2.12. The complex type JourneyRefStructure

JourneyRefStructure

JourneyCode

Reference to a Journey

2.13. The toplevel element JourneyRef

JourneyRef

+JourneyRef

Reference to a Journey

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

2.15. The TimedVehicleRefGroup group

@@ -112,8 +116,8 @@

OJP - Open API for distributed Journey

TimedVehicleRefGroup

Reference to a vehicle for a specific point in time.

4.2. The complex type StopFareRequestStructure

StopFareRequestStructure

Sub-request: stop-related fare information.

The element contains a sequence of the following elements:

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

Date

0:1

xs:date

Date for which to retrieve Fare information.

4.3. The complex type StaticFareRequestStructure

StaticFareRequestStructure

General Fare information. May depend on date.

The element contains a sequence of the following elements:

Date

0:1

xs:date

Date for which to retrieve Fare information.

→‍FareProductRef

0:*

→‍FareProductRef

Reference to a FareProduct.

4.4. The complex type TripFareRequestStructure

TripFareRequestStructure

Structure of a Single Trip Fare Request.

The element contains only one element:

Trip

1:1

+Trip

A complete trip from origin to destination

4.5. The complex type MultiTripFareRequestStructure

MultiTripFareRequestStructure

Structure of a Multi Trip Fare Request.

The element contains only one element:

Trip

1:*

+Trip

Multiple complete trips from multiple origins and multiple destination

4.6. The FareResponseGroup group

-

FareResponseGroup

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:

ResultId

1:1

xs:NMTOKEN

ID of this result.

Then, the element contains one of the following elements:

a

MultiTripFareResult

-1:*

+MultiTripFareResult

Fare and FareProducts for multiple trips.

b

StaticFareResult

-1:1

+StaticFareResult

Static Fare information.

c

StopFareResult

-1:1

+StopFareResult

Stop-related Fare information.

d

TripFareResult

-1:*

+TripFareResult

Fare and FareProducts for a given trip.

4.8. The complex type StopFareResultStructure

StopFareResultStructure

Stop-related Fare information.

The element contains a sequence of the following elements:

TariffZoneListInArea

1:*

+TariffZoneListInArea

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

Extension

0:1

xs:anyType

4.9. The complex type StaticFareResultStructure

StaticFareResultStructure

General Fare information.

The element contains a sequence of the following elements:

FareProduct

0:*

+FareProduct

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

StaticInfoUrl

0:*

+WebLink

URL to information page on the web.

Extension

0:1

xs:anyType

4.10. The complex type TripFareProductReferenceStructure

TripFareProductReferenceStructure

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

The element contains a sequence of the following elements:

→‍FareProductRef

1:1

→‍FareProductRef

Reference to a FareProduct.

FromTripIdRef

1:1

xs:NMTOKEN

Identifies the "valid from" trip.

FromTripLegIdRef

0:1

xs:NMTOKEN

Identifies the "valid from" tripLeg. If missing, then valid from the first leg.

ToTripIdRef

1:1

xs:NMTOKEN

Identifies the "valid to" trip.

ToTripLegIdRef

0:1

xs:NMTOKEN

Identifies the "valid to" tripLeg. 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:

ErrorMessage

0:*

+ErrorMessage

Result-specific error messages.

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

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.

FareProductCodeType

xs:NMTOKEN

Identifier of a FareProduct

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

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

+

FareAuthorityGroup

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

4.7. The complex type FareResultStructure

FareResultStructure

Wrapper element for Fare results.

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

ID of this result.

Problem

0:*

+FareProblem

Problems related to this FARE result.

Then, the element contains one of the following elements:

a

MultiTripFareResult

-1:*

+MultiTripFareResult

Fare and FareProducts for multiple trips.

b

StaticFareResult

-1:1

+StaticFareResult

Static Fare information.

c

StopFareResult

-1:1

+StopFareResult

Stop-related Fare information.

d

TripFareResult

-1:*

+TripFareResult

Fare and FareProducts for a given trip.

4.8. The complex type StopFareResultStructure

StopFareResultStructure

Stop-related Fare information.

The element contains a sequence of the following elements:

TariffZoneListInArea

1:*

+TariffZoneListInArea

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

Extension

0:1

xs:anyType

4.9. The complex type StaticFareResultStructure

StaticFareResultStructure

General Fare information.

The element contains a sequence of the following elements:

FareProduct

0:*

+FareProduct

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

StaticInfoUrl

0:*

+WebLink

URL to information page on the web.

Extension

0:1

xs:anyType

4.10. The complex type TripFareProductReferenceStructure

TripFareProductReferenceStructure

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

The element contains a sequence of the following elements:

→‍FareProductRef

1:1

→‍FareProductRef

Reference to a FareProduct.

FromTripIdRef

1:1

xs:NMTOKEN

Identifies the "valid from" trip.

FromTripLegIdRef

0:1

xs:NMTOKEN

Identifies the "valid from" tripLeg. If missing, then valid from the first leg.

ToTripIdRef

1:1

xs:NMTOKEN

Identifies the "valid to" trip.

ToTripLegIdRef

0:1

xs:NMTOKEN

Identifies the "valid to" tripLeg. 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

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.

FareProductCodeType

xs:NMTOKEN

Identifier of a FareProduct

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

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

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.5. The complex type TariffZoneRefStructure

TariffZoneRefStructure

Reference to a fare zone.

5.6. The toplevel element TariffZoneRef

TariffZoneRef

+TariffZoneRef

Reference to a fare zone.

5.7. The complex type TariffZoneStructure

TariffZoneStructure

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

The element contains a sequence of the following elements:

→‍TariffZoneRef

1:1

→‍TariffZoneRef

Reference to a fare zone.

TariffZoneText

1:1

xs:string

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

5.8. The complex type TariffZoneListInAreaStructure

@@ -159,7 +163,7 @@

OJP - Open API for distributed Journey

TariffZoneListInAreaStructure

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

The element contains a sequence of the following elements:

5.20. The TripLegRangeGroup group

-

TripLegRangeGroup

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

TripLegRange

FromTripLegIdRef

1:1

xs:NMTOKEN

Identifies the "valid from" trip leg.

ToTripLegIdRef

1:1

xs:NMTOKEN

Identifies the "valid to" trip leg.

5.21. The complex type TripFareResultStructure

+

TripFareResultStructure

Structure of a Single Trip Fare Request result

The element contains a sequence of the following elements:

ErrorMessage

0:*

+ErrorMessage

Result-specific error messages

5.21. The complex type TripFareResultStructure

TripFareResultStructure

Structure of a Single Trip Fare Request result

The element contains a sequence of the following elements:

TripLegRange

FromTripLegIdRef

1:1

xs:NMTOKEN

Identifies the "valid from" trip leg.

ToTripLegIdRef

1:1

xs:NMTOKEN

Identifies the "valid to" trip 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.22. 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.23. The FareDataFilterGroup group

@@ -170,7 +174,11 @@

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

Traveller

0:*

+FarePassenger

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

+

Traveller

0:*

+FarePassenger

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

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

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

6.1. Simple type definitions

VehicleProgressEnumeration

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

Vehicle progress relative to timetable service pattern.

6.2. The complex type ServiceViaPointStructure

@@ -402,18 +410,18 @@

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

StopPointName

1:1

+InternationalText

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

PointOfInterestFilter

0:1

+PointOfInterestFilter

Filter to narrow down POI searches.

PlacePolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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

NumberOfResults

0:1

xs:positiveInteger

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

ContinueAt

0:1

xs:nonNegativeInteger

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

IncludePtModes

0:1

xs:boolean

Tells the service to include the available public transport modes at returned stops.

8.6. The complex type GeoRestrictionsStructure

GeoRestrictionsStructure

The element contains one of the following elements:

a

Area

-1:1

+GeoArea

Area is defined by a polyline

b

Circle

-1:1

+GeoCircle

c

Rectangle

-1:1

+GeoRectangle

8.7. The complex type GeoCircleStructure

GeoCircleStructure

The element contains a sequence of the following elements:

Center

1:1

siri:LocationStructure

Radius

1:1

siri:DistanceType

Radius in metres.

8.8. The complex type GeoRectangleStructure

GeoRectangleStructure

The element contains a sequence of the following elements:

UpperLeft

1:1

siri:LocationStructure

LowerRight

1:1

siri:LocationStructure

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

8.10. The complex type PlaceResultStructure

+

PlaceResultStructure

The element contains a sequence of the following elements:

Place

1:1

+Place

Complete

1:1

xs:boolean

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

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

8.10. The complex type PlaceResultStructure

PlaceResultStructure

The element contains a sequence of the following elements:

Problem

0:*

+LocationProblem

Problems related to this LOCATION result.

Place

1:1

+Place

Complete

1:1

xs:boolean

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

Probability

0:1

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

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.

8.11. The PlacePolicyGroup group

- +

PlacePolicyGroup

PlacePolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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

NumberOfResults

0:1

xs:positiveInteger

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

ContinueAt

0:1

xs:nonNegativeInteger

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

IncludePtModes

0:1

xs:boolean

Tells the service to include the available public transport modes at returned stops.

8.12. The PlaceDataFilterGroup group

@@ -454,8 +462,8 @@

OJP - Open API for distributed Journey

-

PlaceDataFilterGroup

ExchangePointsResponse

ExchangePointResponseContext

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.

Place

0:*

+ExchangePointsResult

8.18. The complex type ExchangePointsResultStructure

ExchangePointsResultStructure

The element contains a sequence of the following elements:

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

-

9. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information

9.1. Simple type definitions

AddressCodeType

xs:normalizedString

Identifier of an Address

PointOfInterestCodeType

xs:normalizedString

Identifier of a Point of Interest

StopPlaceCodeType

xs:normalizedString

Identifier of a Stop Place

TopographicPlaceCodeType

xs:normalizedString

Identifier of a TopographicPlace

9.2. The StopPointGroup group

+

StopPointGroup

A stop point with id and name

8.18. The complex type ExchangePointsResultStructure

ExchangePointsResultStructure

The element contains a sequence of the following elements:

Problem

0:*

+ExchangePointProblem

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

+

9. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information

9.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_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

9.2. The StopPointGroup group

@@ -503,7 +511,15 @@

OJP - Open API for distributed Journey

-

StopPointGroup

A stop point with id and name

StopPoint

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

StopPointName

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

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

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.

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

Attribute

0:*

+GeneralAttribute

Attribute associated with this place.

Extension

0:1

xs:anyType

9.23. The complex type PlaceRefStructure

PlaceRefStructure

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

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

c

→‍TopographicPlaceRef

-1:1

→‍TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.If at least one is set, only 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/

+

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

Attribute

0:*

+GeneralAttribute

Attribute associated with this place.

Extension

0:1

xs:anyType

9.23. The complex type PlaceRefStructure

PlaceRefStructure

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

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

c

→‍TopographicPlaceRef

-1:1

→‍TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.If at least one is set, only 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/

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

9.25. The complex type ExchangePointProblemStructure

+ + + +

ExchangePointProblemStructure

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.

10. OJP/OJP_Requests.xsd - OJP service requests and responses

10.1. The toplevel element OJPFareRequest

OJPFareRequest

+OJPFareRequest (↔ siri:AbstractFunctionalServiceRequest)

10.2. The complex type OJPFareRequestStructure

@@ -514,8 +530,9 @@

OJP - Open API for distributed Journey

OJPFareRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

10.3. The toplevel element OJPFareDelivery

OJPFareDelivery

+OJPFareDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.4. The complex type OJPFareDeliveryStructure

- + + @@ -531,8 +548,9 @@

OJP - Open API for distributed Journey

OJPFareDeliveryStructure

siri:AbstractServiceDeliveryStructure

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.

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.

FareResponse

FareResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

FareResult

0:*

+FareResult

Fare result choice element.

10.7. The toplevel element OJPPlaceInformationDelivery

OJPPlaceInformationDelivery

+OJPPlaceInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.8. The complex type OJPPlaceInformationDeliveryStructure

- + + @@ -549,8 +567,9 @@

OJP - Open API for distributed Journey

OJPPlaceInformationDeliveryStructure

siri:AbstractServiceDeliveryStructure

The element contains a sequence of the following elements:

→‍OJPPlaceInformationRequest

0:1

→‍OJPPlaceInformationRequest

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.

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.

PlaceInformationResponse

PlaceInformationResponseContext

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.

10.11. The toplevel element OJPExchangePointsDelivery

OJPExchangePointsDelivery

+OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.12. The complex type OJPExchangePointsDeliveryStructure

- + + @@ -567,8 +586,9 @@

OJP - Open API for distributed Journey

OJPExchangePointsDeliveryStructure

siri:AbstractServiceDeliveryStructure

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.

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.

ExchangePointsResponse

ExchangePointResponseContext

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.

10.15. The toplevel element OJPStopEventDelivery

OJPStopEventDelivery

+OJPStopEventDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.16. The complex type OJPStopEventDeliveryStructure

- + + @@ -590,8 +610,9 @@

OJP - Open API for distributed Journey

OJPStopEventDeliveryStructure

siri:AbstractServiceDeliveryStructure

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.

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.

StopEventResponse

StopEventResponseContext

0:1

+ResponseContext

Container for data that is referenced multiple times.

StopEventResult

0:*

+StopEventResult

Enclosing element for stop event data.

10.19. The toplevel element OJPTripInfoDelivery

OJPTripInfoDelivery

+OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.20. The complex type OJPTripInfoDeliveryStructure

- + + @@ -611,8 +632,9 @@

OJP - Open API for distributed Journey

OJPTripInfoDeliveryStructure

siri:AbstractServiceDeliveryStructure

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.

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.

TripInfoResponse

TripInfoResponseContext

0:1

+ResponseContext

Response context.

TripInfoResult

0:1

+TripInfoResult

Result structure.

10.23. The toplevel element OJPTripDelivery

OJPTripDelivery

+OJPTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.24. The complex type OJPTripDeliveryStructure

- + + @@ -632,8 +654,9 @@

OJP - Open API for distributed Journey

OJPTripDeliveryStructure

siri:AbstractServiceDeliveryStructure

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.

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.

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

10.27. The toplevel element OJPMultiPointTripDelivery

OJPMultiPointTripDelivery

+OJPMultiPointTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.28. The complex type OJPMultiPointTripDeliveryStructure

- + + @@ -650,8 +673,9 @@

OJP - Open API for distributed Journey

OJPMultiPointTripDeliveryStructure

siri:AbstractServiceDeliveryStructure

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.

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.

MultiPointTripResponse

MultiPointTripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

MultiPointTripResult

0:*

+MultiPointTripResult

The trip results found by the server.

10.31. The toplevel element OJPTripRefineDelivery

OJPTripRefineDelivery

+OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.32. The complex type OJPTripRefineDeliveryStructure

- + + @@ -659,15 +683,16 @@

OJP - Open API for distributed Journey

OJPTripRefineDeliveryStructure

siri:AbstractServiceDeliveryStructure

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.

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.

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.

→‍siri:Extensions

0:1

→‍siri:Extensions

-

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

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

SignatureType

xs:string

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

11.2. The MessageIntegrityPropertiesGroup group

+

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

11.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_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

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

11.3. The ServiceRequestContextGroup group

ServiceRequestContextGroup

Generic context for all request messages.

ServiceRequestContext

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.

Extension

0:1

xs:anyType

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

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.

11.5. The SubscriptionRequestContextGroup group

@@ -701,7 +726,11 @@

OJP - Open API for distributed Journey

SubscriptionRequestContextGroup

Generic context for all subscription requests.

SubscriptionRequestContext

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.

Language

0:*

xs:language

Preferred language in which to return text values.

→‍siri:StatusRequestGroup

11.10. The toplevel element TerminateSubscriptionRequest

TerminateSubscriptionRequest

siri:TerminateSubscriptionRequestStructure

Request element for terminating subscriptions (from SIRI).

11.11. The ServiceResponseGroup group

-

ServiceResponseGroup

Wrapper for SIRI service response group.

→‍siri:ServiceResponseGroup

11.12. The complex type PlacesStructure

PlacesStructure

Structure providing a collection of places.

The element contains only one element:

Place

1:*

+Place

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

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.

+

11.12. The complex type PlacesStructure

PlacesStructure

Structure providing a collection of places.

The element contains only one element:

Place

1:*

+Place

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

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.

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

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

12.1. The complex type SituationsStructure

SituationsStructure

Wrapper type for SIRI PtSituationsElementStructure

The element contains a sequence of the following elements:

PtSituation

0:*

siri:PtSituationElementStructure

SIRI situation details.

RoadSituation

0:*

siri:RoadSituationElementStructure

12.2. The toplevel element SituationFullRef

SituationFullRef

+SituationFullRef

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

12.3. The complex type SituationFullRefStructure

SituationFullRefStructure

siri:SituationFullRefStructure

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

@@ -714,7 +743,7 @@

OJP - Open API for distributed Journey

StopEventTypeEnumeration

departure | arrival | both

Departure or arrival events or both

13.2. The StopEventRequestGroup group

+

StopEventRequestGroup

Request structure for departure and arrival events at stops

StopEventProblemTypeEnumeration

STOPEVENT_NOEVENTFOUND | STOPEVENT_LOCATIONUNSERVED | STOPEVENT_LOCATIONUNKNOWN | STOPEVENT_DATEOUTOFRANGE | STOPEVENT_LASTSERVICEOFTHISLINE | STOPEVENT_NOREALTIME | STOPEVENT_OTHER

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

StopEventTypeEnumeration

departure | arrival | both

Departure or arrival events or both

13.2. The StopEventRequestGroup group

StopEventRequestGroup

Request structure for departure and arrival events at stops

StopEventRequest

Place

1:1

+PlaceContext

Place for which to obtain stop event information.

Params

0:1

+StopEventParam

Request parameter

13.3. The complex type StopEventParamStructure

@@ -768,11 +797,15 @@

OJP - Open API for distributed Journey

StopEventParamStructure

Request specific parameters (parameters which define what is to be included in a Stop Event result)

The element contains a sequence of the following elements:

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

13.8. The complex type StopEventResultStructure

StopEventResultStructure

Wrapper element for a single stop event result.

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

ID of this result.

ErrorMessage

0:*

+ErrorMessage

Error messages that refer to this stop event.

StopEvent

1:1

+StopEvent

Stop event data element.

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

13.8. The complex type StopEventResultStructure

StopEventResultStructure

Wrapper element for a single stop event result.

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

ID of this result.

Problem

0:*

+StopEventProblem

Problems related to this STOPEVENT result.

StopEvent

1:1

+StopEvent

Stop event data element.

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

Extension

0:1

xs:anyType

13.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 place (f.e. address) to this stop in metres.

WalkDuration

0:1

xs:duration

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

-

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

14.1. The TripInfoRequestGroup group

+

TripInfoRequestGroup

TripInfo request structure.

Extension

0:1

xs:anyType

13.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 place (f.e. address) to this stop in metres.

WalkDuration

0:1

xs:duration

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

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

+

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

14.1. Simple type definitions

TripInfoProblemTypeEnumeration

TRIPINFO_JOURNEYREFUNKNOWN | TRIPINFO_VEHICLEUNKNOWN | TRIPINFO_NOJOURNEYFOUND | TRIPINFO_NOGEOINFO | TRIPINFO_OTHER

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

14.2. The TripInfoRequestGroup group

@@ -781,7 +814,7 @@

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

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

b

TimeOfOperation

1:1

xs:dateTime

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

TripInfoRequest

Params

0:1

+TripInfoParam

Request parameter.

14.2. The complex type TripInfoParamStructure

+

TripInfoParamStructure

TripInfo request parameter structure.

The element contains a sequence of the following elements:

14.3. The complex type TripInfoParamStructure

@@ -791,9 +824,9 @@

OJP - Open API for distributed Journey

-

TripInfoParamStructure

TripInfo request parameter structure.

The element contains a sequence of the following elements:

TripInfoPolicy

UseTimetabledDataOnly

0:1

xs:boolean

Do not show any realtime or incident data. Default is false.

TripInfoContentFilter

IncludeCalls

0:1

xs:boolean

Whether call information is to be included. Default is true.

IncludeTrackProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of this vehicle journey.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

Extension

0:1

xs:anyType

14.3. The TripInfoPolicyGroup group

+

TripInfoPolicyGroup

Parameters that control the response behaviour.

Extension

0:1

xs:anyType

14.4. The TripInfoPolicyGroup group

-

TripInfoPolicyGroup

Parameters that control the response behaviour.

TripInfoPolicy

UseTimetabledDataOnly

0:1

xs:boolean

Do not show any realtime or incident data. Default is false.

14.4. The TripInfoContentFilterGroup group

+

TripInfoContentFilterGroup

Parameters that control the level of detail to be returned in the results.

14.5. The TripInfoContentFilterGroup group

@@ -801,16 +834,16 @@

OJP - Open API for distributed Journey

-

TripInfoContentFilterGroup

Parameters that control the level of detail to be returned in the results.

TripInfoContentFilter

IncludeCalls

0:1

xs:boolean

Whether call information is to be included. Default is true.

IncludePosition

0:1

xs:boolean

Whether current position is to be included. Default is true.

IncludeService

0:1

xs:boolean

Whether service information is to be included. Default is true.

IncludeTrackProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of this vehicle journey.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

14.5. The TripInfoResponseGroup group

+

TripInfoResponseGroup

TripInfo response structure.

14.6. The TripInfoResponseGroup group

-

TripInfoResponseGroup

TripInfo response structure.

TripInfoResponse

TripInfoResponseContext

0:1

+ResponseContext

Response context.

TripInfoResult

0:1

+TripInfoResult

Result structure.

14.6. The complex type TripInfoResultStructure

+

TripInfoResultStructure

TripInfo result structure containing the current status of a trip.

The element contains a sequence of the following elements:

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.

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

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

-

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

15.1. Simple type definitions

AccessFeatureTypeEnumeration

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

Allowed values for a AccessFeature.

AccessibilityFeatureTypesEnumeration

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

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

GuidanceAdviceEnumeration

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

various types of guidance advice given to travelle

MultiPointTypeEnumeration

anyPoint | eachOrigin | eachDestination

How the multiple origin/destination points should be considered

OptimisationMethodEnumeration

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

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

TransitionEnumeration

up | down | level | upAndDown | downAndUp

Transition types for interchanges.

TurnActionEnumeration

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

the range of alternative turns that can be described

15.2. The TripRequestGroup group

+

TripRequestGroup

Trip request structure.

JourneyTrack

0:1

+LegTrack

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

Extension

0:1

xs:anyType

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

+

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

15.1. Simple type definitions

AccessFeatureTypeEnumeration

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

Allowed values for a AccessFeature.

AccessibilityFeatureTypesEnumeration

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

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

GuidanceAdviceEnumeration

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

various types of guidance advice given to travelle

MultiPointTypeEnumeration

anyPoint | eachOrigin | eachDestination

How the multiple origin/destination points should be considered

OptimisationMethodEnumeration

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

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

TransitionEnumeration

up | down | level | upAndDown | downAndUp

Transition types for interchanges.

TripProblemTypeEnumeration

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

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

TurnActionEnumeration

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

the range of alternative turns that can be described

15.2. The TripRequestGroup group

@@ -908,7 +941,7 @@

OJP - Open API for distributed Journey

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.

15.8. The complex type NotViaStructure

NotViaStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.9. The complex type NoChangeAtStructure

NoChangeAtStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.10. The TripResponseGroup group

-

TripResponseGroup

Trip response structure.

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

15.11. The complex type TripResultStructure

TripResultStructure

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

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

ErrorMessage

0:*

+ErrorMessage

Error messages related to this trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Detailed information on trip.

b

TripSummary

-1:1

+TripSummary

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

TripFare

0:*

+TripFareResult

15.12. The complex type TripSummaryStructure

+

TripSummaryStructure

Structure for trip overview information.

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Origin

0:1

+PlaceRef

Describes the origin situation of this trip.

Destination

0:1

+PlaceRef

Describes the arrival situation of this trip.

Duration

0:1

xs:duration

Overall duration of the trip.

StartTime

0:1

xs:dateTime

Departure time at origin.

EndTime

0:1

xs:dateTime

Arrival time at destination.

PTTripLegs

0:1

xs:nonNegativeInteger

Number of public transport trip legs.

Distance

0:1

siri:DistanceType

Trip distance.

15.11. The complex type TripResultStructure

TripResultStructure

Structure for a single trip result and associated problems.

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

Problem

0:*

+TripProblem

Problems related to this Trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Detailed information on trip.

b

TripSummary

-1:1

+TripSummary

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

TripFare

0:*

+TripFareResult

15.12. The complex type TripSummaryStructure

TripSummaryStructure

Structure for trip overview information.

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Origin

0:1

+PlaceRef

Describes the origin situation of this trip.

Destination

0:1

+PlaceRef

Describes the arrival situation of this trip.

Duration

0:1

xs:duration

Overall duration of the trip.

StartTime

0:1

xs:dateTime

Departure time at origin.

EndTime

0:1

xs:dateTime

Arrival time at destination.

PTTripLegs

0:1

xs:nonNegativeInteger

Number of public transport trip legs.

Distance

0:1

siri:DistanceType

Trip distance.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.13. The complex type TripStructure

@@ -1042,7 +1075,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 trip LEGs

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Duration

1:1

xs:duration

Overall duration of the trip.

StartTime

1:1

xs:dateTime

Departure time at origin.

EndTime

1:1

xs:dateTime

Arrival time at destination.

Transfers

1:1

xs:nonNegativeInteger

Number of interchanges.

Distance

0:1

siri:DistanceType

Trip distance.

TripLeg

1:*

+TripLeg

Legs of the trip

15.29. The MultiPointTripResponseGroup group

-

MultiPointTripResponseGroup

Multi-point trip response structure.

MultiPointTripResponse

MultiPointTripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

MultiPointTripResult

0:*

+MultiPointTripResult

The trip results found by the server.

15.30. The complex type MultiPointTripResultStructure

+

MultiPointTripResultStructure

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

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

ErrorMessage

0:*

+ErrorMessage

Error messages related to trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Information on the trip.

b

TripSummary

-1:1

+TripSummary

15.30. The complex type MultiPointTripResultStructure

MultiPointTripResultStructure

Structure for a multipoint trip result and associated problems

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

Problem

0:*

+TripProblem

Problems related to this trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Information on the trip.

b

TripSummary

-1:1

+TripSummary

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

TripFare

0:*

+TripFareResult

15.31. The MultiPointWaitTimeGroup group

@@ -1075,7 +1108,11 @@

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.

+

15.36. The complex type TripProblemStructure

+ + + +

TripProblemStructure

Problem that may be returned in responses to trip requests.

The element contains a sequence of the following elements:

Type

1:1

TripProblemType

Type of the trip problem.

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.

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

16.1. Simple type definitions

LengthType

xs:nonNegativeInteger

Data type for lengths, in meters.

OpenPercentType

xs:nonNegativeInteger

Percent value as integer, no upper limit.

PercentType

xs:nonNegativeInteger

Percent value as integer, limited to max value 100.

PhoneNumberType

xs:normalizedString

Type definition for phone numbers

PriorityType

xs:nonNegativeInteger

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

ValidDayBitType

xs:string

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

16.2. The complex type InternationalTextStructure

InternationalTextStructure

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

The element contains a sequence of the following elements:

Text

1:*

siri:NaturalLanguageStringStructure

Text content.

TextId

0:1

xs:NMTOKEN

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

16.3. The WebLinkGroup group

WebLinkGroup

URL of a web resource including type of resource.

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?