From 7995323eda6de6e51f7eb668b9b0b57e8086ce25 Mon Sep 17 00:00:00 2001 From: ue71603 Date: Wed, 20 Jul 2022 11:18:10 +0200 Subject: [PATCH 1/4] Update OJP_JourneySupport.xsd --- OJP/OJP_JourneySupport.xsd | 7 +- docs/generated/OJP.html | 1548 +++++++++++++++++------------------- 2 files changed, 740 insertions(+), 815 deletions(-) diff --git a/OJP/OJP_JourneySupport.xsd b/OJP/OJP_JourneySupport.xsd index 74764e0d1..33b90cc3d 100644 --- a/OJP/OJP_JourneySupport.xsd +++ b/OJP/OJP_JourneySupport.xsd @@ -89,7 +89,12 @@ - Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. + Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. + + + + + Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber. diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index a8c5fb616..26b947ed8 100644 --- a/docs/generated/OJP.html +++ b/docs/generated/OJP.html @@ -1,54 +1,12 @@ - + OJP - Open API for distributed Journey Planning - + + - -
-

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

- - +

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

1.1. The toplevel element OJP

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

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

+ +

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

- - -

TimedVehicleRefGroup

Reference to a vehicle for a specific point in time.

TimedVehicleRef

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

TimeOfOperation

1:1

xs:dateTime

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

2.16. The complex type VehicleFilterStructure

VehicleFilterStructure

Filter for Vehicles

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

VehicleRef

0:*

siri:VehicleRefStructure

Reference to VEHICLE

TrainNumber

0:*

xs:normalizedString

TRAIN NUMBERs

2.17. The SharingServiceUsageGroup group

- - -

SharingServiceUsageGroup

Usage parameters of a sharing service.

SharingServiceUsage

TimeBufferBefore

0:1

xs:duration

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

TimeBufferAfter

0:1

xs:duration

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

2.18. The complex type SharingServiceStructure

- - -

SharingServiceStructure

Service that provides shared vehicles.

The element contains a sequence of the following elements:

OperatorRef

1:1

siri:OperatorRefStructure

Identifier of the operator of the sharing service

Name

0:1

xs:string

Public name of the service.

SharingModel

0:1

SharingModel

Type of the sharing scheme.

SharingServiceUsage

TimeBufferBefore

0:1

xs:duration

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

TimeBufferAfter

0:1

xs:duration

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

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

2.19. The complex type OwnerRefStructure

OwnerRefStructure

OwnerCode

Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

2.20. The toplevel element OwnerRef

OwnerRef

+OwnerRef

Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

2.21. The complex type OperatingDayRefStructure

OperatingDayRefStructure

OperatingDayCode

Reference to an Operating Day

2.22. The toplevel element OperatingDayRef

OperatingDayRef

+OperatingDayRef

Reference to an Operating Day

2.23. The complex type OperatingDaysStructure

OperatingDaysStructure

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

The element contains a sequence of the following elements:

From

1:1

xs:date

Start date of period.

To

1:1

xs:date

End date of period.

Pattern

1:1

ValidDayBit

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

2.24. The OperatingDaysGroup group

- - -

OperatingDaysGroup

Coded as bit pattern

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

2.25. The complex type WeekdayTimePeriodStructure

WeekdayTimePeriodStructure

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

The element contains a sequence of the following elements:

Weekday

0:*

WeekdayType

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

StartTime

1:1

xs:time

Start time of period.

Duration

1:1

xs:duration

Time duration of period.

2.26. The complex type GeneralAttributeStructure

+ + +

GeneralAttributeStructure

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

The element contains a sequence of the following elements:

Text

1:1

+InternationalText

Text of the attribute to be shown to the user.

Code

1:1

xs:NMTOKEN

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

TimedVehicleRef

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

TimeOfOperation

1:1

xs:dateTime

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

2.16. The SharingServiceUsageGroup group

+ + +

SharingServiceUsageGroup

Usage parameters of a sharing service.

SharingServiceUsage

TimeBufferBefore

0:1

xs:duration

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

TimeBufferAfter

0:1

xs:duration

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

2.17. The complex type SharingServiceStructure

+ + +

SharingServiceStructure

Service that provides shared vehicles.

The element contains a sequence of the following elements:

OperatorRef

1:1

siri:OperatorRefStructure

Identifier of the operator of the sharing service

Name

0:1

xs:string

Public name of the service.

SharingModel

0:1

SharingModel

Type of the sharing scheme.

SharingServiceUsage

TimeBufferBefore

0:1

xs:duration

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

TimeBufferAfter

0:1

xs:duration

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

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

2.18. The complex type OwnerRefStructure

OwnerRefStructure

OwnerCode

Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

2.19. The toplevel element OwnerRef

OwnerRef

+OwnerRef

Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

2.20. The complex type OperatingDayRefStructure

OperatingDayRefStructure

OperatingDayCode

Reference to an Operating Day

2.21. The toplevel element OperatingDayRef

OperatingDayRef

+OperatingDayRef

Reference to an Operating Day

2.22. The complex type OperatingDaysStructure

OperatingDaysStructure

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

The element contains a sequence of the following elements:

From

1:1

xs:date

Start date of period.

To

1:1

xs:date

End date of period.

Pattern

1:1

ValidDayBit

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

2.23. The OperatingDaysGroup group

+ + +

OperatingDaysGroup

Coded as bit pattern

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

2.24. The complex type WeekdayTimePeriodStructure

WeekdayTimePeriodStructure

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

The element contains a sequence of the following elements:

Weekday

0:*

WeekdayType

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

StartTime

1:1

xs:time

Start time of period.

Duration

1:1

xs:duration

Time duration of period.

2.25. The complex type GeneralAttributeStructure

- - - - + + + +

GeneralAttributeStructure

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

The element contains a sequence of the following elements:

Text

1:1

+InternationalText

Text of the attribute to be shown to the user.

Code

1:1

xs:NMTOKEN

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

→‍siri:AllFacilitiesGroup

Mandatory

0:1

xs:boolean

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

Importance

0:1

Percent

Importance of the attribute.

WebLink

Url

1:1

xs:anyURI

URL to resource on web.

MimeType

0:1

xs:normalizedString

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

Embeddable

0:1

xs:boolean

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

Mandatory

0:1

xs:boolean

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

Importance

0:1

Percent

Importance of the attribute.

WebLink

Url

1:1

xs:anyURI

URL to resource on web.

MimeType

0:1

xs:normalizedString

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

Embeddable

0:1

xs:boolean

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

3. OJP/OJP_FacilitySupport.xsd - Supporting definitions for facilities containing wrappers for SIRI

3.1. The AllFacilitiesGroup group

@@ -107,583 +65,569 @@

OJP - Open API for distributed Journey

AllFacilitiesGroup

Wrapper for SIRI facilities.

→‍siri:AllFacilitiesGroup

→‍siri:ServiceFacilityGroup

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

4.1. The FareRequestGroup group

- - -

FareRequestGroup

Fare request structure.

The element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

4.2. The complex type StopFareRequestStructure

StopFareRequestStructure

Sub-request: stop-related fare information.

The element contains a sequence of the following elements:

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

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.

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

VatRateEnumeration

no | full | half | mixed | unknown

Enumeration of Value Added Tax rates.

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

- - -

TariffZoneListInAreaStructure

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

The element contains a sequence of the following elements:

FareAuthority

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

FareAuthorityText

1:1

xs:string

Textual description or name of Fare authority.

TariffZone

1:*

+TariffZone

Fare zone in area.

5.9. The complex type TariffZoneRefListStructure

TariffZoneRefListStructure

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

The element contains a sequence of the following elements:

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

→‍TariffZoneRef

1:*

→‍TariffZoneRef

Reference to a fare zone.

5.10. The complex type BookingArrangementStructure

BookingArrangementStructure

[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey

The element contains a sequence of the following elements:

BookingAgencyName

0:1

+InternationalText

Name of the booking agency (contractual partner).

BookingUrl

0:1

+WebLink

URL to online booking service.

InfoUrl

0:1

+WebLink

URL to information page.

PhoneNumber

0:1

PhoneNumber

Phone number for booking.

MinimumBookingPeriod

0:1

xs:duration

Minimum duration bookings must be completed before trip starts.

Extension

0:1

xs:anyType

5.11. The complex type BookingArrangementsContainerStructure

BookingArrangementsContainerStructure

Container for multiple booking arrangements.

The element contains a sequence of the following elements:

BookingArrangement

1:*

+BookingArrangement

[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.

Extension

0:1

xs:anyType

5.12. The complex type FareProductRefStructure

FareProductRefStructure

FareProductCode

Reference to a FareProduct.

5.13. The toplevel element FareProductRef

FareProductRef

+FareProductRef

Reference to a FareProduct.

5.14. The complex type EntitlementProductListStructure

EntitlementProductListStructure

A list of ENTITLEMENT PRODUCTs

The element contains only one element:

EntitlementProduct

1:*

+EntitlementProduct

[a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".

5.15. The complex type EntitlementProductStructure

EntitlementProductStructure

[a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".

The element contains a sequence of the following elements:

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to the fare authority that issued the ENTITLEMENT PRODUCT

EntitlementProductRef

1:1

EntitlementProductCode

Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...)

ValidityPeriod

0:1

siri:HalfOpenTimestampOutputRangeStructure

Validity period of the ENTITLEMENT PRODUCT

EntitlementProductName

1:1

xs:string

Name of the ENTITLEMENT PRODUCT

5.16. The complex type FareProductStructure

- - - - - - - + + +

FareProductStructure

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

The element contains a sequence of the following elements:

FareProductId

1:1

FareProductCode

Unique Id of the FareProduct.

FareProductName

1:1

xs:string

printable FareProduct name

FareAuthority

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

FareAuthorityText

1:1

xs:string

Textual description or name of Fare authority.

ProtoProduct

0:1

xs:boolean

Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/

FareProductPrice

Price

0:1

xs:decimal

FareProduct price as decimal number.

NetPrice

0:1

xs:decimal

Net FareProduct price as decimal number for accounting purposes.

Currency

0:1

xs:NMTOKEN

iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

VatRate

0:1

VatRate

Rate of value added tax. Default is unknown.

The element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

4.2. The complex type StopFareRequestStructure

StopFareRequestStructure

Sub-request: stop-related fare information.

The element contains a sequence of the following elements:

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

Date

0:1

xs:date

Date for which to retrieve Fare information.

4.3. The complex type StaticFareRequestStructure

StaticFareRequestStructure

General Fare information. May depend on date.

The element contains a sequence of the following elements:

Date

0:1

xs:date

Date for which to retrieve Fare information.

→‍FareProductRef

0:*

→‍FareProductRef

Reference to a FareProduct.

4.4. The complex type TripFareRequestStructure

TripFareRequestStructure

Structure of a Single Trip Fare Request.

The element contains only one element:

Trip

1:1

+Trip

A complete trip from origin to destination

4.5. The complex type MultiTripFareRequestStructure

MultiTripFareRequestStructure

Structure of a Multi Trip Fare Request.

The element contains only one element:

Trip

1:*

+Trip

Multiple complete trips from multiple origins and multiple destination

4.6. The FareResponseGroup group

+ + +

FareResponseGroup

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 a traveller card (f.e. BahnCard50, BahnCard50First etc.).

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.

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

VatRateEnumeration

no | full | half | mixed | unknown

Enumeration of Value Added Tax rates.

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

+ + +

TariffZoneListInAreaStructure

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

The element contains a sequence of the following elements:

FareAuthority

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

FareAuthorityText

1:1

xs:string

Textual description or name of Fare authority.

TariffZone

1:*

+TariffZone

Fare zone in area.

5.9. The complex type TariffZoneRefListStructure

TariffZoneRefListStructure

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

The element contains a sequence of the following elements:

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

→‍TariffZoneRef

1:*

→‍TariffZoneRef

Reference to a fare zone.

5.10. The complex type BookingArrangementStructure

BookingArrangementStructure

[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey

The element contains a sequence of the following elements:

BookingAgencyName

0:1

+InternationalText

Name of the booking agency (contractual partner).

BookingUrl

0:1

+WebLink

URL to online booking service.

InfoUrl

0:1

+WebLink

URL to information page.

PhoneNumber

0:1

PhoneNumber

Phone number for booking.

MinimumBookingPeriod

0:1

xs:duration

Minimum duration bookings must be completed before trip starts.

Extension

0:1

xs:anyType

5.11. The complex type BookingArrangementsContainerStructure

BookingArrangementsContainerStructure

Container for multiple booking arrangements.

The element contains a sequence of the following elements:

BookingArrangement

1:*

+BookingArrangement

[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.

Extension

0:1

xs:anyType

5.12. The complex type FareProductRefStructure

FareProductRefStructure

FareProductCode

Reference to a FareProduct.

5.13. The toplevel element FareProductRef

FareProductRef

+FareProductRef

Reference to a FareProduct.

5.14. The complex type EntitlementProductRefStructure

EntitlementProductRefStructure

EntitlementProductCode

Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

5.15. The toplevel element EntitlementProductRef

EntitlementProductRef

+EntitlementProductRef

Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

5.16. The complex type FareProductStructure

+ + + + + + + - - - - - - - + + + + + + + - - - -

FareProductStructure

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

The element contains a sequence of the following elements:

FareProductId

1:1

FareProductCode

Unique Id of the FareProduct.

FareProductName

1:1

xs:string

printable FareProduct name

FareAuthority

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

FareAuthorityText

1:1

xs:string

Textual description or name of Fare authority.

ProtoProduct

0:1

xs:boolean

Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/

FareProductPrice

Price

0:1

xs:decimal

FareProduct price as decimal number.

NetPrice

0:1

xs:decimal

Net FareProduct price as decimal number for accounting purposes.

Currency

0:1

xs:NMTOKEN

iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

VatRate

0:1

VatRate

Rate of value added tax. Default is unknown.

FareProductValidity

TravelClass

0:1

TypeOfFareClass

Travel class for which the FareProduct is valid.

RequiredCard

0:*

+EntitlementProduct

One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".

ValidFor

0:*

PassengerCategory

Sequence of all passenger categories for which this FareProduct is valid.

ValidityDuration

0:1

xs:duration

Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

ValidityDurationText

0:1

+InternationalText

Textual description of maximum validity duration.

ValidityTariffZones

0:*

+TariffZoneListInArea

Spatial validity of FareProduct defined as list of fare zones.

ValidityAreaText

0:1

+InternationalText

Textual description of spatial validity.

FareProductValidity

TravelClass

0:1

TypeOfFareClass

Travel class for which the FareProduct is valid.

RequiredCard

0:*

+EntitlementProductRef

One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

ValidFor

0:*

PassengerCategory

Sequence of all passenger categories for which this FareProduct is valid.

ValidityDuration

0:1

xs:duration

Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

ValidityDurationText

0:1

+InternationalText

Textual description of maximum validity duration.

ValidityTariffZones

0:*

+TariffZoneListInArea

Spatial validity of FareProduct defined as list of fare zones.

ValidityAreaText

0:1

+InternationalText

Textual description of spatial validity.

FareProductBooking

InfoUrl

0:*

+WebLink

URL to information for this FareProduct

SaleUrl

0:*

+WebLink

URL to buy the FareProduct online

BookingArrangements

0:*

+BookingArrangementsContainer

Extension

0:1

xs:anyType

5.17. The FareProductPriceGroup group

- - - - + + + +

FareProductPriceGroup

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

FareProductPrice

Price

0:1

xs:decimal

FareProduct price as decimal number.

NetPrice

0:1

xs:decimal

Net FareProduct price as decimal number for accounting purposes.

Currency

0:1

xs:NMTOKEN

iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

VatRate

0:1

VatRate

Rate of value added tax. Default is unknown.

FareProductBooking

InfoUrl

0:*

+WebLink

URL to information for this FareProduct

SaleUrl

0:*

+WebLink

URL to buy the FareProduct online

BookingArrangements

0:*

+BookingArrangementsContainer

Extension

0:1

xs:anyType

5.17. The FareProductPriceGroup group

+ + + +

FareProductPriceGroup

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

FareProductPrice

Price

0:1

xs:decimal

FareProduct price as decimal number.

NetPrice

0:1

xs:decimal

Net FareProduct price as decimal number for accounting purposes.

Currency

0:1

xs:NMTOKEN

iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

VatRate

0:1

VatRate

Rate of value added tax. Default is unknown.

5.18. The FareProductValidityGroup group

- - - - - - - + + + + + + +

FareProductValidityGroup

conditions of use for a particular FARE PRODUCT.

FareProductValidity

TravelClass

0:1

TypeOfFareClass

Travel class for which the FareProduct is valid.

RequiredCard

0:*

+EntitlementProduct

One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".

ValidFor

0:*

PassengerCategory

Sequence of all passenger categories for which this FareProduct is valid.

ValidityDuration

0:1

xs:duration

Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

ValidityDurationText

0:1

+InternationalText

Textual description of maximum validity duration.

ValidityTariffZones

0:*

+TariffZoneListInArea

Spatial validity of FareProduct defined as list of fare zones.

ValidityAreaText

0:1

+InternationalText

Textual description of spatial validity.

FareProductValidity

TravelClass

0:1

TypeOfFareClass

Travel class for which the FareProduct is valid.

RequiredCard

0:*

+EntitlementProductRef

One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

ValidFor

0:*

PassengerCategory

Sequence of all passenger categories for which this FareProduct is valid.

ValidityDuration

0:1

xs:duration

Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

ValidityDurationText

0:1

+InternationalText

Textual description of maximum validity duration.

ValidityTariffZones

0:*

+TariffZoneListInArea

Spatial validity of FareProduct defined as list of fare zones.

ValidityAreaText

0:1

+InternationalText

Textual description of spatial validity.

5.19. The FareProductBookingGroup group

- - - + + +

FareProductBookingGroup

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

FareProductBooking

InfoUrl

0:*

+WebLink

URL to information for this FareProduct

SaleUrl

0:*

+WebLink

URL to buy the FareProduct online

BookingArrangements

0:*

+BookingArrangementsContainer

FareProductBooking

InfoUrl

0:*

+WebLink

URL to information for this FareProduct

SaleUrl

0:*

+WebLink

URL to buy the FareProduct online

BookingArrangements

0:*

+BookingArrangementsContainer

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

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

- - - + + +

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

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

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

EntitlementProduct

0:*

+EntitlementProductRef

[a specific form of TRAVEL DOCUMENT in TM and NeTEx] a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc)

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

+ + +

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

5.24. The complex type FareParamStructure

- - - -

FareParamStructure

[related to the FARE parameter model in TM and NeTEx] parameters which are used to determine the price to be paid for a FARE PRODUCT by a specific passenger.

The element contains a sequence of the following elements:

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.

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

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

- - - - - -

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.

NameSuffix

0:1

+InternationalText

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

DisplayPriority

0:1

Priority

Priority of this via point to be displayed when space is limited.

6.3. The complex type ProductCategoryStructure

ProductCategoryStructure

Product category based on NeTEx/SIRI. A product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products.

The element contains a sequence of the following elements:

Name

0:1

+InternationalText

Full name of this product category, e.g. "Autoreisezug" in Switzerland or "Dampfschiff"

ShortName

0:1

+InternationalText

Short name or acronym of the product category, likely to be published, e.g. "BAV", "ARZ", "TGV". The product category is more important for publication in Switzerland than Mode / Submode.

→‍ProductCategoryRef

0:1

→‍ProductCategoryRef

A reference to the product category. This is the internal code used within the reference frameworks (NeTEx, SIRI). It is usually not displayed, but interpreted by the technical system, e.g. "ch:1:TypeOfProductCategory:ARZ" (Autoreisezug in Switzerland) or "ch:1:TypeOfProductCategory:BAV".

6.4. The complex type TripViaStructure

TripViaStructure

VIA restrictions for a TRIP.

The element contains a sequence of the following elements:

ViaPoint

1:1

+PlaceRef

Reference to specify the via place.

DwellTime

0:1

xs:duration

Duration the passenger wants to stay at the via place. Default is 0.

6.5. The ScheduledJourneyGroup group

- + + + + + +

ScheduledJourneyGroup

Vehicle journey (not dated).

ScheduledJourney

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

DisplayPriority

0:1

Priority

Priority of this via point to be displayed when space is limited.

6.3. The complex type ProductCategoryStructure

ProductCategoryStructure

Product category based on NeTEx/SIRI. A product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products.

The element contains a sequence of the following elements:

Name

0:1

+InternationalText

Full name of this product category, e.g. "Autoreisezug" in Switzerland or "Dampfschiff"

ShortName

0:1

+InternationalText

Short name or acronym of the product category, likely to be published, e.g. "BAV", "ARZ", "TGV". The product category is more important for publication in Switzerland than Mode / Submode.

→‍ProductCategoryRef

0:1

→‍ProductCategoryRef

A reference to the product category. This is the internal code used within the reference frameworks (NeTEx, SIRI). It is usually not displayed, but interpreted by the technical system, e.g. "ch:1:TypeOfProductCategory:ARZ" (Autoreisezug in Switzerland) or "ch:1:TypeOfProductCategory:BAV".

6.4. The complex type TripViaStructure

TripViaStructure

VIA restrictions for a TRIP.

The element contains a sequence of the following elements:

ViaPoint

1:1

+PlaceRef

Reference to specify the via place.

DwellTime

0:1

xs:duration

Duration the passenger wants to stay at the via place. Default is 0.

6.5. The ScheduledJourneyGroup group

+ - - - - - - - - + + + + + + + + +

ScheduledJourneyGroup

Vehicle journey (not dated).

ScheduledJourney

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineDirectionGroup

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

6.6. The ServiceGroup group

- - - - - - - - + + + + + + + + +

ServiceGroup

Properties of a service (line and direction): attributes of Continuous Journey Structure or Dated Journey Structure.

→‍siri:LineDirectionGroup

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

6.7. The ServiceOriginGroup group

- - + +

ServiceOriginGroup

First serviced stop of a vehicle journey.

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

6.8. The ServiceDestinationGroup group

- - + +

ServiceDestinationGroup

Last serviced stop of a vehicle journey.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

6.9. The RouteDescriptionGroup group

- +

RouteDescriptionGroup

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

RouteDescription

RouteDescriptionText

1:1

+InternationalText

RouteDescription

RouteDescriptionText

1:1

+InternationalText

6.10. The DatedJourneyGroup group

- - + + - + - - - - - - - - + + + + + + + + +

DatedJourneyGroup

Vehicle journey that runs at a specific date.

DatedJourney

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

DatedJourney

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

ScheduledJourney

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

ScheduledJourney

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineDirectionGroup

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

6.11. The PrivateServiceGroup group

- - - - + + + +

PrivateServiceGroup

specific service operated by a Private Mode

PrivateService

→‍JourneyRef

0:1

→‍JourneyRef

Reference to a Journey

PrivateMode

1:1

PrivateModes

[a category of MODE in TMv6] MODEs offered by private individuals

OrganisationRef

0:1

siri:OperatorRefStructure

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

PrivateService

→‍JourneyRef

0:1

→‍JourneyRef

Reference to a Journey

PrivateMode

1:1

PrivateModes

[a category of MODE in TMv6] MODEs offered by private individuals

OrganisationRef

0:1

siri:OperatorRefStructure

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

6.12. The complex type DatedJourneyStructure

- - + + - + - - - - - - - - + + + + + + + + + - - - - + + + + - - + + - - + + - - - - -

DatedJourneyStructure

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

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

DatedJourney

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

DatedJourney

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

ScheduledJourney

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

ScheduledJourney

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineDirectionGroup

Service

a

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

a

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

a

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

a

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number.

a

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

a

RouteDescription

0:1

+InternationalText

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

a

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

a

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

a

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

a

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

a

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

a

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

a

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

a

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

a

RouteDescription

0:1

+InternationalText

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

a

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

a

Attribute

0:*

+GeneralAttribute

Note or service attribute.

PrivateService

b

→‍JourneyRef

0:1

→‍JourneyRef

Reference to a Journey

b

PrivateMode

1:1

PrivateModes

[a category of MODE in TMv6] MODEs offered by private individuals

b

OrganisationRef

0:1

siri:OperatorRefStructure

b

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

PrivateService

b

→‍JourneyRef

0:1

→‍JourneyRef

Reference to a Journey

b

PrivateMode

1:1

PrivateModes

[a category of MODE in TMv6] MODEs offered by private individuals

b

OrganisationRef

0:1

siri:OperatorRefStructure

b

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

ServiceStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Occupancy

0:1

siri:OccupancyEnumeration

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

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

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

6.13. The complex type TripPlaceStructure

TripPlaceStructure

A trip place represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip place does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat.

The element contains a sequence of the following elements:

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineIdentityGroup

6.14. The TimeWindowGroup group

- - + + + + +

TimeWindowGroup

The window of opportunity that the traveller has to perform this leg of the journey.

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

ServiceStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Occupancy

0:1

siri:OccupancyEnumeration

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

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

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

6.13. The complex type TripPlaceStructure

TripPlaceStructure

A trip place represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip place does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat.

The element contains a sequence of the following elements:

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineIdentityGroup

6.14. The TimeWindowGroup group

+ +

TimeWindowGroup

The window of opportunity that the traveller has to perform this leg of the journey.

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

6.15. The ServiceTimeGroup group

- - - + + + - - + +

ServiceTimeGroup

Contains at least scheduled time, but can contain real time and estimated times

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

6.16. The EstimatedTimeBandGroup group

- - + +

EstimatedTimeBandGroup

Range for estimated time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

6.17. The complex type ServiceArrivalStructure

- - - + + + - - + +

ServiceArrivalStructure

Arrival times of a service at a stop (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

The element contains only one element:

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

6.18. The complex type ServiceDepartureStructure

- - - + + + - - + +

ServiceDepartureStructure

Departure times of a service at a stop (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

The element contains only one element:

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

6.19. The complex type CallAtStopStructure

- - - - - - - - - - - - -

CallAtStopStructure

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

The element contains a sequence of the following elements:

StopPoint

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

StopPointName

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

0:1

+ServiceArrival

Arrival times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

ServiceDeparture

0:1

+ServiceDeparture

Departure times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

6.20. The StopCallStatusGroup group

- - - - - - + + + + + + + + + + + + +

StopCallStatusGroup

Status properties for the vehicle call at this stop.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

0:1

+ServiceArrival

Arrival times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

ServiceDeparture

0:1

+ServiceDeparture

Departure times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

6.20. The StopCallStatusGroup group

+ + + + + +

StopCallStatusGroup

Status properties for the vehicle call at this stop.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

6.21. The ServiceStatusGroup group

- - - - -

ServiceStatusGroup

parameters which describe the current status of a DATED VEHICLE JOURNEY

ServiceStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Occupancy

0:1

siri:OccupancyEnumeration

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

6.22. The complex type ContinuousServiceStructure

- - + + + + +

ContinuousServiceStructure

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

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

ContinuousMode

-1:1

ContinuousModes

Continuous transport options.

b

IndividualMode

-1:1

IndividualModes

Individual transport options.

Then, the element contains one of the following elements:

DatedJourney

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

ServiceStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Occupancy

0:1

siri:OccupancyEnumeration

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

6.22. The complex type ContinuousServiceStructure

+ + - + - - - - - - - - + + + + + + + + + - - - + + + - - -

ContinuousServiceStructure

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

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

ContinuousMode

-1:1

ContinuousModes

Continuous transport options.

b

IndividualMode

-1:1

IndividualModes

Individual transport options.

Then, the element contains one of the following elements:

DatedJourney

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

ScheduledJourney

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

ScheduledJourney

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineDirectionGroup

Service

a

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

a

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

a

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

a

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number.

a

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

a

RouteDescription

0:1

+InternationalText

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

a

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

a

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

a

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

a

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

a

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

a

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

a

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

a

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

a

RouteDescription

0:1

+InternationalText

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

a

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

a

Attribute

0:*

+GeneralAttribute

Note or service attribute.

b

SharingService

-0:1

+SharingService

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

b

SharingService

-0:1

+SharingService

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

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

6.23. The complex type VehiclePositionStructure

VehiclePositionStructure

Geographical and logical position of a vehicle.

The element contains a sequence of the following elements:

GeoPosition

0:1

siri:LocationStructure

Geographic position of vehicle.

Progress

0:1

VehicleProgress

Logical progress of vehicle relative to service pattern.

Bearing

0:1

siri:AbsoluteBearingType

Bearing in compass degrees in which vehicle is heading.

ProgressBetweenStops

0:1

siri:ProgressBetweenStopsStructure

Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position.

6.24. The complex type PlaceContextStructure

PlaceContextStructure

[a view of PLACE in TMv6] a PLACE and access to it by individual transport

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

PlaceRef

-1:1

+PlaceRef

Static place.

b

TripPlace

-1:1

+TripPlace

Place within a (moving) vehicle.

Then, the element contains one of the following elements:

a

DepArrTime

-0:1

xs:dateTime

Time when departure/arrival from/to place is required.

b

TimeAllowance

-0:1

xs:duration

Extra time needed before reaching/after leaving this place.

IndividualTransportOptions

0:*

+IndividualTransportOptions

Options how to access/leave the place by individual transport.

6.25. The NumberOfResultsGroup group

- - + + +

NumberOfResultsGroup

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

NumberOfResults

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

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

6.23. The complex type VehiclePositionStructure

VehiclePositionStructure

Geographical and logical position of a vehicle.

The element contains a sequence of the following elements:

GeoPosition

0:1

siri:LocationStructure

Geographic position of vehicle.

Progress

0:1

VehicleProgress

Logical progress of vehicle relative to service pattern.

Bearing

0:1

siri:AbsoluteBearingType

Bearing in compass degrees in which vehicle is heading.

ProgressBetweenStops

0:1

siri:ProgressBetweenStopsStructure

Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position.

6.24. The complex type PlaceContextStructure

PlaceContextStructure

[a view of PLACE in TMv6] a PLACE and access to it by individual transport

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

PlaceRef

-1:1

+PlaceRef

Static place.

b

TripPlace

-1:1

+TripPlace

Place within a (moving) vehicle.

Then, the element contains one of the following elements:

a

DepArrTime

-0:1

xs:dateTime

Time when departure/arrival from/to place is required.

b

TimeAllowance

-0:1

xs:duration

Extra time needed before reaching/after leaving this place.

IndividualTransportOptions

0:*

+IndividualTransportOptions

Options how to access/leave the place by individual transport.

6.25. The NumberOfResultsGroup group

+ +

NumberOfResultsGroup

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

NumberOfResults

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

6.26. The BaseTripPolicyGroup group

- - - - - + + + + +

BaseTripPolicyGroup

Policies that control the trip search behaviour for both public and individual transport.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

6.27. The BaseTripMobilityFilterGroup group

- - - - - - + + + + + +

BaseTripMobilityFilterGroup

Base mobility options to be applied for both public and individual transport.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

6.28. The BaseTripContentFilterGroup group

- - - - - - -

BaseTripContentFilterGroup

Parameters to control the level of detail of both public and individual transport journey results.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

6.29. The complex type LegAttributeStructure

- - - -

LegAttributeStructure

+GeneralAttribute

Attributes that are not valid on the whole service, but only on section of a TRIP made on a single MODE without interchange between boarding and alighting (facilities available on a specified (part of a) Leg of a VEHICLE JOURNEY)

The element contains a sequence of the following elements:

FromStopSeqNumber

0:1

xs:positiveInteger

The attribute is valid from the stop point with this sequence number within the leg. If missing it is valid from the beginning of the leg.

ToStopSeqNumber

0:1

xs:positiveInteger

The attribute is valid to the stop point (inclusively) with this sequence number within the leg. If missing it is valid to the end of the leg.

6.30. The complex type LegTrackStructure

LegTrackStructure

The LINK PROJECTION of a Leg onto the topography of the route being followed.

The element contains only one element:

TrackSection

1:*

+TrackSection

LINK PROJECTION on the infrastructure network of the trip leg section together with time information.

6.31. The complex type TrackSectionStructure

TrackSectionStructure

LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

The element contains a sequence of the following elements:

TrackStart

0:1

+PlaceRef

Start place of this track.

TrackEnd

0:1

+PlaceRef

End place of this track.

LinkProjection

0:1

+LinkProjection

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

RoadName

0:1

xs:string

Name of the road this track section is attached to.

Duration

0:1

xs:duration

Duration the passenger needs to travel through this track section.

Length

0:1

siri:DistanceType

Length of this track section.

Extension

0:1

xs:anyType

-

7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport

7.1. Simple type definitions

ContinuousModesEnumeration

walk | demandResponsive | replacementService

Types of cmodes that run at any time without a timetable.

IndividualModesEnumeration

walk | cycle | taxi | self-drive-car | others-drive-car | motorcycle | truck | scooter | ride-pool-car | car-sharing | cycle-sharing | scooter-sharing

modes which an individual powers themselves (such as walk, cycle)

PrivateModesEnumeration

carPooling

[a category of MODE in TMv6] MODEs offered by private individuals

TransferModesEnumeration

walk | parkAndRide | bikeAndRide | carHire | bikeHire | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut

MODEs dedicated to peform TRANSFERs

7.2. The complex type IndividualTransportOptionsStructure

IndividualTransportOptionsStructure

Individual modes and their usage limits as stated by the passenger

The element contains a sequence of the following elements:

Mode

1:1

IndividualModes

Mode of individual transport. When mode self-drive-car is used the connection to another mode will need a parking space for the car. Thus, this mode is a generalisation of all park and ride use cases. The mode others-drive-car, however, only needs a place to let a person be set down from a car.

MaxDistance

0:1

siri:DistanceType

Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode.

MaxDuration

0:1

xs:duration

Maximum duration. If given, it restricts the maximum time of routes with the given mode.

MinDistance

0:1

siri:DistanceType

Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode.

MinDuration

0:1

xs:duration

Minimum duration. If given, it restricts the minimum time of routes with the given mode.

Speed

0:1

OpenPercent

Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100).

AdditionalTime

0:1

xs:duration

Additional time added to the actual traveling time needed to use a specific mode.

7.3. The complex type ModeStructure

- + + + + + + +

ModeStructure

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

The element contains a sequence of the following elements:

Mode

PtMode

1:1

siri:VehicleModesOfTransportEnumeration

Categorisation of mode

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

6.29. The complex type LegAttributeStructure

+ + + +

LegAttributeStructure

+GeneralAttribute

Attributes that are not valid on the whole service, but only on section of a TRIP made on a single MODE without interchange between boarding and alighting (facilities available on a specified (part of a) Leg of a VEHICLE JOURNEY)

The element contains a sequence of the following elements:

FromStopSeqNumber

0:1

xs:positiveInteger

The attribute is valid from the stop point with this sequence number within the leg. If missing it is valid from the beginning of the leg.

ToStopSeqNumber

0:1

xs:positiveInteger

The attribute is valid to the stop point (inclusively) with this sequence number within the leg. If missing it is valid to the end of the leg.

6.30. The complex type LegTrackStructure

LegTrackStructure

The LINK PROJECTION of a Leg onto the topography of the route being followed.

The element contains only one element:

TrackSection

1:*

+TrackSection

LINK PROJECTION on the infrastructure network of the trip leg section together with time information.

6.31. The complex type TrackSectionStructure

TrackSectionStructure

LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

The element contains a sequence of the following elements:

TrackStart

0:1

+PlaceRef

Start place of this track.

TrackEnd

0:1

+PlaceRef

End place of this track.

LinkProjection

0:1

+LinkProjection

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

RoadName

0:1

xs:string

Name of the road this track section is attached to.

Duration

0:1

xs:duration

Duration the passenger needs to travel through this track section.

Length

0:1

siri:DistanceType

Length of this track section.

Extension

0:1

xs:anyType

+

7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport

7.1. Simple type definitions

ContinuousModesEnumeration

walk | demandResponsive | replacementService

Types of cmodes that run at any time without a timetable.

IndividualModesEnumeration

walk | cycle | taxi | self-drive-car | others-drive-car | motorcycle | truck | scooter | ride-pool-car | car-sharing | cycle-sharing | scooter-sharing

modes which an individual powers themselves (such as walk, cycle)

PrivateModesEnumeration

carPooling

[a category of MODE in TMv6] MODEs offered by private individuals

TransferModesEnumeration

walk | parkAndRide | bikeAndRide | carHire | bikeHire | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut

MODEs dedicated to peform TRANSFERs

7.2. The complex type IndividualTransportOptionsStructure

IndividualTransportOptionsStructure

Individual modes and their usage limits as stated by the passenger

The element contains a sequence of the following elements:

Mode

1:1

IndividualModes

Mode of individual transport. When mode self-drive-car is used the connection to another mode will need a parking space for the car. Thus, this mode is a generalisation of all park and ride use cases. The mode others-drive-car, however, only needs a place to let a person be set down from a car.

MaxDistance

0:1

siri:DistanceType

Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode.

MaxDuration

0:1

xs:duration

Maximum duration. If given, it restricts the maximum time of routes with the given mode.

MinDistance

0:1

siri:DistanceType

Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode.

MinDuration

0:1

xs:duration

Minimum duration. If given, it restricts the minimum time of routes with the given mode.

Speed

0:1

OpenPercent

Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100).

AdditionalTime

0:1

xs:duration

Additional time added to the actual traveling time needed to use a specific mode.

7.3. The complex type ModeStructure

+ -

ModeStructure

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

The element contains a sequence of the following elements:

Mode

PtMode

1:1

siri:VehicleModesOfTransportEnumeration

Categorisation of mode

→‍siri:PtModeChoiceGroup

Name

0:1

+InternationalText

Name of the mode.

ShortName

0:1

+InternationalText

Short name or acronym of the mode.

Description

0:1

+InternationalText

Additional text that further describes the mode.

7.4. The ModeGroup group

- +

ModeGroup

Elements for a Transport Mode

Mode

PtMode

1:1

siri:VehicleModesOfTransportEnumeration

Categorisation of mode

Name

0:1

+InternationalText

Name of the mode.

ShortName

0:1

+InternationalText

Short name or acronym of the mode.

Description

0:1

+InternationalText

Additional text that further describes the mode.

7.4. The ModeGroup group

+ -

ModeGroup

Elements for a Transport Mode

Mode

PtMode

1:1

siri:VehicleModesOfTransportEnumeration

Categorisation of mode

→‍siri:PtModeChoiceGroup

7.5. The complex type PtModeFilterStructure

PtModeFilterStructure

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

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PtMode

0:*

siri:VehicleModesOfTransportEnumeration

List of PT Transport modes to include/exclude.

→‍siri:PtModeChoiceGroup

7.6. The complex type PrivateModeFilterStructure

PrivateModeFilterStructure

List of private mobility offers to include or exclude.

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PrivateMode

0:*

PrivateModes

List of private mobility offers to include/exclude.

-

8. OJP/OJP_Places.xsd - Request and response definitions for place information

8.1. Simple type definitions

PlaceTypeEnumeration

stop | address | poi | coord | location | topographicPlace

PlaceUsageEnumeration

origin | via | destination

8.2. The PlaceInformationRequestGroup group

- - +

PlaceInformationRequestGroup

The element contains one of the following elements:

PlaceInformationRequest

a

InitialInput

-1:1

+InitialPlaceInput

Initial input for the place information request. This input defines what is originally looked for.

b

PlaceRef

-1:1

+PlaceRef

Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.

Restrictions

0:1

+PlaceParam

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

7.5. The complex type PtModeFilterStructure

PtModeFilterStructure

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

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PtMode

0:*

siri:VehicleModesOfTransportEnumeration

List of PT Transport modes to include/exclude.

→‍siri:PtModeChoiceGroup

7.6. The complex type PrivateModeFilterStructure

PrivateModeFilterStructure

List of private mobility offers to include or exclude.

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PrivateMode

0:*

PrivateModes

List of private mobility offers to include/exclude.

+

8. OJP/OJP_Places.xsd - Request and response definitions for place information

8.1. Simple type definitions

PlaceTypeEnumeration

stop | address | poi | coord | topographicPlace

PlaceUsageEnumeration

origin | via | destination

8.2. The PlaceInformationRequestGroup group

+ +

PlaceInformationRequestGroup

The element contains one of the following elements:

PlaceInformationRequest

a

InitialInput

-1:1

+InitialPlaceInput

Initial input for the place information request. This input defines what is originally looked for.

b

PlaceRef

-1:1

+PlaceRef

Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.

Restrictions

0:1

+PlaceParam

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

8.3. The PlaceInformationResponseGroup group

- - - -

PlaceInformationResponseGroup

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.

PlaceResult

0:*

+PlaceResult

8.4. The complex type InitialPlaceInputStructure

InitialPlaceInputStructure

The element contains a sequence of the following elements:

Name

0:1

xs:string

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

GeoPosition

0:1

siri:LocationStructure

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

GeoRestriction

0:1

+GeoRestrictions

Restricts the resulting place objects to the given geographical area.

AllowedSystemId

0:*

xs:normalizedString

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

8.5. The complex type PlaceParamStructure

- - - - - - + + + +

PlaceParamStructure

The element contains a sequence of the following elements:

PlaceDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

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

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

PointOfInterestFilter

0:1

+PointOfInterestFilter

Filter to narrow down POI searches.

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.

PlaceResult

0:*

+PlaceResult

8.4. The complex type InitialPlaceInputStructure

InitialPlaceInputStructure

The element contains a sequence of the following elements:

Name

0:1

xs:string

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

GeoPosition

0:1

siri:LocationStructure

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

GeoRestriction

0:1

+GeoRestrictions

Restricts the resulting place objects to the given geographical area.

AllowedSystemId

0:*

xs:normalizedString

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

8.5. The complex type PlaceParamStructure

+ + + + + + - - - - -

PlaceParamStructure

The element contains a sequence of the following elements:

PlaceDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

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

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

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.

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.

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.

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.

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.

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.

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.

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

- - - - - - + + + + + +

PlaceDataFilterGroup

PlaceDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

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

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

PointOfInterestFilter

0:1

+PointOfInterestFilter

Filter to narrow down POI searches.

PlaceDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

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

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

PointOfInterestFilter

0:1

+PointOfInterestFilter

Filter to narrow down POI searches.

8.13. The ExchangePointsRequestGroup group

- - + +

ExchangePointsRequestGroup

ExchangePointsRequest

PlaceRef

0:1

+PlaceRef

Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

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

ExchangePointsRequest

PlaceRef

0:1

+PlaceRef

Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

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

8.14. The complex type ExchangePointsParamStructure

- - - - - - - + + + + + + + - - - + + +

ExchangePointsParamStructure

The element contains a sequence of the following elements:

ExchangePointsDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

DestinationSystem

0:1

siri:ParticipantRefStructure

Reference to system in which the destination (or origin) of the passenger is located.

AdjacentSystem

0:*

siri:ParticipantRefStructure

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

ExchangePointsDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

DestinationSystem

0:1

siri:ParticipantRefStructure

Reference to system in which the destination (or origin) of the passenger is located.

AdjacentSystem

0:*

siri:ParticipantRefStructure

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

ExchangePointsPolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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.

ExchangePointsPolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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.

8.15. The ExchangePointsDataFilterGroup group

- - - - - - - + + + + + + +

ExchangePointsDataFilterGroup

ExchangePointsDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

DestinationSystem

0:1

siri:ParticipantRefStructure

Reference to system in which the destination (or origin) of the passenger is located.

AdjacentSystem

0:*

siri:ParticipantRefStructure

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

ExchangePointsDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

DestinationSystem

0:1

siri:ParticipantRefStructure

Reference to system in which the destination (or origin) of the passenger is located.

AdjacentSystem

0:*

siri:ParticipantRefStructure

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

8.16. The ExchangePointsPolicyGroup group

- - - + + +

ExchangePointsPolicyGroup

ExchangePointsPolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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.

ExchangePointsPolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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.

8.17. The ExchangePointsResponseGroup group

- - - -

ExchangePointsResponseGroup

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.

+ 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

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

9.3. The complex type StopPointStructure

- - - - - - - - - -

StopPointStructure

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

The element contains a sequence of the following elements:

StopPoint

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

StopPointName

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

PrivateCode

0:*

+PrivateCode

Code of this stop point in private/foreign/proprietary coding schemes.

ParentRef

0:1

+StopPlaceRef

Reference to the stop place to which this stop point belongs.

→‍TopographicPlaceRef

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

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.4. The complex type StopPlaceRefStructure

StopPlaceRefStructure

StopPlaceCode

Reference to a Stop Place

9.5. The toplevel element StopPlaceRef

StopPlaceRef

+StopPlaceRef

Reference to a Stop Place

9.6. The StopPlaceGroup group

- - - + + + + + + + + + +

StopPlaceGroup

A stop place with id and name

StopPlace

→‍StopPlaceRef

1:1

→‍StopPlaceRef

Reference to a Stop Place

StopPlaceName

1:1

+InternationalText

Name of this stop place for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center".

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

PrivateCode

0:*

+PrivateCode

Code of this stop point in private/foreign/proprietary coding schemes.

ParentRef

0:1

+StopPlaceRef

Reference to the stop place to which this stop point belongs.

→‍TopographicPlaceRef

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

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.4. The complex type StopPlaceRefStructure

StopPlaceRefStructure

StopPlaceCode

Reference to a Stop Place

9.5. The toplevel element StopPlaceRef

StopPlaceRef

+StopPlaceRef

Reference to a Stop Place

9.6. The StopPlaceGroup group

+ + +

StopPlaceGroup

A stop place with id and name

StopPlace

→‍StopPlaceRef

1:1

→‍StopPlaceRef

Reference to a Stop Place

StopPlaceName

1:1

+InternationalText

Name of this stop place for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center".

9.7. The complex type StopPlaceStructure

- - - - - - - + + + + + + +

StopPlaceStructure

[an extended view of STOP PLACE in TMv6] a PLACE extended by ACCESSIBILITY LIMITATION properties and some attributes of the associated equipment, comprising one or more locations where vehicles may stop and where passengers may board or leave vehicles or prepare their trip, and which will usually have one or more wellknown names

The element contains a sequence of the following elements:

StopPlace

→‍StopPlaceRef

1:1

→‍StopPlaceRef

Reference to a Stop Place

StopPlaceName

1:1

+InternationalText

Name of this stop place for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center".

PrivateCode

0:*

+PrivateCode

Code of this stop place in private/foreign/proprietary coding schemes.

→‍TopographicPlaceRef

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

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

StopPlace

→‍StopPlaceRef

1:1

→‍StopPlaceRef

Reference to a Stop Place

StopPlaceName

1:1

+InternationalText

Name of this stop place for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center".

PrivateCode

0:*

+PrivateCode

Code of this stop place in private/foreign/proprietary coding schemes.

→‍TopographicPlaceRef

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

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.8. The StopAttributesGroup group

- - - -

StopAttributesGroup

[properties of a SCHEDULED STOP POINT or STOP PLACE in TMv6] selection of attributes of ACCESSIBIITY LIMITATION related to a SCHEDULED STOP POINT extended by attributes referring to some equipment.

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.9. The complex type TopographicPlaceRefStructure

TopographicPlaceRefStructure

Reference to a TopographicPlace

9.10. The toplevel element TopographicPlaceRef

TopographicPlaceRef

+TopographicPlaceRef

Reference to a TopographicPlace

9.11. The complex type TopographicPlaceStructure

TopographicPlaceStructure

[TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g. County,City, Town, Village) and of different specificity (e.g. Greater London, London, West End, Westminster, St James's).

The element contains a sequence of the following elements:

TopographicPlaceCode

1:1

TopographicPlace ID.

TopographicPlaceName

1:1

+InternationalText

Name or description of TopographicPlace for use in passenger information.

PrivateCode

0:*

+PrivateCode

Code of this TopographicPlace in private/foreign/proprietary coding schemes.

ParentRef

0:1

+TopographicPlaceRef

Reference to a parent TopographicPlace.

ReferredSystemId

0:1

xs:normalizedString

Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/

Area

0:1

+Area

Area covered by the locality described as a polygon.

9.12. The complex type PointOfInterestRefStructure

PointOfInterestRefStructure

PointOfInterestCode

Reference to a Point of Interest

9.13. The toplevel element PointOfInterestRef

PointOfInterestRef

+PointOfInterestRef

Reference to a Point of Interest

9.14. The complex type PointOfInterestStructure

PointOfInterestStructure

[corresponds to POINT OF INTEREST in TMv6 with related information] type of PLACE to or through which passengers may wish to navigate as part of their journey and which is modelled in detail by journey planners.

The element contains a sequence of the following elements:

PublicCode

1:1

PointOfInterestCode

ID of this Point of Interest.

Name

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

Additional description of the point of interest that may be appended to the name if enough space is available. F.e. "Exhibition Center".

PointOfInterestCategory

0:*

+PointOfInterestCategory

Categories this POI is associated with. Order indicates descending relevance.

PrivateCode

0:*

+PrivateCode

Code of this point of interest in private/foreign/proprietary coding schemes.

→‍TopographicPlaceRef

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

9.15. The complex type PointOfInterestCategoryStructure

PointOfInterestCategoryStructure

[a view of POINT OF INTEREST CLASSIFICATION in TMv6] categorisation of POINTs OF INTEREST in respect of the activities undertaken at them (defined by key-value-pairs).

The element contains one of the following elements:

a

OsmTag

-1:*

+OsmTag

Open Street Map tag structure (key-value)

b

PointOfInterestClassification

-1:*

xs:string

Classification of the POI (when it is not from OSM). The codification of the classification Id may include de codification source (for example "IGN:[classificationCode]")

9.16. The complex type OsmTagStructure

OsmTagStructure

Structure of an Open Street Map tag.

The element contains a sequence of the following elements:

Tag

1:1

xs:NMTOKEN

Name of Open Street Map tag (amenity, leisure, tourism, bike, ...)

Value

1:1

xs:NMTOKEN

Value for Open Street Map tag (charging_station, hostel, yes, ...)

9.17. The complex type PointOfInterestFilterStructure

PointOfInterestFilterStructure

Filter POIs by category.

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PointOfInterestCategory

0:*

+PointOfInterestCategory

These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE).

9.18. The complex type AddressRefStructure

AddressRefStructure

AddressCode

Reference to an Address

9.19. The toplevel element AddressRef

AddressRef

+AddressRef

Reference to an Address

9.20. The AddressDetailGroup group

- - - - - - - -

AddressDetailGroup

An address with its name entities

AddressDetail

CountryName

0:1

xs:string

Country of the address.

PostCode

0:1

xs:string

Postal code of the address.

TopographicPlaceName

0:1

xs:string

TopographicPlace name of the address. If set it should at least contain the city name.

→‍TopographicPlaceRef

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

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.21. The complex type AddressStructure

- - - - - - - -

AddressStructure

descriptive data associated with a PLACE that can be used to describe the unique geographical context of a PLACE for the purposes of identifying it. May be refined as either a ROAD ADDRESS, a POSTAL ADDRESS or both

The element contains a sequence of the following elements:

PublicCode

1:1

AddressCode

ID of this address.

PrivateCode

0:*

+PrivateCode

Code of this address in private/foreign/proprietary coding schemes.

Name

1:1

+InternationalText

Name or description of address for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the address that may be appended to the name if enough space is available. F.e. "Crossing with Peterstraße".

AddressDetail

CountryName

0:1

xs:string

Country of the address.

PostCode

0:1

xs:string

Postal code of the address.

TopographicPlaceName

0:1

xs:string

TopographicPlace name of the address. If set it should at least contain the city name.

→‍TopographicPlaceRef

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

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.

-

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

+ + + +

OJPFareRequestStructure

+AbstractOJPServiceRequest

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.9. The complex type TopographicPlaceRefStructure

TopographicPlaceRefStructure

Reference to a TopographicPlace

9.10. The toplevel element TopographicPlaceRef

TopographicPlaceRef

+TopographicPlaceRef

Reference to a TopographicPlace

9.11. The complex type TopographicPlaceStructure

TopographicPlaceStructure

[TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g. County,City, Town, Village) and of different specificity (e.g. Greater London, London, West End, Westminster, St James's).

The element contains a sequence of the following elements:

TopographicPlaceCode

1:1

TopographicPlace ID.

TopographicPlaceName

1:1

+InternationalText

Name or description of TopographicPlace for use in passenger information.

PrivateCode

0:*

+PrivateCode

Code of this TopographicPlace in private/foreign/proprietary coding schemes.

ParentRef

0:1

+TopographicPlaceRef

Reference to a parent TopographicPlace.

ReferredSystemId

0:1

xs:normalizedString

Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/

Area

0:1

+Area

Area covered by the locality described as a polygon.

9.12. The complex type PointOfInterestRefStructure

PointOfInterestRefStructure

PointOfInterestCode

Reference to a Point of Interest

9.13. The toplevel element PointOfInterestRef

PointOfInterestRef

+PointOfInterestRef

Reference to a Point of Interest

9.14. The complex type PointOfInterestStructure

PointOfInterestStructure

[corresponds to POINT OF INTEREST in TMv6 with related information] type of PLACE to or through which passengers may wish to navigate as part of their journey and which is modelled in detail by journey planners.

The element contains a sequence of the following elements:

PointOfInterestCode

1:1

PointOfInterestCode

ID of this Point of Interest.

PointOfInterestName

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

Additional description of the point of interest that may be appended to the name if enough space is available. F.e. "Exhibition Center".

PointOfInterestCategory

0:*

+PointOfInterestCategory

Categories this POI is associated with. Order indicates descending relevance.

PrivateCode

0:*

+PrivateCode

Code of this point of interest in private/foreign/proprietary coding schemes.

→‍TopographicPlaceRef

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

9.15. The complex type PointOfInterestCategoryStructure

PointOfInterestCategoryStructure

[a view of POINT OF INTEREST CLASSIFICATION in TMv6] categorisation of POINTs OF INTEREST in respect of the activities undertaken at them (defined by key-value-pairs).

The element contains one of the following elements:

a

OsmTag

-1:*

+OsmTag

Open Street Map tag structure (key-value)

b

PointOfInterestClassification

-1:*

xs:string

Classification of the POI (when it is not from OSM). The codification of the classification Id may include de codification source (for example "IGN:[classificationCode]")

9.16. The complex type OsmTagStructure

OsmTagStructure

Structure of an Open Street Map tag.

The element contains a sequence of the following elements:

Tag

1:1

xs:NMTOKEN

Name of Open Street Map tag (amenity, leisure, tourism, bike, ...)

Value

1:1

xs:NMTOKEN

Value for Open Street Map tag (charging_station, hostel, yes, ...)

9.17. The complex type PointOfInterestFilterStructure

PointOfInterestFilterStructure

Filter POIs by category.

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PointOfInterestCategory

0:*

+PointOfInterestCategory

These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE).

9.18. The complex type AddressRefStructure

AddressRefStructure

AddressCode

Reference to an Address

9.19. The toplevel element AddressRef

AddressRef

+AddressRef

Reference to an Address

9.20. The AddressDetailGroup group

+ + + + + + + +

AddressDetailGroup

An address with its name entities

AddressDetail

CountryName

0:1

xs:string

Country of the address.

PostCode

0:1

xs:string

Postal code of the address.

TopographicPlaceName

0:1

xs:string

TopographicPlace name of the address. If set it should at least contain the city name.

→‍TopographicPlaceRef

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

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.21. The complex type AddressStructure

+ + + + + + + +

AddressStructure

descriptive data associated with a PLACE that can be used to describe the unique geographical context of a PLACE for the purposes of identifying it. May be refined as either a ROAD ADDRESS, a POSTAL ADDRESS or both

The element contains a sequence of the following elements:

AddressCode

1:1

AddressCode

ID of this address.

PrivateCode

0:*

+PrivateCode

Code of this address in private/foreign/proprietary coding schemes.

AddressName

1:1

+InternationalText

Name or description of address for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the address that may be appended to the name if enough space is available. F.e. "Crossing with Peterstraße".

AddressDetail

CountryName

0:1

xs:string

Country of the address.

PostCode

0:1

xs:string

Postal code of the address.

TopographicPlaceName

0:1

xs:string

TopographicPlace name of the address. If set it should at least contain the city name.

→‍TopographicPlaceRef

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

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.

+

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

- - - + + + -

OJPFareRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

Then, the element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.3. The toplevel element OJPFareDelivery

OJPFareDelivery

+OJPFareDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.4. The complex type OJPFareDeliveryStructure

+

OJPFareDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.3. The toplevel element OJPFareDelivery

OJPFareDelivery

+OJPFareDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.4. The complex type OJPFareDeliveryStructure

- - + + - - - + + + -

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.

CalcTime

0:1

Calc

Calculation time.

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.

FareResponse

FareResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

FareResult

0:*

+FareResult

Fare result choice element.

→‍siri:Extensions

0:1

→‍siri:Extensions

FareResponse

FareResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

FareResult

0:*

+FareResult

Fare result choice element.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.5. The toplevel element OJPPlaceInformationRequest

OJPPlaceInformationRequest

+OJPPlaceInformationRequest (↔ siri:AbstractFunctionalServiceRequest)

10.6. The complex type OJPPlaceInformationRequestStructure

+

OJPPlaceInformationRequestStructure

+AbstractOJPServiceRequest

10.5. The toplevel element OJPPlaceInformationRequest

OJPPlaceInformationRequest

+OJPPlaceInformationRequest (↔ siri:AbstractFunctionalServiceRequest)

10.6. The complex type OJPPlaceInformationRequestStructure

- - - + + + -

OJPPlaceInformationRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

PlaceInformationRequest

a

InitialInput

-1:1

+InitialPlaceInput

Initial input for the place information request. This input defines what is originally looked for.

b

PlaceRef

-1:1

+PlaceRef

Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.

Restrictions

0:1

+PlaceParam

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

→‍siri:Extensions

0:1

→‍siri:Extensions

Then, the element contains one of the following elements:

PlaceInformationRequest

a

InitialInput

-1:1

+InitialPlaceInput

Initial input for the place information request. This input defines what is originally looked for.

b

PlaceRef

-1:1

+PlaceRef

Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.

Restrictions

0:1

+PlaceParam

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

→‍siri:Extensions

0:1

→‍siri:Extensions

10.7. The toplevel element OJPPlaceInformationDelivery

OJPPlaceInformationDelivery

+OJPPlaceInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.8. The complex type OJPPlaceInformationDeliveryStructure

+

OJPPlaceInformationDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.7. The toplevel element OJPPlaceInformationDelivery

OJPPlaceInformationDelivery

+OJPPlaceInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.8. The complex type OJPPlaceInformationDeliveryStructure

- - - + + + - - - - + + + + -

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.

CalcTime

0:1

Calc

Calculation time.

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.

CalcTime

0:1

Calc

Calculation time.

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.

PlaceResult

0:*

+PlaceResult

→‍siri:Extensions

0:1

→‍siri:Extensions

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.

PlaceResult

0:*

+PlaceResult

→‍siri:Extensions

0:1

→‍siri:Extensions

10.9. The toplevel element OJPExchangePointsRequest

OJPExchangePointsRequest

+OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest)

10.10. The complex type OJPExchangePointsRequestStructure

+

OJPExchangePointsRequestStructure

+AbstractOJPServiceRequest

10.9. The toplevel element OJPExchangePointsRequest

OJPExchangePointsRequest

+OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest)

10.10. The complex type OJPExchangePointsRequestStructure

- - - + + + -

OJPExchangePointsRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

ExchangePointsRequest

PlaceRef

0:1

+PlaceRef

Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

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

→‍siri:Extensions

0:1

→‍siri:Extensions

ExchangePointsRequest

PlaceRef

0:1

+PlaceRef

Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

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

→‍siri:Extensions

0:1

→‍siri:Extensions

10.11. The toplevel element OJPExchangePointsDelivery

OJPExchangePointsDelivery

+OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.12. The complex type OJPExchangePointsDeliveryStructure

+

OJPExchangePointsDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.11. The toplevel element OJPExchangePointsDelivery

OJPExchangePointsDelivery

+OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.12. The complex type OJPExchangePointsDeliveryStructure

- - - + + + - - - - + + + + -

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.

CalcTime

0:1

Calc

Calculation time.

The element contains a sequence of the following elements:

→‍OJPExchangePointsRequest

0:1

→‍OJPExchangePointsRequest

ServiceResponseContext

DataFrameRef

0:1

siri:DataFrameRefStructure

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

CalcTime

0:1

Calc

Calculation time.

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

→‍siri:Extensions

0:1

→‍siri:Extensions

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

→‍siri:Extensions

0:1

→‍siri:Extensions

10.13. The toplevel element OJPStopEventRequest

OJPStopEventRequest

+OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest)

10.14. The complex type OJPStopEventRequestStructure

+

OJPStopEventRequestStructure

+AbstractOJPServiceRequest

10.13. The toplevel element OJPStopEventRequest

OJPStopEventRequest

+OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest)

10.14. The complex type OJPStopEventRequestStructure

- - - + + + -

OJPStopEventRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

StopEventRequest

Place

1:1

+PlaceContext

Place for which to obtain stop event information.

Params

0:1

+StopEventParam

Request parameter

→‍siri:Extensions

0:1

→‍siri:Extensions

StopEventRequest

Place

1:1

+PlaceContext

Place for which to obtain stop event information.

Params

0:1

+StopEventParam

Request parameter

→‍siri:Extensions

0:1

→‍siri:Extensions

10.15. The toplevel element OJPStopEventDelivery

OJPStopEventDelivery

+OJPStopEventDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.16. The complex type OJPStopEventDeliveryStructure

+

OJPStopEventDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.15. The toplevel element OJPStopEventDelivery

OJPStopEventDelivery

+OJPStopEventDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.16. The complex type OJPStopEventDeliveryStructure

- - - + + + - - - + + + -

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.

CalcTime

0:1

Calc

Calculation time.

The element contains a sequence of the following elements:

→‍OJPStopEventRequest

0:1

→‍OJPStopEventRequest

ServiceResponseContext

DataFrameRef

0:1

siri:DataFrameRefStructure

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

CalcTime

0:1

Calc

Calculation time.

StopEventResponse

StopEventResponseContext

0:1

+ResponseContext

Container for data that is referenced multiple times.

StopEventResult

0:*

+StopEventResult

Enclosing element for stop event data.

→‍siri:Extensions

0:1

→‍siri:Extensions

StopEventResponse

StopEventResponseContext

0:1

+ResponseContext

Container for data that is referenced multiple times.

StopEventResult

0:*

+StopEventResult

Enclosing element for stop event data.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.17. The toplevel element OJPTripInfoRequest

OJPTripInfoRequest

+OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest)

10.18. The complex type OJPTripInfoRequestStructure

+

OJPTripInfoRequestStructure

+AbstractOJPServiceRequest

10.17. The toplevel element OJPTripInfoRequest

OJPTripInfoRequest

+OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest)

10.18. The complex type OJPTripInfoRequestStructure

- - + + - - + + - - + + -

OJPTripInfoRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

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

DatedJourneyRef

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

TimedVehicleRef

b

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

b

TimeOfOperation

1:1

xs:dateTime

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

TimedVehicleRef

b

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

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.

→‍siri:Extensions

0:1

→‍siri:Extensions

TripInfoRequest

Params

0:1

+TripInfoParam

Request parameter.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.19. The toplevel element OJPTripInfoDelivery

OJPTripInfoDelivery

+OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.20. The complex type OJPTripInfoDeliveryStructure

+

OJPTripInfoDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.19. The toplevel element OJPTripInfoDelivery

OJPTripInfoDelivery

+OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.20. The complex type OJPTripInfoDeliveryStructure

- - - + + + - - - + + + -

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.

CalcTime

0:1

Calc

Calculation time.

The element contains a sequence of the following elements:

→‍OJPTripInfoRequest

0:1

→‍OJPTripInfoRequest

ServiceResponseContext

DataFrameRef

0:1

siri:DataFrameRefStructure

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

CalcTime

0:1

Calc

Calculation time.

TripInfoResponse

TripInfoResponseContext

0:1

+ResponseContext

Response context.

TripInfoResult

0:1

+TripInfoResult

Result structure.

→‍siri:Extensions

0:1

→‍siri:Extensions

TripInfoResponse

TripInfoResponseContext

0:1

+ResponseContext

Response context.

TripInfoResult

0:1

+TripInfoResult

Result structure.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.21. The toplevel element OJPTripRequest

OJPTripRequest

+OJPTripRequest (↔ siri:AbstractFunctionalServiceRequest)

10.22. The complex type OJPTripRequestStructure

+

OJPTripRequestStructure

+AbstractOJPServiceRequest

10.21. The toplevel element OJPTripRequest

OJPTripRequest

+OJPTripRequest (↔ siri:AbstractFunctionalServiceRequest)

10.22. The complex type OJPTripRequestStructure

- - - - - - - - -

OJPTripRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

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.

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+TripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.23. The toplevel element OJPTripDelivery

OJPTripDelivery

+OJPTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.24. The complex type OJPTripDeliveryStructure

- - - - + + + + + + + + +

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.

CalcTime

0:1

Calc

Calculation time.

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.

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+TripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.23. The toplevel element OJPTripDelivery

OJPTripDelivery

+OJPTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.24. The complex type OJPTripDeliveryStructure

+ + + + - - - + + + -

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.

CalcTime

0:1

Calc

Calculation time.

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

→‍siri:Extensions

0:1

→‍siri:Extensions

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.25. The toplevel element OJPMultiPointTripRequest

OJPMultiPointTripRequest

+OJPMultiPointTripRequest (↔ siri:AbstractFunctionalServiceRequest)

10.26. The complex type OJPMultiPointTripRequestStructure

+

OJPMultiPointTripRequestStructure

+AbstractOJPServiceRequest

10.25. The toplevel element OJPMultiPointTripRequest

OJPMultiPointTripRequest

+OJPMultiPointTripRequest (↔ siri:AbstractFunctionalServiceRequest)

10.26. The complex type OJPMultiPointTripRequestStructure

- - - - - - - - -

OJPMultiPointTripRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

MultiPointTripRequest

Origin

1:*

+PlaceContext

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

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

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

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.27. The toplevel element OJPMultiPointTripDelivery

OJPMultiPointTripDelivery

+OJPMultiPointTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.28. The complex type OJPMultiPointTripDeliveryStructure

- - - - + + + + + + + + +

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.

CalcTime

0:1

Calc

Calculation time.

MultiPointTripRequest

Origin

1:*

+PlaceContext

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

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

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

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.27. The toplevel element OJPMultiPointTripDelivery

OJPMultiPointTripDelivery

+OJPMultiPointTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.28. The complex type OJPMultiPointTripDeliveryStructure

+ + + + - - - - -

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.

CalcTime

0:1

Calc

Calculation time.

MultiPointTripResponse

MultiPointTripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

MultiPointTripResult

0:*

+MultiPointTripResult

The trip results found by the server.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.29. The toplevel element OJPTripRefineRequest

OJPTripRefineRequest

+OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest)

10.30. The complex type OJPTripRefineRequestStructure

- - - - - - - -

OJPTripRefineRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

TripRefineRequest

RefineParams

0:1

+TripRefineParam

Options to control the refine

TripResult

1:1

+TripResult

The trip result to be refined by the server.

TripResponseContext

0:1

+ResponseContext

Context to hold objects, which are referenced within the response.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.31. The toplevel element OJPTripRefineDelivery

OJPTripRefineDelivery

+OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.32. The complex type OJPTripRefineDeliveryStructure

- - - - - - - - - + + +

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.

CalcTime

0:1

Calc

Calculation time.

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.

→‍siri:Extensions

0:1

→‍siri:Extensions

MultiPointTripResponse

MultiPointTripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

MultiPointTripResult

0:*

+MultiPointTripResult

The trip results found by the server.

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

- - + +

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)

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

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.

CalcTime

0:1

Calc

Calculation time.

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.

11.5. The SubscriptionRequestContextGroup group

- - + + - - + + - +

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.

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.

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)

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)

SubscriptionRequestContext

Extension

0:1

xs:anyType

SubscriptionRequestContext

Extension

0:1

xs:anyType

11.6. The complex type AbstractOJPServiceRequestStructure

- - + +

AbstractOJPServiceRequestStructure

siri:AbstractFunctionalServiceRequestStructure

Basic request structure common for all OJP service requests.

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

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

- - + + - - + + - +

AbstractOJPSubscriptionRequestStructure

siri:AbstractSubscriptionRequestStructure

Basic structure common for all OJP 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.

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.

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)

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)

SubscriptionRequestContext

Extension

0:1

xs:anyType

SubscriptionRequestContext

Extension

0:1

xs:anyType

11.8. The DeliveryRequestGroup group

@@ -692,8 +636,8 @@

OJP - Open API for distributed Journey

DeliveryRequestGroup

Wrapper for SIRI delivery request group.

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

-

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.

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.

+

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.

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

13.1. Simple type definitions

HierarchyEnumeration

local | no | down | all

@@ -706,24 +650,24 @@

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

StopEventRequest

Place

1:1

+PlaceContext

Place for which to obtain stop event information.

Params

0:1

+StopEventParam

Request parameter

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

- - - + + + - - - + + + - - - - - - - + + + + + +

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:

StopEventDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in stop events.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

StopEventDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in stop events.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

StopEventPolicy

NumberOfResults

0:1

xs:positiveInteger

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

TimeWindow

0:1

xs:duration

Time window events should lie within. Starting from time given in PlaceContext.

StopEventType

0:1

StopEventType

Only departures or arrivals or both.

StopEventPolicy

NumberOfResults

0:1

xs:positiveInteger

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

TimeWindow

0:1

xs:duration

Time window events should lie within. Starting from time given in PlaceContext.

StopEventType

0:1

StopEventType

Only departures or arrivals or both.

StopEventContentFilter

IncludePreviousCalls

0:1

xs:boolean

Whether the previous calls of each vehicle journey should be included in the response.

IncludeOnwardCalls

0:1

xs:boolean

Whether the onward calls of each vehicle journey should be included in the response.

IncludeOperatingDays

0:1

xs:boolean

Whether operating day information of this stop event should be included in the response.

IncludeRealtimeData

0:1

xs:boolean

Whether realtime information of this stop event should be included in the response.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

IncludeStopHierarchy

0:1

Hierarchy

Indicates for which parts of the hierarchy of the StopPlace(s) stop events should +

StopEventContentFilter

IncludePreviousCalls

0:1

xs:boolean

Whether the previous calls of each vehicle journey should be included in the response.

IncludeOnwardCalls

0:1

xs:boolean

Whether the onward calls of each vehicle journey should be included in the response.

IncludeOperatingDays

0:1

xs:boolean

Whether operating day information of this stop event should be included in the response.

IncludeRealtimeData

0:1

xs:boolean

Whether realtime information of this stop event should be included in the response.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

IncludeStopHierarchy

0:1

Hierarchy

Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided (if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/ StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces @@ -733,21 +677,21 @@

OJP - Open API for distributed Journey

13.4. The StopEventDataFilterGroup group

- - - + + +

StopEventDataFilterGroup

Request data filters

StopEventDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in stop events.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

StopEventDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in stop events.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

13.5. The StopEventPolicyGroup group

- - - + + +

StopEventPolicyGroup

Request policies

StopEventPolicy

NumberOfResults

0:1

xs:positiveInteger

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

TimeWindow

0:1

xs:duration

Time window events should lie within. Starting from time given in PlaceContext.

StopEventType

0:1

StopEventType

Only departures or arrivals or both.

StopEventPolicy

NumberOfResults

0:1

xs:positiveInteger

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

TimeWindow

0:1

xs:duration

Time window events should lie within. Starting from time given in PlaceContext.

StopEventType

0:1

StopEventType

Only departures or arrivals or both.

13.6. The StopEventContentFilterGroup group

- - - - - - - + + + + + +

StopEventContentFilterGroup

Content filters which data is expected in the response

StopEventContentFilter

IncludePreviousCalls

0:1

xs:boolean

Whether the previous calls of each vehicle journey should be included in the response.

IncludeOnwardCalls

0:1

xs:boolean

Whether the onward calls of each vehicle journey should be included in the response.

IncludeOperatingDays

0:1

xs:boolean

Whether operating day information of this stop event should be included in the response.

IncludeRealtimeData

0:1

xs:boolean

Whether realtime information of this stop event should be included in the response.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

IncludeStopHierarchy

0:1

Hierarchy

Indicates for which parts of the hierarchy of the StopPlace(s) stop events should +

StopEventContentFilter

IncludePreviousCalls

0:1

xs:boolean

Whether the previous calls of each vehicle journey should be included in the response.

IncludeOnwardCalls

0:1

xs:boolean

Whether the onward calls of each vehicle journey should be included in the response.

IncludeOperatingDays

0:1

xs:boolean

Whether operating day information of this stop event should be included in the response.

IncludeRealtimeData

0:1

xs:boolean

Whether realtime information of this stop event should be included in the response.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

IncludeStopHierarchy

0:1

Hierarchy

Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided (if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/ StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces @@ -757,324 +701,300 @@

OJP - Open API for distributed Journey

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.

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

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

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.

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

DatedJourneyRef

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

TimedVehicleRef

b

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

b

TimeOfOperation

1:1

xs:dateTime

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

TimedVehicleRef

b

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

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.

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:

TripInfoPolicy

UseTimetabledDataOnly

0:1

xs:boolean

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

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.

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.

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.

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.

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.

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.

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.

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.

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.

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.

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.

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

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.

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.

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.

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.

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

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.

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

lift | stairs | seriesOfStairs | escalator | ramp | footpath

Allowed values for a AccessFeature.

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.

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.

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+TripParam

Options to control the search behaviour and response contents.

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

lift | stairs | seriesOfStairs | escalator | ramp | footpath

Allowed values for a AccessFeature.

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 | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture

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

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.

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.

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+TripParam

Options to control the search behaviour and response contents.

15.3. The complex type TripParamStructure

- - - - - + + + + - - - - - - + + + + + + - - - - + + + + - - - - - + + + + + - - - + + + - - - - - - + + + + + + - - - - -

TripParamStructure

Trip request parameter structure.

The element contains a sequence of the following elements:

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

VehicleFilter

0:1

+VehicleFilter

Filter for VEHICLE and TRAIN NUMBERs.

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

Then, the element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

TripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

ItModesToCover

0:*

IndividualModes

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

TripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

ItModesToCover

0:*

IndividualModes

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

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

Extension

0:1

xs:anyType

15.4. The TripDataFilterGroup group

- - - - - + + + + +

TripDataFilterGroup

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

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

VehicleFilter

0:1

+VehicleFilter

Filter for VEHICLE and TRAIN NUMBERs.

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

Extension

0:1

xs:anyType

15.4. The TripDataFilterGroup group

+ + + +

TripDataFilterGroup

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

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

15.5. The TripPolicyGroup group

- - - - - + + + + + - - - + + +

TripPolicyGroup

Policies that control the trip search behaviour.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

TripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

ItModesToCover

0:*

IndividualModes

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

TripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

ItModesToCover

0:*

IndividualModes

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

15.6. The TripMobilityFilterGroup group

- - - - - - + + + + + + - - - - + + + +

TripMobilityFilterGroup

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

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

15.7. The TripContentFilterGroup group

- - - - - - + + + + + + - - - - -

TripContentFilterGroup

Parameters that control the level of detail of the trip results.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

15.8. The complex type NotViaStructure

NotViaStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.9. The complex type NoChangeAtStructure

NoChangeAtStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.10. The TripResponseGroup group

- - -

TripResponseGroup

Trip response structure.

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

15.11. The complex type TripResultStructure

TripResultStructure

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

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

ErrorMessage

0:*

+ErrorMessage

Error messages related to this trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Detailed information on trip.

b

TripSummary

-1:1

+TripSummary

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

TripFare

0:*

+TripFareResult

15.12. The complex type TripSummaryStructure

- - -

TripSummaryStructure

Structure for trip overview information.

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Origin

0:1

+PlaceRef

Describes the origin situation of this trip.

Destination

0:1

+PlaceRef

Describes the arrival situation of this trip.

Duration

0:1

xs:duration

Overall duration of the trip.

StartTime

0:1

xs:dateTime

Departure time at origin.

EndTime

0:1

xs:dateTime

Arrival time at destination.

PTTripLegs

0:1

xs:nonNegativeInteger

Number of public transport trip legs.

Distance

0:1

siri:DistanceType

Trip distance.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.13. The complex type TripStructure

- - - - - - - - -

TripStructure

[an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Duration

1:1

xs:duration

Overall duration of the trip.

StartTime

1:1

xs:dateTime

Departure time at origin.

EndTime

1:1

xs:dateTime

Arrival time at destination.

Transfers

1:1

xs:nonNegativeInteger

Number of interchanges.

Distance

0:1

siri:DistanceType

Trip distance.

TripLeg

1:*

+TripLeg

Legs of the trip

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

TripStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Delayed

0:1

xs:boolean

Whether this trip is delayed. Default is false.

Infeasible

0:1

xs:boolean

Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

Extension

0:1

xs:anyType

15.14. The complex type TripLegStructure

TripLegStructure

a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)

The element contains a sequence of the following elements:

LegId

1:1

xs:NMTOKEN

Id of this trip leg. Unique within trip result.

ParticipantRef

0:1

siri:ParticipantRefStructure

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

Then, the element contains one of the following elements:

a

ContinuousLeg

-1:1

+ContinuousLeg

b

TimedLeg

-1:1

+TimedLeg

c

TransferLeg

-1:1

+TransferLeg

15.15. The complex type TimedLegStructure

- - -

TimedLegStructure

passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE.

The element contains a sequence of the following elements:

LegBoard

1:1

+LegBoard

Stop/Station where boarding is done

LegIntermediates

0:*

+LegIntermediate

information about the intermediate passed stop points.

LegAlight

1:1

+LegAlight

Stop/Station to alight

Service

1:1

+DatedJourney

Service that is used for this trip leg.

LegAttribute

0:*

+LegAttribute

Attributes that are not valid on the whole service, but only on parts of the journey leg.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

LegTrack

0:1

+LegTrack

Geographic embedding of this leg.

Extension

0:1

xs:anyType

15.16. The complex type TransferLegStructure

- - + + + + +

TransferLegStructure

[a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

ContinuousMode

-1:1

ContinuousModes

Mode that is used for this interchange between public services.

b

TransferMode

-1:1

TransferModes

Mode that is used for this interchange between public services.

LegStart

1:1

+PlaceRef

Stop/Station where boarding is done

LegEnd

1:1

+PlaceRef

Stop/Station to alight

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

15.8. The complex type NotViaStructure

NotViaStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.9. The complex type NoChangeAtStructure

NoChangeAtStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.10. The TripResponseGroup group

+ + +

TripResponseGroup

Trip response structure.

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

15.11. The complex type TripResultStructure

TripResultStructure

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

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

ErrorMessage

0:*

+ErrorMessage

Error messages related to this trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Detailed information on trip.

b

TripSummary

-1:1

+TripSummary

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

TripFare

0:*

+TripFareResult

15.12. The complex type TripSummaryStructure

+ + +

TripSummaryStructure

Structure for trip overview information.

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Origin

0:1

+PlaceRef

Describes the origin situation of this trip.

Destination

0:1

+PlaceRef

Describes the arrival situation of this trip.

Duration

0:1

xs:duration

Overall duration of the trip.

StartTime

0:1

xs:dateTime

Departure time at origin.

EndTime

0:1

xs:dateTime

Arrival time at destination.

PTTripLegs

0:1

xs:nonNegativeInteger

Number of public transport trip legs.

Distance

0:1

siri:DistanceType

Trip distance.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.13. The complex type TripStructure

+ + + + + + + + +

TripStructure

[an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Duration

1:1

xs:duration

Overall duration of the trip.

StartTime

1:1

xs:dateTime

Departure time at origin.

EndTime

1:1

xs:dateTime

Arrival time at destination.

Transfers

1:1

xs:nonNegativeInteger

Number of interchanges.

Distance

0:1

siri:DistanceType

Trip distance.

TripLeg

1:*

+TripLeg

Legs of the trip

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

TripStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Delayed

0:1

xs:boolean

Whether this trip is delayed. Default is false.

Infeasible

0:1

xs:boolean

Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

Extension

0:1

xs:anyType

15.14. The complex type TripLegStructure

TripLegStructure

a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)

The element contains a sequence of the following elements:

LegId

1:1

xs:NMTOKEN

Id of this trip leg. Unique within trip result.

ParticipantRef

0:1

siri:ParticipantRefStructure

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

Then, the element contains one of the following elements:

a

ContinuousLeg

-1:1

+ContinuousLeg

b

TimedLeg

-1:1

+TimedLeg

c

TransferLeg

-1:1

+TransferLeg

15.15. The complex type TimedLegStructure

+ + +

TimedLegStructure

passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE.

The element contains a sequence of the following elements:

LegBoard

1:1

+LegBoard

Stop/Station where boarding is done

LegIntermediates

0:*

+LegIntermediate

information about the intermediate passed stop points.

LegAlight

1:1

+LegAlight

Stop/Station to alight

Service

1:1

+DatedJourney

Service that is used for this trip leg.

LegAttribute

0:*

+LegAttribute

Attributes that are not valid on the whole service, but only on parts of the journey leg.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

LegTrack

0:1

+LegTrack

Geographic embedding of this leg.

Extension

0:1

xs:anyType

15.16. The complex type TransferLegStructure

+ + - - - -

TransferLegStructure

[a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

ContinuousMode

-1:1

ContinuousModes

Mode that is used for this interchange between public services.

b

TransferMode

-1:1

TransferModes

Mode that is used for this interchange between public services.

LegStart

1:1

+PlaceRef

Stop/Station where boarding is done

LegEnd

1:1

+PlaceRef

Stop/Station to alight

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

TransferDuration

Duration

1:1

xs:duration

Overall duration of this interchange.

WalkDuration

0:1

xs:duration

Walk time as part of the overall interchange duration.

BufferTime

0:1

xs:duration

Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

LegDescription

0:1

+InternationalText

Text that describes this interchange.

Length

0:1

Length

Length of this interchange path.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

PathGuidance

0:1

+PathGuidance

Structured model further describing this interchange, its geographic embedding and accessibility.

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.17. The complex type ContinuousLegStructure

- - -

ContinuousLegStructure

[relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable

The element contains a sequence of the following elements:

LegStart

1:1

+PlaceRef

Stop/Station where boarding is done

LegEnd

1:1

+PlaceRef

Stop/Station to alight

Service

1:1

+ContinuousService

Service of this leg. May be "walk" in most cases, but also cycling or taxi etc.

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

Duration

1:1

xs:duration

Duration of this leg according to user preferences like walk speed.

LegDescription

0:1

+InternationalText

Title or summary of this leg for overview.

Length

0:1

Length

Length of the leg.

LegTrack

0:1

+LegTrack

Detailed description of each element of this leg including geometric projection.

PathGuidance

0:1

+PathGuidance

Structured model further describing this interchange, its geographic embedding and accessibility.

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.18. The complex type LegBoardStructure

- - - - - - - - - - - - + + + +

LegBoardStructure

Describes the the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information.

The element contains a sequence of the following elements:

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

0:1

+ServiceArrival

describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

1:1

+ServiceDeparture

describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

DistributorInterchangeId

0:1

xs:normalizedString

Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

TransferDuration

Duration

1:1

xs:duration

Overall duration of this interchange.

WalkDuration

0:1

xs:duration

Walk time as part of the overall interchange duration.

BufferTime

0:1

xs:duration

Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

LegDescription

0:1

+InternationalText

Text that describes this interchange.

Length

0:1

Length

Length of this interchange path.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

PathGuidance

0:1

+PathGuidance

Structured model further describing this interchange, its geographic embedding and accessibility.

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.17. The complex type ContinuousLegStructure

+ + +

ContinuousLegStructure

[relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable

The element contains a sequence of the following elements:

LegStart

1:1

+PlaceRef

Stop/Station where boarding is done

LegEnd

1:1

+PlaceRef

Stop/Station to alight

Service

1:1

+ContinuousService

Service of this leg. May be "walk" in most cases, but also cycling or taxi etc.

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

Duration

1:1

xs:duration

Duration of this leg according to user preferences like walk speed.

LegDescription

0:1

+InternationalText

Title or summary of this leg for overview.

Length

0:1

Length

Length of the leg.

LegTrack

0:1

+LegTrack

Detailed description of each element of this leg including geometric projection.

PathGuidance

0:1

+PathGuidance

Structured model further describing this interchange, its geographic embedding and accessibility.

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.18. The complex type LegBoardStructure

+ + + + + + + + + + + +

LegBoardStructure

Describes the the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information.

The element contains a sequence of the following elements:

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

0:1

+ServiceArrival

describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

1:1

+ServiceDeparture

describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

DistributorInterchangeId

0:1

xs:normalizedString

Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

15.19. The complex type LegAlightStructure

- - - - - - - - - - - - + + + + + + + + + + + +

LegAlightStructure

Describes the situation at a stop or station at which the passenger alights from a Leg of a trip including time-related information

The element contains a sequence of the following elements:

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

1:1

+ServiceArrival

describes the arrival situation at the leg alight stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

0:1

+ServiceDeparture

describes the departure situation at this leg alight stop point (empty for last leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

FeederInterchangeId

0:1

xs:normalizedString

Interchange identifier of the feeding line/service at its alighting. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

1:1

+ServiceArrival

describes the arrival situation at the leg alight stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

0:1

+ServiceDeparture

describes the departure situation at this leg alight stop point (empty for last leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

FeederInterchangeId

0:1

xs:normalizedString

Interchange identifier of the feeding line/service at its alighting. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

15.20. The complex type LegIntermediateStructure

- - - - - - - - - - - - -

LegIntermediateStructure

Describes the situation at a stop or station that lies between the LegBoard and LegAlight stop or station including time-related information.

The element contains a sequence of the following elements:

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

1:1

+ServiceArrival

describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

1:1

+ServiceDeparture

describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

15.21. The complex type PathGuidanceStructure

PathGuidanceStructure

description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

The element contains only one element:

PathGuidanceSection

1:*

+PathGuidanceSection

one or more path guidance sections that build the trip Leg

15.22. The complex type PathGuidanceSectionStructure

PathGuidanceSectionStructure

[an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

The element contains a sequence of the following elements:

TrackSection

0:1

+TrackSection

LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

TurnDescription

0:1

+InternationalText

Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName.

GuidanceAdvice

0:1

GuidanceAdvice

various types of guidance advice given to travelle.

TurnAction

0:1

TurnAction

the range of alternative turns that can be described.

DirectionHint

0:1

+InternationalText

Textual direction hint for better understanding, e.g. "follow signs to Hamburg".

Bearing

0:1

siri:AbsoluteBearingType

Absolute bearing after the described manoeuvre.

PathLink

0:1

+PathLink

Description of the type of accessibility on this navigation section.

SituationFullRef

0:*

+SituationFullRef

15.23. The TransferDurationGroup group

- - - -

TransferDurationGroup

[an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time..

TransferDuration

Duration

1:1

xs:duration

Overall duration of this interchange.

WalkDuration

0:1

xs:duration

Walk time as part of the overall interchange duration.

BufferTime

0:1

xs:duration

Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

15.24. The complex type PathLinkStructure

PathLinkStructure

[TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE.

The element contains a sequence of the following elements:

Transition

0:1

Transition

Whether path is up down or level .

AccessFeatureType

0:1

AccessFeatureType

Type of physical feature of PATH LINK.

Count

0:1

xs:positiveInteger

Number how often the access feature occurs in this PathLink

From

0:1

+PathLinkEnd

Designations of level and place where this PathLink starts.

To

0:1

+PathLinkEnd

Designations of level and place where this PathLink ends.

15.25. The complex type PathLinkEndStructure

PathLinkEndStructure

Designations of a floor/level.

The element contains a sequence of the following elements:

LevelPublicCode

0:1

xs:normalizedString

Public identifier of the level as found on elevators and signs.

LevelName

0:1

+InternationalText

Official name of the level.

Id

0:1

xs:normalizedString

Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located).

15.26. The MultiPointTripRequestGroup group

- - - - - - -

MultiPointTripRequestGroup

Multi-point trip request structure.

MultiPointTripRequest

Origin

1:*

+PlaceContext

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

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

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

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

15.27. The complex type MultiPointTripParamStructure

- - - - - + + + + + + + + + + + + +

MultiPointTripParamStructure

Multi-point trip request parameter structure.

The element contains a sequence of the following elements:

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

VehicleFilter

0:1

+VehicleFilter

Filter for VEHICLE and TRAIN NUMBERs.

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

1:1

+ServiceArrival

describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

1:1

+ServiceDeparture

describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

15.21. The complex type PathGuidanceStructure

PathGuidanceStructure

description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

The element contains only one element:

PathGuidanceSection

1:*

+PathGuidanceSection

one or more path guidance sections that build the trip Leg

15.22. The complex type PathGuidanceSectionStructure

PathGuidanceSectionStructure

[an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

The element contains a sequence of the following elements:

TrackSection

0:1

+TrackSection

LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

TurnDescription

0:1

+InternationalText

Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName.

GuidanceAdvice

0:1

GuidanceAdvice

various types of guidance advice given to travelle.

TurnAction

0:1

TurnAction

the range of alternative turns that can be described.

DirectionHint

0:1

+InternationalText

Textual direction hint for better understanding, e.g. "follow signs to Hamburg".

Bearing

0:1

siri:AbsoluteBearingType

Absolute bearing after the described manoeuvre.

PathLink

0:1

+PathLink

Description of the type of accessibility on this navigation section.

SituationFullRef

0:*

+SituationFullRef

15.23. The TransferDurationGroup group

+ + + +

TransferDurationGroup

[an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time..

TransferDuration

Duration

1:1

xs:duration

Overall duration of this interchange.

WalkDuration

0:1

xs:duration

Walk time as part of the overall interchange duration.

BufferTime

0:1

xs:duration

Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

15.24. The complex type PathLinkStructure

PathLinkStructure

[TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE.

The element contains a sequence of the following elements:

Transition

0:1

Transition

Whether path is up down or level .

AccessFeatureType

0:1

AccessFeatureType

Type of physical feature of PATH LINK.

Count

0:1

xs:positiveInteger

Number how often the access feature occurs in this PathLink

15.25. The MultiPointTripRequestGroup group

+ + + + + + +

MultiPointTripRequestGroup

Multi-point trip request structure.

MultiPointTripRequest

Origin

1:*

+PlaceContext

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

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

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

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

15.26. The complex type MultiPointTripParamStructure

+ + + + - - - - - - + + + + + + - - - - + + + + - - - - - + + + + + - - - + + + - - - - - - + + + + + + - - - - -

MultiPointTripParamStructure

Multi-point trip request parameter structure.

The element contains a sequence of the following elements:

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

Then, the element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

MultiPointTripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

MultiPointType

0:1

MultiPointType

If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

MultiPointTripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

MultiPointType

0:1

MultiPointType

If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

Extension

0:1

xs:anyType

15.28. The MultiPointTripPolicyGroup group

+ + + + +

MultiPointTripPolicyGroup

Policies that control the multi-point trip search behaviour.

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

Extension

0:1

xs:anyType

15.27. The MultiPointTripPolicyGroup group

- - - - - + + + + + - - - -

MultiPointTripPolicyGroup

Policies that control the multi-point trip search behaviour.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

MultiPointTripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

MultiPointType

0:1

MultiPointType

If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

15.29. The MultiPointTripResponseGroup group

- - -

MultiPointTripResponseGroup

Multi-point trip response structure.

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

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

TripFare

0:*

+TripFareResult

15.31. The MultiPointWaitTimeGroup group

- - -

MultiPointWaitTimeGroup

Group for wait times at origin/destination.

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

15.32. The TripStatusGroup group

- - - - - -

TripStatusGroup

Parameters which describe the current status of a TRIP

TripStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Delayed

0:1

xs:boolean

Whether this trip is delayed. Default is false.

Infeasible

0:1

xs:boolean

Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

15.33. The TripRefineRequestGroup group

- - - -

TripRefineRequestGroup

Trip refinement request structure.

TripRefineRequest

RefineParams

0:1

+TripRefineParam

Options to control the refine

TripResult

1:1

+TripResult

The trip result to be refined by the server.

TripResponseContext

0:1

+ResponseContext

Context to hold objects, which are referenced within the response.

15.34. The complex type TripRefineParamStructure

- - - - - - - - - - - - -

TripRefineParamStructure

Trip refinement request parameter structure.

The element contains a sequence of the following elements:

ForeignObjectRefs

0:1

xs:boolean

If true, then the request may contain object references from another system. Default is FALSE.

RefineLegRef

1:*

xs:NMTOKEN

Refers to a leg to be refined by the server.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

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

Extension

0:1

xs:anyType

15.35. The TripRefineResponseGroup group

- - - + + + +

TripRefineResponseGroup

Trip refinement response structure.

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.

MultiPointTripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

MultiPointType

0:1

MultiPointType

If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

15.28. 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.29. The complex type MultiPointTripResultStructure

+ + +

MultiPointTripResultStructure

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

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

ErrorMessage

0:*

+ErrorMessage

Error messages related to trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Information on the trip.

b

TripSummary

-1:1

+TripSummary

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

TripFare

0:*

+TripFareResult

15.30. The MultiPointWaitTimeGroup group

+ + +

MultiPointWaitTimeGroup

Group for wait times at origin/destination.

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

15.31. The TripStatusGroup group

+ + + + +

TripStatusGroup

Parameters which describe the current status of a TRIP

TripStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Delayed

0:1

xs:boolean

Whether this trip is delayed. Default is false.

Infeasible

0:1

xs:boolean

Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

-

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?

Embeddable

0:1

xs:boolean

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

16.4. The complex type WebLinkStructure

- - - +

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

16.1. Simple type definitions

WebLinkStructure

URL of a web resource with label.

The element contains a sequence of the following elements:

Label

1:1

+InternationalText

Label for link description.

WebLink

Url

1:1

xs:anyURI

URL to resource on web.

MimeType

0:1

xs:normalizedString

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

Embeddable

0:1

xs:boolean

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

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?

Embeddable

0:1

xs:boolean

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

16.4. The complex type WebLinkStructure

+ + +

WebLinkStructure

URL of a web resource with label.

The element contains a sequence of the following elements:

Label

1:1

+InternationalText

Label for link description.

WebLink

Url

1:1

xs:anyURI

URL to resource on web.

MimeType

0:1

xs:normalizedString

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

Embeddable

0:1

xs:boolean

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

From 94f4b77f0b2ae3be17da3714cb8d51778876e79d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20G=C3=BCnter?= Date: Sat, 27 Aug 2022 11:45:37 +0200 Subject: [PATCH 2/4] adapt to changes discussed in the group. This will however, change the intension Andreas had here. But I guess this is unavoidable as there are differences in opinion. And VehicleNumber has a different meaning and also does not exist in the way Andreas intended in Transmodel. Using TRAIN NUMBER also for non-train modes, if the service level intention is the some as fulfilled by TRAIN NUMBER seems better. --- OJP/OJP_JourneySupport.xsd | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/OJP/OJP_JourneySupport.xsd b/OJP/OJP_JourneySupport.xsd index 33b90cc3d..b1e6eb385 100644 --- a/OJP/OJP_JourneySupport.xsd +++ b/OJP/OJP_JourneySupport.xsd @@ -89,12 +89,13 @@ - Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. + Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes +will use TrainNumber. - + - Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber. + Contains the Vehicle reference of the vehicle. In Transmodel this may be VEHICLE.Id. From c226b3456f24de60e44535528886b9554879b869 Mon Sep 17 00:00:00 2001 From: ue71603 Date: Sat, 27 Aug 2022 12:17:31 +0200 Subject: [PATCH 3/4] fixing VehicleRef --- OJP/OJP_JourneySupport.xsd | 2 +- docs/generated/OJP.html | 1556 +++++++++++++++++++----------------- 2 files changed, 824 insertions(+), 734 deletions(-) diff --git a/OJP/OJP_JourneySupport.xsd b/OJP/OJP_JourneySupport.xsd index b1e6eb385..5ba6f0c29 100644 --- a/OJP/OJP_JourneySupport.xsd +++ b/OJP/OJP_JourneySupport.xsd @@ -93,7 +93,7 @@ will use TrainNumber. - + Contains the Vehicle reference of the vehicle. In Transmodel this may be VEHICLE.Id. diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index 26b947ed8..6d1e94204 100644 --- a/docs/generated/OJP.html +++ b/docs/generated/OJP.html @@ -1,12 +1,54 @@ - + OJP - Open API for distributed Journey Planning - - + + +
-

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

- - +

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

1.1. The toplevel element OJP

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

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

+ +

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

- - -

TimedVehicleRefGroup

Reference to a vehicle for a specific point in time.

TimedVehicleRef

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

TimeOfOperation

1:1

xs:dateTime

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

2.16. The SharingServiceUsageGroup group

- - -

SharingServiceUsageGroup

Usage parameters of a sharing service.

SharingServiceUsage

TimeBufferBefore

0:1

xs:duration

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

TimeBufferAfter

0:1

xs:duration

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

2.17. The complex type SharingServiceStructure

- - -

SharingServiceStructure

Service that provides shared vehicles.

The element contains a sequence of the following elements:

OperatorRef

1:1

siri:OperatorRefStructure

Identifier of the operator of the sharing service

Name

0:1

xs:string

Public name of the service.

SharingModel

0:1

SharingModel

Type of the sharing scheme.

SharingServiceUsage

TimeBufferBefore

0:1

xs:duration

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

TimeBufferAfter

0:1

xs:duration

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

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

2.18. The complex type OwnerRefStructure

OwnerRefStructure

OwnerCode

Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

2.19. The toplevel element OwnerRef

OwnerRef

+OwnerRef

Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

2.20. The complex type OperatingDayRefStructure

OperatingDayRefStructure

OperatingDayCode

Reference to an Operating Day

2.21. The toplevel element OperatingDayRef

OperatingDayRef

+OperatingDayRef

Reference to an Operating Day

2.22. The complex type OperatingDaysStructure

OperatingDaysStructure

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

The element contains a sequence of the following elements:

From

1:1

xs:date

Start date of period.

To

1:1

xs:date

End date of period.

Pattern

1:1

ValidDayBit

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

2.23. The OperatingDaysGroup group

- - -

OperatingDaysGroup

Coded as bit pattern

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

2.24. The complex type WeekdayTimePeriodStructure

WeekdayTimePeriodStructure

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

The element contains a sequence of the following elements:

Weekday

0:*

WeekdayType

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

StartTime

1:1

xs:time

Start time of period.

Duration

1:1

xs:duration

Time duration of period.

2.25. The complex type GeneralAttributeStructure

+ + +

GeneralAttributeStructure

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

The element contains a sequence of the following elements:

Text

1:1

+InternationalText

Text of the attribute to be shown to the user.

Code

1:1

xs:NMTOKEN

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

TimedVehicleRef

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

TimeOfOperation

1:1

xs:dateTime

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

2.16. The complex type VehicleFilterStructure

VehicleFilterStructure

Filter for Vehicles

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

VehicleRef

0:*

siri:VehicleRefStructure

Reference to VEHICLE

TrainNumber

0:*

xs:normalizedString

TRAIN NUMBERs

2.17. The SharingServiceUsageGroup group

+ + +

SharingServiceUsageGroup

Usage parameters of a sharing service.

SharingServiceUsage

TimeBufferBefore

0:1

xs:duration

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

TimeBufferAfter

0:1

xs:duration

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

2.18. The complex type SharingServiceStructure

+ + +

SharingServiceStructure

Service that provides shared vehicles.

The element contains a sequence of the following elements:

OperatorRef

1:1

siri:OperatorRefStructure

Identifier of the operator of the sharing service

Name

0:1

xs:string

Public name of the service.

SharingModel

0:1

SharingModel

Type of the sharing scheme.

SharingServiceUsage

TimeBufferBefore

0:1

xs:duration

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

TimeBufferAfter

0:1

xs:duration

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

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

2.19. The complex type OwnerRefStructure

OwnerRefStructure

OwnerCode

Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

2.20. The toplevel element OwnerRef

OwnerRef

+OwnerRef

Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE

2.21. The complex type OperatingDayRefStructure

OperatingDayRefStructure

OperatingDayCode

Reference to an Operating Day

2.22. The toplevel element OperatingDayRef

OperatingDayRef

+OperatingDayRef

Reference to an Operating Day

2.23. The complex type OperatingDaysStructure

OperatingDaysStructure

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

The element contains a sequence of the following elements:

From

1:1

xs:date

Start date of period.

To

1:1

xs:date

End date of period.

Pattern

1:1

ValidDayBit

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

2.24. The OperatingDaysGroup group

+ + +

OperatingDaysGroup

Coded as bit pattern

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

2.25. The complex type WeekdayTimePeriodStructure

WeekdayTimePeriodStructure

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

The element contains a sequence of the following elements:

Weekday

0:*

WeekdayType

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

StartTime

1:1

xs:time

Start time of period.

Duration

1:1

xs:duration

Time duration of period.

2.26. The complex type GeneralAttributeStructure

- - - - + + + +

GeneralAttributeStructure

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

The element contains a sequence of the following elements:

Text

1:1

+InternationalText

Text of the attribute to be shown to the user.

Code

1:1

xs:NMTOKEN

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

→‍siri:AllFacilitiesGroup

Mandatory

0:1

xs:boolean

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

Importance

0:1

Percent

Importance of the attribute.

WebLink

Url

1:1

xs:anyURI

URL to resource on web.

MimeType

0:1

xs:normalizedString

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

Embeddable

0:1

xs:boolean

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

Mandatory

0:1

xs:boolean

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

Importance

0:1

Percent

Importance of the attribute.

WebLink

Url

1:1

xs:anyURI

URL to resource on web.

MimeType

0:1

xs:normalizedString

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

Embeddable

0:1

xs:boolean

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

3. OJP/OJP_FacilitySupport.xsd - Supporting definitions for facilities containing wrappers for SIRI

3.1. The AllFacilitiesGroup group

@@ -65,569 +107,593 @@

OJP - Open API for distributed Journey

AllFacilitiesGroup

Wrapper for SIRI facilities.

→‍siri:AllFacilitiesGroup

→‍siri:ServiceFacilityGroup

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

4.1. The FareRequestGroup group

- - -

FareRequestGroup

Fare request structure.

The element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

4.2. The complex type StopFareRequestStructure

StopFareRequestStructure

Sub-request: stop-related fare information.

The element contains a sequence of the following elements:

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

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 a traveller card (f.e. BahnCard50, BahnCard50First etc.).

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.

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

VatRateEnumeration

no | full | half | mixed | unknown

Enumeration of Value Added Tax rates.

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

- - -

TariffZoneListInAreaStructure

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

The element contains a sequence of the following elements:

FareAuthority

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

FareAuthorityText

1:1

xs:string

Textual description or name of Fare authority.

TariffZone

1:*

+TariffZone

Fare zone in area.

5.9. The complex type TariffZoneRefListStructure

TariffZoneRefListStructure

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

The element contains a sequence of the following elements:

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

→‍TariffZoneRef

1:*

→‍TariffZoneRef

Reference to a fare zone.

5.10. The complex type BookingArrangementStructure

BookingArrangementStructure

[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey

The element contains a sequence of the following elements:

BookingAgencyName

0:1

+InternationalText

Name of the booking agency (contractual partner).

BookingUrl

0:1

+WebLink

URL to online booking service.

InfoUrl

0:1

+WebLink

URL to information page.

PhoneNumber

0:1

PhoneNumber

Phone number for booking.

MinimumBookingPeriod

0:1

xs:duration

Minimum duration bookings must be completed before trip starts.

Extension

0:1

xs:anyType

5.11. The complex type BookingArrangementsContainerStructure

BookingArrangementsContainerStructure

Container for multiple booking arrangements.

The element contains a sequence of the following elements:

BookingArrangement

1:*

+BookingArrangement

[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.

Extension

0:1

xs:anyType

5.12. The complex type FareProductRefStructure

FareProductRefStructure

FareProductCode

Reference to a FareProduct.

5.13. The toplevel element FareProductRef

FareProductRef

+FareProductRef

Reference to a FareProduct.

5.14. The complex type EntitlementProductRefStructure

EntitlementProductRefStructure

EntitlementProductCode

Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

5.15. The toplevel element EntitlementProductRef

EntitlementProductRef

+EntitlementProductRef

Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

5.16. The complex type FareProductStructure

- - - - - - - + + +

FareProductStructure

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

The element contains a sequence of the following elements:

FareProductId

1:1

FareProductCode

Unique Id of the FareProduct.

FareProductName

1:1

xs:string

printable FareProduct name

FareAuthority

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

FareAuthorityText

1:1

xs:string

Textual description or name of Fare authority.

ProtoProduct

0:1

xs:boolean

Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/

FareProductPrice

Price

0:1

xs:decimal

FareProduct price as decimal number.

NetPrice

0:1

xs:decimal

Net FareProduct price as decimal number for accounting purposes.

Currency

0:1

xs:NMTOKEN

iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

VatRate

0:1

VatRate

Rate of value added tax. Default is unknown.

The element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

4.2. The complex type StopFareRequestStructure

StopFareRequestStructure

Sub-request: stop-related fare information.

The element contains a sequence of the following elements:

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

Date

0:1

xs:date

Date for which to retrieve Fare information.

4.3. The complex type StaticFareRequestStructure

StaticFareRequestStructure

General Fare information. May depend on date.

The element contains a sequence of the following elements:

Date

0:1

xs:date

Date for which to retrieve Fare information.

→‍FareProductRef

0:*

→‍FareProductRef

Reference to a FareProduct.

4.4. The complex type TripFareRequestStructure

TripFareRequestStructure

Structure of a Single Trip Fare Request.

The element contains only one element:

Trip

1:1

+Trip

A complete trip from origin to destination

4.5. The complex type MultiTripFareRequestStructure

MultiTripFareRequestStructure

Structure of a Multi Trip Fare Request.

The element contains only one element:

Trip

1:*

+Trip

Multiple complete trips from multiple origins and multiple destination

4.6. The FareResponseGroup group

+ + +

FareResponseGroup

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 a traveller card (f.e. BahnCard50, BahnCard50First etc.).

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.

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

VatRateEnumeration

no | full | half | mixed | unknown

Enumeration of Value Added Tax rates.

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

+ + +

TariffZoneListInAreaStructure

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

The element contains a sequence of the following elements:

FareAuthority

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

FareAuthorityText

1:1

xs:string

Textual description or name of Fare authority.

TariffZone

1:*

+TariffZone

Fare zone in area.

5.9. The complex type TariffZoneRefListStructure

TariffZoneRefListStructure

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

The element contains a sequence of the following elements:

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

→‍TariffZoneRef

1:*

→‍TariffZoneRef

Reference to a fare zone.

5.10. The complex type BookingArrangementStructure

BookingArrangementStructure

[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey

The element contains a sequence of the following elements:

BookingAgencyName

0:1

+InternationalText

Name of the booking agency (contractual partner).

BookingUrl

0:1

+WebLink

URL to online booking service.

InfoUrl

0:1

+WebLink

URL to information page.

PhoneNumber

0:1

PhoneNumber

Phone number for booking.

MinimumBookingPeriod

0:1

xs:duration

Minimum duration bookings must be completed before trip starts.

Extension

0:1

xs:anyType

5.11. The complex type BookingArrangementsContainerStructure

BookingArrangementsContainerStructure

Container for multiple booking arrangements.

The element contains a sequence of the following elements:

BookingArrangement

1:*

+BookingArrangement

[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.

Extension

0:1

xs:anyType

5.12. The complex type FareProductRefStructure

FareProductRefStructure

FareProductCode

Reference to a FareProduct.

5.13. The toplevel element FareProductRef

FareProductRef

+FareProductRef

Reference to a FareProduct.

5.14. The complex type EntitlementProductRefStructure

EntitlementProductRefStructure

EntitlementProductCode

Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

5.15. The toplevel element EntitlementProductRef

EntitlementProductRef

+EntitlementProductRef

Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

5.16. The complex type FareProductStructure

+ + + + + + + - - - - - - - + + + + + + + - - - -

FareProductStructure

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

The element contains a sequence of the following elements:

FareProductId

1:1

FareProductCode

Unique Id of the FareProduct.

FareProductName

1:1

xs:string

printable FareProduct name

FareAuthority

→‍FareAuthorityRef

1:1

→‍FareAuthorityRef

Reference to a Fare Authority.

FareAuthorityText

1:1

xs:string

Textual description or name of Fare authority.

ProtoProduct

0:1

xs:boolean

Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/

FareProductPrice

Price

0:1

xs:decimal

FareProduct price as decimal number.

NetPrice

0:1

xs:decimal

Net FareProduct price as decimal number for accounting purposes.

Currency

0:1

xs:NMTOKEN

iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

VatRate

0:1

VatRate

Rate of value added tax. Default is unknown.

FareProductValidity

TravelClass

0:1

TypeOfFareClass

Travel class for which the FareProduct is valid.

RequiredCard

0:*

+EntitlementProductRef

One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

ValidFor

0:*

PassengerCategory

Sequence of all passenger categories for which this FareProduct is valid.

ValidityDuration

0:1

xs:duration

Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

ValidityDurationText

0:1

+InternationalText

Textual description of maximum validity duration.

ValidityTariffZones

0:*

+TariffZoneListInArea

Spatial validity of FareProduct defined as list of fare zones.

ValidityAreaText

0:1

+InternationalText

Textual description of spatial validity.

FareProductValidity

TravelClass

0:1

TypeOfFareClass

Travel class for which the FareProduct is valid.

RequiredCard

0:*

+EntitlementProductRef

One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

ValidFor

0:*

PassengerCategory

Sequence of all passenger categories for which this FareProduct is valid.

ValidityDuration

0:1

xs:duration

Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

ValidityDurationText

0:1

+InternationalText

Textual description of maximum validity duration.

ValidityTariffZones

0:*

+TariffZoneListInArea

Spatial validity of FareProduct defined as list of fare zones.

ValidityAreaText

0:1

+InternationalText

Textual description of spatial validity.

FareProductBooking

InfoUrl

0:*

+WebLink

URL to information for this FareProduct

SaleUrl

0:*

+WebLink

URL to buy the FareProduct online

BookingArrangements

0:*

+BookingArrangementsContainer

Extension

0:1

xs:anyType

5.17. The FareProductPriceGroup group

- - - - + + + +

FareProductPriceGroup

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

FareProductPrice

Price

0:1

xs:decimal

FareProduct price as decimal number.

NetPrice

0:1

xs:decimal

Net FareProduct price as decimal number for accounting purposes.

Currency

0:1

xs:NMTOKEN

iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

VatRate

0:1

VatRate

Rate of value added tax. Default is unknown.

FareProductBooking

InfoUrl

0:*

+WebLink

URL to information for this FareProduct

SaleUrl

0:*

+WebLink

URL to buy the FareProduct online

BookingArrangements

0:*

+BookingArrangementsContainer

Extension

0:1

xs:anyType

5.17. The FareProductPriceGroup group

+ + + +

FareProductPriceGroup

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

FareProductPrice

Price

0:1

xs:decimal

FareProduct price as decimal number.

NetPrice

0:1

xs:decimal

Net FareProduct price as decimal number for accounting purposes.

Currency

0:1

xs:NMTOKEN

iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

VatRate

0:1

VatRate

Rate of value added tax. Default is unknown.

5.18. The FareProductValidityGroup group

- - - - - - - + + + + + + +

FareProductValidityGroup

conditions of use for a particular FARE PRODUCT.

FareProductValidity

TravelClass

0:1

TypeOfFareClass

Travel class for which the FareProduct is valid.

RequiredCard

0:*

+EntitlementProductRef

One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

ValidFor

0:*

PassengerCategory

Sequence of all passenger categories for which this FareProduct is valid.

ValidityDuration

0:1

xs:duration

Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

ValidityDurationText

0:1

+InternationalText

Textual description of maximum validity duration.

ValidityTariffZones

0:*

+TariffZoneListInArea

Spatial validity of FareProduct defined as list of fare zones.

ValidityAreaText

0:1

+InternationalText

Textual description of spatial validity.

FareProductValidity

TravelClass

0:1

TypeOfFareClass

Travel class for which the FareProduct is valid.

RequiredCard

0:*

+EntitlementProductRef

One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

ValidFor

0:*

PassengerCategory

Sequence of all passenger categories for which this FareProduct is valid.

ValidityDuration

0:1

xs:duration

Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

ValidityDurationText

0:1

+InternationalText

Textual description of maximum validity duration.

ValidityTariffZones

0:*

+TariffZoneListInArea

Spatial validity of FareProduct defined as list of fare zones.

ValidityAreaText

0:1

+InternationalText

Textual description of spatial validity.

5.19. The FareProductBookingGroup group

- - - + + +

FareProductBookingGroup

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

FareProductBooking

InfoUrl

0:*

+WebLink

URL to information for this FareProduct

SaleUrl

0:*

+WebLink

URL to buy the FareProduct online

BookingArrangements

0:*

+BookingArrangementsContainer

FareProductBooking

InfoUrl

0:*

+WebLink

URL to information for this FareProduct

SaleUrl

0:*

+WebLink

URL to buy the FareProduct online

BookingArrangements

0:*

+BookingArrangementsContainer

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

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

EntitlementProduct

0:*

+EntitlementProductRef

[a specific form of TRAVEL DOCUMENT in TM and NeTEx] a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc)

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

- - - + + +

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

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

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

EntitlementProduct

0:*

+EntitlementProductRef

[a specific form of TRAVEL DOCUMENT in TM and NeTEx] a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc)

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

+ + +

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

5.24. The complex type FareParamStructure

- - - -

FareParamStructure

[related to the FARE parameter model in TM and NeTEx] parameters which are used to determine the price to be paid for a FARE PRODUCT by a specific passenger.

The element contains a sequence of the following elements:

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.

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

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

- - - - - -

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.

NameSuffix

0:1

+InternationalText

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

DisplayPriority

0:1

Priority

Priority of this via point to be displayed when space is limited.

6.3. The complex type ProductCategoryStructure

ProductCategoryStructure

Product category based on NeTEx/SIRI. A product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products.

The element contains a sequence of the following elements:

Name

0:1

+InternationalText

Full name of this product category, e.g. "Autoreisezug" in Switzerland or "Dampfschiff"

ShortName

0:1

+InternationalText

Short name or acronym of the product category, likely to be published, e.g. "BAV", "ARZ", "TGV". The product category is more important for publication in Switzerland than Mode / Submode.

→‍ProductCategoryRef

0:1

→‍ProductCategoryRef

A reference to the product category. This is the internal code used within the reference frameworks (NeTEx, SIRI). It is usually not displayed, but interpreted by the technical system, e.g. "ch:1:TypeOfProductCategory:ARZ" (Autoreisezug in Switzerland) or "ch:1:TypeOfProductCategory:BAV".

6.4. The complex type TripViaStructure

TripViaStructure

VIA restrictions for a TRIP.

The element contains a sequence of the following elements:

ViaPoint

1:1

+PlaceRef

Reference to specify the via place.

DwellTime

0:1

xs:duration

Duration the passenger wants to stay at the via place. Default is 0.

6.5. The ScheduledJourneyGroup group

- + + + + + +

ScheduledJourneyGroup

Vehicle journey (not dated).

ScheduledJourney

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

DisplayPriority

0:1

Priority

Priority of this via point to be displayed when space is limited.

6.3. The complex type ProductCategoryStructure

ProductCategoryStructure

Product category based on NeTEx/SIRI. A product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products.

The element contains a sequence of the following elements:

Name

0:1

+InternationalText

Full name of this product category, e.g. "Autoreisezug" in Switzerland or "Dampfschiff"

ShortName

0:1

+InternationalText

Short name or acronym of the product category, likely to be published, e.g. "BAV", "ARZ", "TGV". The product category is more important for publication in Switzerland than Mode / Submode.

→‍ProductCategoryRef

0:1

→‍ProductCategoryRef

A reference to the product category. This is the internal code used within the reference frameworks (NeTEx, SIRI). It is usually not displayed, but interpreted by the technical system, e.g. "ch:1:TypeOfProductCategory:ARZ" (Autoreisezug in Switzerland) or "ch:1:TypeOfProductCategory:BAV".

6.4. The complex type TripViaStructure

TripViaStructure

VIA restrictions for a TRIP.

The element contains a sequence of the following elements:

ViaPoint

1:1

+PlaceRef

Reference to specify the via place.

DwellTime

0:1

xs:duration

Duration the passenger wants to stay at the via place. Default is 0.

6.5. The ScheduledJourneyGroup group

+ - - - - - - - - - + + + + + + + + +

ScheduledJourneyGroup

Vehicle journey (not dated).

ScheduledJourney

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineDirectionGroup

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes +will use TrainNumber.

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

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

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

6.6. The ServiceGroup group

- - - - - - - - - + + + + + + + + +

ServiceGroup

Properties of a service (line and direction): attributes of Continuous Journey Structure or Dated Journey Structure.

→‍siri:LineDirectionGroup

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes +will use TrainNumber.

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

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

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

6.7. The ServiceOriginGroup group

- - + +

ServiceOriginGroup

First serviced stop of a vehicle journey.

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

6.8. The ServiceDestinationGroup group

- - + +

ServiceDestinationGroup

Last serviced stop of a vehicle journey.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

6.9. The RouteDescriptionGroup group

- +

RouteDescriptionGroup

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

RouteDescription

RouteDescriptionText

1:1

+InternationalText

RouteDescription

RouteDescriptionText

1:1

+InternationalText

6.10. The DatedJourneyGroup group

- - + + - + - - - - - - - - - + + + + + + + + +

DatedJourneyGroup

Vehicle journey that runs at a specific date.

DatedJourney

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

DatedJourney

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

ScheduledJourney

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

ScheduledJourney

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineDirectionGroup

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes +will use TrainNumber.

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

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

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

RouteDescription

0:1

+InternationalText

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

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

6.11. The PrivateServiceGroup group

- - - - + + + +

PrivateServiceGroup

specific service operated by a Private Mode

PrivateService

→‍JourneyRef

0:1

→‍JourneyRef

Reference to a Journey

PrivateMode

1:1

PrivateModes

[a category of MODE in TMv6] MODEs offered by private individuals

OrganisationRef

0:1

siri:OperatorRefStructure

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

PrivateService

→‍JourneyRef

0:1

→‍JourneyRef

Reference to a Journey

PrivateMode

1:1

PrivateModes

[a category of MODE in TMv6] MODEs offered by private individuals

OrganisationRef

0:1

siri:OperatorRefStructure

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

6.12. The complex type DatedJourneyStructure

- - + + - + - - - - - - - - - + + + + + + + + + - - - - + + + + - - + + - - + + - - - - -

DatedJourneyStructure

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

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

DatedJourney

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

DatedJourney

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

ScheduledJourney

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

ScheduledJourney

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineDirectionGroup

Service

a

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

a

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

a

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

a

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

a

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

a

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

a

RouteDescription

0:1

+InternationalText

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

a

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

a

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

a

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

a

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

a

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

a

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes +will use TrainNumber.

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

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

a

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

a

RouteDescription

0:1

+InternationalText

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

a

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

a

Attribute

0:*

+GeneralAttribute

Note or service attribute.

PrivateService

b

→‍JourneyRef

0:1

→‍JourneyRef

Reference to a Journey

b

PrivateMode

1:1

PrivateModes

[a category of MODE in TMv6] MODEs offered by private individuals

b

OrganisationRef

0:1

siri:OperatorRefStructure

b

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

PrivateService

b

→‍JourneyRef

0:1

→‍JourneyRef

Reference to a Journey

b

PrivateMode

1:1

PrivateModes

[a category of MODE in TMv6] MODEs offered by private individuals

b

OrganisationRef

0:1

siri:OperatorRefStructure

b

InfoUrl

0:1

+WebLink

Link to web page providing more details on service.

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

ServiceStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Occupancy

0:1

siri:OccupancyEnumeration

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

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

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

6.13. The complex type TripPlaceStructure

TripPlaceStructure

A trip place represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip place does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat.

The element contains a sequence of the following elements:

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineIdentityGroup

6.14. The TimeWindowGroup group

- - + + + + +

TimeWindowGroup

The window of opportunity that the traveller has to perform this leg of the journey.

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

ServiceStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Occupancy

0:1

siri:OccupancyEnumeration

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

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

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

6.13. The complex type TripPlaceStructure

TripPlaceStructure

A trip place represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip place does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat.

The element contains a sequence of the following elements:

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineIdentityGroup

6.14. The TimeWindowGroup group

+ +

TimeWindowGroup

The window of opportunity that the traveller has to perform this leg of the journey.

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

6.15. The ServiceTimeGroup group

- - - + + + - - + +

ServiceTimeGroup

Contains at least scheduled time, but can contain real time and estimated times

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

6.16. The EstimatedTimeBandGroup group

- - + +

EstimatedTimeBandGroup

Range for estimated time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

6.17. The complex type ServiceArrivalStructure

- - - + + + - - + +

ServiceArrivalStructure

Arrival times of a service at a stop (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

The element contains only one element:

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

6.18. The complex type ServiceDepartureStructure

- - - + + + - - + +

ServiceDepartureStructure

Departure times of a service at a stop (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

The element contains only one element:

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

ServiceTime

TimetabledTime

1:1

xs:dateTime

time at point as it is published

RecordedAtTime

0:1

xs:dateTime

time as it was recorded

EstimatedTime

0:1

xs:dateTime

estimated time (for prognosis)

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

EstimatedTimeBand

EstimatedTimeLow

0:1

xs:dateTime

Estimated lower limit for time.

EstimatedTimeHigh

0:1

xs:dateTime

Estimated upper limit for time.

6.19. The complex type CallAtStopStructure

- - - - - - - - - - - - -

CallAtStopStructure

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

The element contains a sequence of the following elements:

StopPoint

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

StopPointName

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

0:1

+ServiceArrival

Arrival times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

ServiceDeparture

0:1

+ServiceDeparture

Departure times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

6.20. The StopCallStatusGroup group

- - - - - - + + + + + + + + + + + + +

StopCallStatusGroup

Status properties for the vehicle call at this stop.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

0:1

+ServiceArrival

Arrival times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

ServiceDeparture

0:1

+ServiceDeparture

Departure times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME).

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

6.20. The StopCallStatusGroup group

+ + + + + +

StopCallStatusGroup

Status properties for the vehicle call at this stop.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

6.21. The ServiceStatusGroup group

- - - - -

ServiceStatusGroup

parameters which describe the current status of a DATED VEHICLE JOURNEY

ServiceStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Occupancy

0:1

siri:OccupancyEnumeration

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

6.22. The complex type ContinuousServiceStructure

- - + + + + +

ContinuousServiceStructure

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

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

ContinuousMode

-1:1

ContinuousModes

Continuous transport options.

b

IndividualMode

-1:1

IndividualModes

Individual transport options.

Then, the element contains one of the following elements:

DatedJourney

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

ServiceStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Occupancy

0:1

siri:OccupancyEnumeration

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

6.22. The complex type ContinuousServiceStructure

+ + - + - - - - - - - - - + + + + + + + + + - - - + + + - - -

ContinuousServiceStructure

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

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

ContinuousMode

-1:1

ContinuousModes

Continuous transport options.

b

IndividualMode

-1:1

IndividualModes

Individual transport options.

Then, the element contains one of the following elements:

DatedJourney

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

ScheduledJourney

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

ScheduledJourney

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

→‍siri:LineDirectionGroup

Service

a

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

a

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

a

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

a

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one.

a

VehicleNumber

0:1

xs:normalizedString

Contains the VehicleNumber of the vehicle. If several number types exist, use the commercial number. In Transmodel this may be VEHICLE.Id or VEHICLE.VehicleRegistrationNumber.

a

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

a

RouteDescription

0:1

+InternationalText

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

a

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

a

Attribute

0:*

+GeneralAttribute

Note or service attribute.

Service

a

Mode

1:1

+Mode

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

a

ProductCategory

0:1

+ProductCategory

A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

a

PublishedServiceName

1:1

+InternationalText

Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

a

TrainNumber

0:1

xs:normalizedString

Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes +will use TrainNumber.

a

→‍siri:VehicleRef

0:1

→‍siri:VehicleRef

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

a

→‍OperatorRef

0:1

→‍OperatorRef

Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

a

RouteDescription

0:1

+InternationalText

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

a

Via

0:*

+ServiceViaPoint

Via points of the service that may help identify the vehicle to the public.

a

Attribute

0:*

+GeneralAttribute

Note or service attribute.

b

SharingService

-0:1

+SharingService

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

b

SharingService

-0:1

+SharingService

ServiceOrigin

OriginStopPointRef

0:1

siri:StopPointRefStructure

First stop of the vehicle journey; origin stop point.

OriginText

1:1

+InternationalText

Label for first stop.

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

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

6.23. The complex type VehiclePositionStructure

VehiclePositionStructure

Geographical and logical position of a vehicle.

The element contains a sequence of the following elements:

GeoPosition

0:1

siri:LocationStructure

Geographic position of vehicle.

Progress

0:1

VehicleProgress

Logical progress of vehicle relative to service pattern.

Bearing

0:1

siri:AbsoluteBearingType

Bearing in compass degrees in which vehicle is heading.

ProgressBetweenStops

0:1

siri:ProgressBetweenStopsStructure

Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position.

6.24. The complex type PlaceContextStructure

PlaceContextStructure

[a view of PLACE in TMv6] a PLACE and access to it by individual transport

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

PlaceRef

-1:1

+PlaceRef

Static place.

b

TripPlace

-1:1

+TripPlace

Place within a (moving) vehicle.

Then, the element contains one of the following elements:

a

DepArrTime

-0:1

xs:dateTime

Time when departure/arrival from/to place is required.

b

TimeAllowance

-0:1

xs:duration

Extra time needed before reaching/after leaving this place.

IndividualTransportOptions

0:*

+IndividualTransportOptions

Options how to access/leave the place by individual transport.

6.25. The NumberOfResultsGroup group

- - + + +

NumberOfResultsGroup

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

NumberOfResults

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

ServiceDestination

DestinationStopPointRef

0:1

siri:StopPointRefStructure

Last stop of vehicle journey; destination stop point.

DestinationText

1:1

+InternationalText

Label for last stop.

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

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

6.23. The complex type VehiclePositionStructure

VehiclePositionStructure

Geographical and logical position of a vehicle.

The element contains a sequence of the following elements:

GeoPosition

0:1

siri:LocationStructure

Geographic position of vehicle.

Progress

0:1

VehicleProgress

Logical progress of vehicle relative to service pattern.

Bearing

0:1

siri:AbsoluteBearingType

Bearing in compass degrees in which vehicle is heading.

ProgressBetweenStops

0:1

siri:ProgressBetweenStopsStructure

Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position.

6.24. The complex type PlaceContextStructure

PlaceContextStructure

[a view of PLACE in TMv6] a PLACE and access to it by individual transport

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

PlaceRef

-1:1

+PlaceRef

Static place.

b

TripPlace

-1:1

+TripPlace

Place within a (moving) vehicle.

Then, the element contains one of the following elements:

a

DepArrTime

-0:1

xs:dateTime

Time when departure/arrival from/to place is required.

b

TimeAllowance

-0:1

xs:duration

Extra time needed before reaching/after leaving this place.

IndividualTransportOptions

0:*

+IndividualTransportOptions

Options how to access/leave the place by individual transport.

6.25. The NumberOfResultsGroup group

+ +

NumberOfResultsGroup

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

NumberOfResults

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

6.26. The BaseTripPolicyGroup group

- - - - - + + + + +

BaseTripPolicyGroup

Policies that control the trip search behaviour for both public and individual transport.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

6.27. The BaseTripMobilityFilterGroup group

- - - - - - + + + + + +

BaseTripMobilityFilterGroup

Base mobility options to be applied for both public and individual transport.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

6.28. The BaseTripContentFilterGroup group

- - - - - - -

BaseTripContentFilterGroup

Parameters to control the level of detail of both public and individual transport journey results.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

6.29. The complex type LegAttributeStructure

- - - -

LegAttributeStructure

+GeneralAttribute

Attributes that are not valid on the whole service, but only on section of a TRIP made on a single MODE without interchange between boarding and alighting (facilities available on a specified (part of a) Leg of a VEHICLE JOURNEY)

The element contains a sequence of the following elements:

FromStopSeqNumber

0:1

xs:positiveInteger

The attribute is valid from the stop point with this sequence number within the leg. If missing it is valid from the beginning of the leg.

ToStopSeqNumber

0:1

xs:positiveInteger

The attribute is valid to the stop point (inclusively) with this sequence number within the leg. If missing it is valid to the end of the leg.

6.30. The complex type LegTrackStructure

LegTrackStructure

The LINK PROJECTION of a Leg onto the topography of the route being followed.

The element contains only one element:

TrackSection

1:*

+TrackSection

LINK PROJECTION on the infrastructure network of the trip leg section together with time information.

6.31. The complex type TrackSectionStructure

TrackSectionStructure

LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

The element contains a sequence of the following elements:

TrackStart

0:1

+PlaceRef

Start place of this track.

TrackEnd

0:1

+PlaceRef

End place of this track.

LinkProjection

0:1

+LinkProjection

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

RoadName

0:1

xs:string

Name of the road this track section is attached to.

Duration

0:1

xs:duration

Duration the passenger needs to travel through this track section.

Length

0:1

siri:DistanceType

Length of this track section.

Extension

0:1

xs:anyType

-

7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport

7.1. Simple type definitions

ContinuousModesEnumeration

walk | demandResponsive | replacementService

Types of cmodes that run at any time without a timetable.

IndividualModesEnumeration

walk | cycle | taxi | self-drive-car | others-drive-car | motorcycle | truck | scooter | ride-pool-car | car-sharing | cycle-sharing | scooter-sharing

modes which an individual powers themselves (such as walk, cycle)

PrivateModesEnumeration

carPooling

[a category of MODE in TMv6] MODEs offered by private individuals

TransferModesEnumeration

walk | parkAndRide | bikeAndRide | carHire | bikeHire | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut

MODEs dedicated to peform TRANSFERs

7.2. The complex type IndividualTransportOptionsStructure

IndividualTransportOptionsStructure

Individual modes and their usage limits as stated by the passenger

The element contains a sequence of the following elements:

Mode

1:1

IndividualModes

Mode of individual transport. When mode self-drive-car is used the connection to another mode will need a parking space for the car. Thus, this mode is a generalisation of all park and ride use cases. The mode others-drive-car, however, only needs a place to let a person be set down from a car.

MaxDistance

0:1

siri:DistanceType

Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode.

MaxDuration

0:1

xs:duration

Maximum duration. If given, it restricts the maximum time of routes with the given mode.

MinDistance

0:1

siri:DistanceType

Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode.

MinDuration

0:1

xs:duration

Minimum duration. If given, it restricts the minimum time of routes with the given mode.

Speed

0:1

OpenPercent

Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100).

AdditionalTime

0:1

xs:duration

Additional time added to the actual traveling time needed to use a specific mode.

7.3. The complex type ModeStructure

- + + + + + + +

ModeStructure

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

The element contains a sequence of the following elements:

Mode

PtMode

1:1

siri:VehicleModesOfTransportEnumeration

Categorisation of mode

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

6.29. The complex type LegAttributeStructure

+ + + +

LegAttributeStructure

+GeneralAttribute

Attributes that are not valid on the whole service, but only on section of a TRIP made on a single MODE without interchange between boarding and alighting (facilities available on a specified (part of a) Leg of a VEHICLE JOURNEY)

The element contains a sequence of the following elements:

FromStopSeqNumber

0:1

xs:positiveInteger

The attribute is valid from the stop point with this sequence number within the leg. If missing it is valid from the beginning of the leg.

ToStopSeqNumber

0:1

xs:positiveInteger

The attribute is valid to the stop point (inclusively) with this sequence number within the leg. If missing it is valid to the end of the leg.

6.30. The complex type LegTrackStructure

LegTrackStructure

The LINK PROJECTION of a Leg onto the topography of the route being followed.

The element contains only one element:

TrackSection

1:*

+TrackSection

LINK PROJECTION on the infrastructure network of the trip leg section together with time information.

6.31. The complex type TrackSectionStructure

TrackSectionStructure

LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

The element contains a sequence of the following elements:

TrackStart

0:1

+PlaceRef

Start place of this track.

TrackEnd

0:1

+PlaceRef

End place of this track.

LinkProjection

0:1

+LinkProjection

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

RoadName

0:1

xs:string

Name of the road this track section is attached to.

Duration

0:1

xs:duration

Duration the passenger needs to travel through this track section.

Length

0:1

siri:DistanceType

Length of this track section.

Extension

0:1

xs:anyType

+

7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport

7.1. Simple type definitions

ContinuousModesEnumeration

walk | demandResponsive | replacementService

Types of cmodes that run at any time without a timetable.

IndividualModesEnumeration

walk | cycle | taxi | self-drive-car | others-drive-car | motorcycle | truck | scooter | ride-pool-car | car-sharing | cycle-sharing | scooter-sharing

modes which an individual powers themselves (such as walk, cycle)

PrivateModesEnumeration

carPooling

[a category of MODE in TMv6] MODEs offered by private individuals

TransferModesEnumeration

walk | parkAndRide | bikeAndRide | carHire | bikeHire | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut

MODEs dedicated to peform TRANSFERs

7.2. The complex type IndividualTransportOptionsStructure

IndividualTransportOptionsStructure

Individual modes and their usage limits as stated by the passenger

The element contains a sequence of the following elements:

Mode

1:1

IndividualModes

Mode of individual transport. When mode self-drive-car is used the connection to another mode will need a parking space for the car. Thus, this mode is a generalisation of all park and ride use cases. The mode others-drive-car, however, only needs a place to let a person be set down from a car.

MaxDistance

0:1

siri:DistanceType

Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode.

MaxDuration

0:1

xs:duration

Maximum duration. If given, it restricts the maximum time of routes with the given mode.

MinDistance

0:1

siri:DistanceType

Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode.

MinDuration

0:1

xs:duration

Minimum duration. If given, it restricts the minimum time of routes with the given mode.

Speed

0:1

OpenPercent

Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100).

AdditionalTime

0:1

xs:duration

Additional time added to the actual traveling time needed to use a specific mode.

7.3. The complex type ModeStructure

+ -

ModeStructure

[a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

The element contains a sequence of the following elements:

Mode

PtMode

1:1

siri:VehicleModesOfTransportEnumeration

Categorisation of mode

→‍siri:PtModeChoiceGroup

Name

0:1

+InternationalText

Name of the mode.

ShortName

0:1

+InternationalText

Short name or acronym of the mode.

Description

0:1

+InternationalText

Additional text that further describes the mode.

7.4. The ModeGroup group

- +

ModeGroup

Elements for a Transport Mode

Mode

PtMode

1:1

siri:VehicleModesOfTransportEnumeration

Categorisation of mode

Name

0:1

+InternationalText

Name of the mode.

ShortName

0:1

+InternationalText

Short name or acronym of the mode.

Description

0:1

+InternationalText

Additional text that further describes the mode.

7.4. The ModeGroup group

+ -

ModeGroup

Elements for a Transport Mode

Mode

PtMode

1:1

siri:VehicleModesOfTransportEnumeration

Categorisation of mode

→‍siri:PtModeChoiceGroup

7.5. The complex type PtModeFilterStructure

PtModeFilterStructure

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

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PtMode

0:*

siri:VehicleModesOfTransportEnumeration

List of PT Transport modes to include/exclude.

→‍siri:PtModeChoiceGroup

7.6. The complex type PrivateModeFilterStructure

PrivateModeFilterStructure

List of private mobility offers to include or exclude.

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PrivateMode

0:*

PrivateModes

List of private mobility offers to include/exclude.

-

8. OJP/OJP_Places.xsd - Request and response definitions for place information

8.1. Simple type definitions

PlaceTypeEnumeration

stop | address | poi | coord | topographicPlace

PlaceUsageEnumeration

origin | via | destination

8.2. The PlaceInformationRequestGroup group

- - +

PlaceInformationRequestGroup

The element contains one of the following elements:

PlaceInformationRequest

a

InitialInput

-1:1

+InitialPlaceInput

Initial input for the place information request. This input defines what is originally looked for.

b

PlaceRef

-1:1

+PlaceRef

Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.

Restrictions

0:1

+PlaceParam

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

7.5. The complex type PtModeFilterStructure

PtModeFilterStructure

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

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PtMode

0:*

siri:VehicleModesOfTransportEnumeration

List of PT Transport modes to include/exclude.

→‍siri:PtModeChoiceGroup

7.6. The complex type PrivateModeFilterStructure

PrivateModeFilterStructure

List of private mobility offers to include or exclude.

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PrivateMode

0:*

PrivateModes

List of private mobility offers to include/exclude.

+

8. OJP/OJP_Places.xsd - Request and response definitions for place information

8.1. Simple type definitions

PlaceTypeEnumeration

stop | address | poi | coord | location | topographicPlace

PlaceUsageEnumeration

origin | via | destination

8.2. The PlaceInformationRequestGroup group

+ +

PlaceInformationRequestGroup

The element contains one of the following elements:

PlaceInformationRequest

a

InitialInput

-1:1

+InitialPlaceInput

Initial input for the place information request. This input defines what is originally looked for.

b

PlaceRef

-1:1

+PlaceRef

Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.

Restrictions

0:1

+PlaceParam

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

8.3. The PlaceInformationResponseGroup group

- - - -

PlaceInformationResponseGroup

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.

PlaceResult

0:*

+PlaceResult

8.4. The complex type InitialPlaceInputStructure

InitialPlaceInputStructure

The element contains a sequence of the following elements:

Name

0:1

xs:string

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

GeoPosition

0:1

siri:LocationStructure

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

GeoRestriction

0:1

+GeoRestrictions

Restricts the resulting place objects to the given geographical area.

AllowedSystemId

0:*

xs:normalizedString

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

8.5. The complex type PlaceParamStructure

- - - - - - + + + +

PlaceParamStructure

The element contains a sequence of the following elements:

PlaceDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

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

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

PointOfInterestFilter

0:1

+PointOfInterestFilter

Filter to narrow down POI searches.

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.

PlaceResult

0:*

+PlaceResult

8.4. The complex type InitialPlaceInputStructure

InitialPlaceInputStructure

The element contains a sequence of the following elements:

Name

0:1

xs:string

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

GeoPosition

0:1

siri:LocationStructure

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

GeoRestriction

0:1

+GeoRestrictions

Restricts the resulting place objects to the given geographical area.

AllowedSystemId

0:*

xs:normalizedString

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

8.5. The complex type PlaceParamStructure

+ + + + + + - - - - -

PlaceParamStructure

The element contains a sequence of the following elements:

PlaceDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

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

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

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.

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.

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.

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.

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.

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.

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.

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

- - - - - - + + + + + +

PlaceDataFilterGroup

PlaceDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

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

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

PointOfInterestFilter

0:1

+PointOfInterestFilter

Filter to narrow down POI searches.

PlaceDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

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

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

PointOfInterestFilter

0:1

+PointOfInterestFilter

Filter to narrow down POI searches.

8.13. The ExchangePointsRequestGroup group

- - + +

ExchangePointsRequestGroup

ExchangePointsRequest

PlaceRef

0:1

+PlaceRef

Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

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

ExchangePointsRequest

PlaceRef

0:1

+PlaceRef

Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

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

8.14. The complex type ExchangePointsParamStructure

- - - - - - - + + + + + + + - - - + + +

ExchangePointsParamStructure

The element contains a sequence of the following elements:

ExchangePointsDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

DestinationSystem

0:1

siri:ParticipantRefStructure

Reference to system in which the destination (or origin) of the passenger is located.

AdjacentSystem

0:*

siri:ParticipantRefStructure

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

ExchangePointsDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

DestinationSystem

0:1

siri:ParticipantRefStructure

Reference to system in which the destination (or origin) of the passenger is located.

AdjacentSystem

0:*

siri:ParticipantRefStructure

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

ExchangePointsPolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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.

ExchangePointsPolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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.

8.15. The ExchangePointsDataFilterGroup group

- - - - - - - + + + + + + +

ExchangePointsDataFilterGroup

ExchangePointsDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

DestinationSystem

0:1

siri:ParticipantRefStructure

Reference to system in which the destination (or origin) of the passenger is located.

AdjacentSystem

0:*

siri:ParticipantRefStructure

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

ExchangePointsDataFilter

Type

0:*

PlaceType

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

Usage

0:1

PlaceUsage

Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.

PtModes

0:1

+PtModeFilter

Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.

OperatorFilter

0:1

+OperatorFilter

Filter for places that are operated by certain organisations.

TopographicPlaceRef

0:*

+TopographicPlaceRef

If at least one is set, only place objects within the given localities are allowed.

DestinationSystem

0:1

siri:ParticipantRefStructure

Reference to system in which the destination (or origin) of the passenger is located.

AdjacentSystem

0:*

siri:ParticipantRefStructure

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

8.16. The ExchangePointsPolicyGroup group

- - - + + +

ExchangePointsPolicyGroup

ExchangePointsPolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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.

ExchangePointsPolicy

Language

0:*

xs:language

Preferred language in which to return text values.

NumberOfResults

0:1

xs:positiveInteger

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.

8.17. The ExchangePointsResponseGroup group

- - - -

ExchangePointsResponseGroup

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.

+ 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

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

9.3. The complex type StopPointStructure

- - - - - - - - - -

StopPointStructure

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

The element contains a sequence of the following elements:

StopPoint

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

StopPointName

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

PrivateCode

0:*

+PrivateCode

Code of this stop point in private/foreign/proprietary coding schemes.

ParentRef

0:1

+StopPlaceRef

Reference to the stop place to which this stop point belongs.

→‍TopographicPlaceRef

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

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.4. The complex type StopPlaceRefStructure

StopPlaceRefStructure

StopPlaceCode

Reference to a Stop Place

9.5. The toplevel element StopPlaceRef

StopPlaceRef

+StopPlaceRef

Reference to a Stop Place

9.6. The StopPlaceGroup group

- - - + + + + + + + + + +

StopPlaceGroup

A stop place with id and name

StopPlace

→‍StopPlaceRef

1:1

→‍StopPlaceRef

Reference to a Stop Place

StopPlaceName

1:1

+InternationalText

Name of this stop place for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center".

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

PrivateCode

0:*

+PrivateCode

Code of this stop point in private/foreign/proprietary coding schemes.

ParentRef

0:1

+StopPlaceRef

Reference to the stop place to which this stop point belongs.

→‍TopographicPlaceRef

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

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.4. The complex type StopPlaceRefStructure

StopPlaceRefStructure

StopPlaceCode

Reference to a Stop Place

9.5. The toplevel element StopPlaceRef

StopPlaceRef

+StopPlaceRef

Reference to a Stop Place

9.6. The StopPlaceGroup group

+ + +

StopPlaceGroup

A stop place with id and name

StopPlace

→‍StopPlaceRef

1:1

→‍StopPlaceRef

Reference to a Stop Place

StopPlaceName

1:1

+InternationalText

Name of this stop place for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center".

9.7. The complex type StopPlaceStructure

- - - - - - - + + + + + + +

StopPlaceStructure

[an extended view of STOP PLACE in TMv6] a PLACE extended by ACCESSIBILITY LIMITATION properties and some attributes of the associated equipment, comprising one or more locations where vehicles may stop and where passengers may board or leave vehicles or prepare their trip, and which will usually have one or more wellknown names

The element contains a sequence of the following elements:

StopPlace

→‍StopPlaceRef

1:1

→‍StopPlaceRef

Reference to a Stop Place

StopPlaceName

1:1

+InternationalText

Name of this stop place for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center".

PrivateCode

0:*

+PrivateCode

Code of this stop place in private/foreign/proprietary coding schemes.

→‍TopographicPlaceRef

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

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

StopPlace

→‍StopPlaceRef

1:1

→‍StopPlaceRef

Reference to a Stop Place

StopPlaceName

1:1

+InternationalText

Name of this stop place for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center".

PrivateCode

0:*

+PrivateCode

Code of this stop place in private/foreign/proprietary coding schemes.

→‍TopographicPlaceRef

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

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.8. The StopAttributesGroup group

- - - -

StopAttributesGroup

[properties of a SCHEDULED STOP POINT or STOP PLACE in TMv6] selection of attributes of ACCESSIBIITY LIMITATION related to a SCHEDULED STOP POINT extended by attributes referring to some equipment.

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.9. The complex type TopographicPlaceRefStructure

TopographicPlaceRefStructure

Reference to a TopographicPlace

9.10. The toplevel element TopographicPlaceRef

TopographicPlaceRef

+TopographicPlaceRef

Reference to a TopographicPlace

9.11. The complex type TopographicPlaceStructure

TopographicPlaceStructure

[TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g. County,City, Town, Village) and of different specificity (e.g. Greater London, London, West End, Westminster, St James's).

The element contains a sequence of the following elements:

TopographicPlaceCode

1:1

TopographicPlace ID.

TopographicPlaceName

1:1

+InternationalText

Name or description of TopographicPlace for use in passenger information.

PrivateCode

0:*

+PrivateCode

Code of this TopographicPlace in private/foreign/proprietary coding schemes.

ParentRef

0:1

+TopographicPlaceRef

Reference to a parent TopographicPlace.

ReferredSystemId

0:1

xs:normalizedString

Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/

Area

0:1

+Area

Area covered by the locality described as a polygon.

9.12. The complex type PointOfInterestRefStructure

PointOfInterestRefStructure

PointOfInterestCode

Reference to a Point of Interest

9.13. The toplevel element PointOfInterestRef

PointOfInterestRef

+PointOfInterestRef

Reference to a Point of Interest

9.14. The complex type PointOfInterestStructure

PointOfInterestStructure

[corresponds to POINT OF INTEREST in TMv6 with related information] type of PLACE to or through which passengers may wish to navigate as part of their journey and which is modelled in detail by journey planners.

The element contains a sequence of the following elements:

PointOfInterestCode

1:1

PointOfInterestCode

ID of this Point of Interest.

PointOfInterestName

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

Additional description of the point of interest that may be appended to the name if enough space is available. F.e. "Exhibition Center".

PointOfInterestCategory

0:*

+PointOfInterestCategory

Categories this POI is associated with. Order indicates descending relevance.

PrivateCode

0:*

+PrivateCode

Code of this point of interest in private/foreign/proprietary coding schemes.

→‍TopographicPlaceRef

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

9.15. The complex type PointOfInterestCategoryStructure

PointOfInterestCategoryStructure

[a view of POINT OF INTEREST CLASSIFICATION in TMv6] categorisation of POINTs OF INTEREST in respect of the activities undertaken at them (defined by key-value-pairs).

The element contains one of the following elements:

a

OsmTag

-1:*

+OsmTag

Open Street Map tag structure (key-value)

b

PointOfInterestClassification

-1:*

xs:string

Classification of the POI (when it is not from OSM). The codification of the classification Id may include de codification source (for example "IGN:[classificationCode]")

9.16. The complex type OsmTagStructure

OsmTagStructure

Structure of an Open Street Map tag.

The element contains a sequence of the following elements:

Tag

1:1

xs:NMTOKEN

Name of Open Street Map tag (amenity, leisure, tourism, bike, ...)

Value

1:1

xs:NMTOKEN

Value for Open Street Map tag (charging_station, hostel, yes, ...)

9.17. The complex type PointOfInterestFilterStructure

PointOfInterestFilterStructure

Filter POIs by category.

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PointOfInterestCategory

0:*

+PointOfInterestCategory

These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE).

9.18. The complex type AddressRefStructure

AddressRefStructure

AddressCode

Reference to an Address

9.19. The toplevel element AddressRef

AddressRef

+AddressRef

Reference to an Address

9.20. The AddressDetailGroup group

- - - - - - - -

AddressDetailGroup

An address with its name entities

AddressDetail

CountryName

0:1

xs:string

Country of the address.

PostCode

0:1

xs:string

Postal code of the address.

TopographicPlaceName

0:1

xs:string

TopographicPlace name of the address. If set it should at least contain the city name.

→‍TopographicPlaceRef

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

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.21. The complex type AddressStructure

- - - - - - - -

AddressStructure

descriptive data associated with a PLACE that can be used to describe the unique geographical context of a PLACE for the purposes of identifying it. May be refined as either a ROAD ADDRESS, a POSTAL ADDRESS or both

The element contains a sequence of the following elements:

AddressCode

1:1

AddressCode

ID of this address.

PrivateCode

0:*

+PrivateCode

Code of this address in private/foreign/proprietary coding schemes.

AddressName

1:1

+InternationalText

Name or description of address for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the address that may be appended to the name if enough space is available. F.e. "Crossing with Peterstraße".

AddressDetail

CountryName

0:1

xs:string

Country of the address.

PostCode

0:1

xs:string

Postal code of the address.

TopographicPlaceName

0:1

xs:string

TopographicPlace name of the address. If set it should at least contain the city name.

→‍TopographicPlaceRef

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

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.

-

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

+ + + +

OJPFareRequestStructure

+AbstractOJPServiceRequest

StopAttributes

WheelchairAccessible

0:1

xs:boolean

Whether this stop is accessible for wheelchair users.

Lighting

0:1

xs:boolean

Whether this stop is lit.

Covered

0:1

xs:boolean

Whether this stop offers protection from weather conditions like rain, snow, storm etc.

9.9. The complex type TopographicPlaceRefStructure

TopographicPlaceRefStructure

Reference to a TopographicPlace

9.10. The toplevel element TopographicPlaceRef

TopographicPlaceRef

+TopographicPlaceRef

Reference to a TopographicPlace

9.11. The complex type TopographicPlaceStructure

TopographicPlaceStructure

[TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g. County,City, Town, Village) and of different specificity (e.g. Greater London, London, West End, Westminster, St James's).

The element contains a sequence of the following elements:

TopographicPlaceCode

1:1

TopographicPlace ID.

TopographicPlaceName

1:1

+InternationalText

Name or description of TopographicPlace for use in passenger information.

PrivateCode

0:*

+PrivateCode

Code of this TopographicPlace in private/foreign/proprietary coding schemes.

ParentRef

0:1

+TopographicPlaceRef

Reference to a parent TopographicPlace.

ReferredSystemId

0:1

xs:normalizedString

Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/

Area

0:1

+Area

Area covered by the locality described as a polygon.

9.12. The complex type PointOfInterestRefStructure

PointOfInterestRefStructure

PointOfInterestCode

Reference to a Point of Interest

9.13. The toplevel element PointOfInterestRef

PointOfInterestRef

+PointOfInterestRef

Reference to a Point of Interest

9.14. The complex type PointOfInterestStructure

PointOfInterestStructure

[corresponds to POINT OF INTEREST in TMv6 with related information] type of PLACE to or through which passengers may wish to navigate as part of their journey and which is modelled in detail by journey planners.

The element contains a sequence of the following elements:

PublicCode

1:1

PointOfInterestCode

ID of this Point of Interest.

Name

1:1

+InternationalText

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

NameSuffix

0:1

+InternationalText

Additional description of the point of interest that may be appended to the name if enough space is available. F.e. "Exhibition Center".

PointOfInterestCategory

0:*

+PointOfInterestCategory

Categories this POI is associated with. Order indicates descending relevance.

PrivateCode

0:*

+PrivateCode

Code of this point of interest in private/foreign/proprietary coding schemes.

→‍TopographicPlaceRef

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

9.15. The complex type PointOfInterestCategoryStructure

PointOfInterestCategoryStructure

[a view of POINT OF INTEREST CLASSIFICATION in TMv6] categorisation of POINTs OF INTEREST in respect of the activities undertaken at them (defined by key-value-pairs).

The element contains one of the following elements:

a

OsmTag

-1:*

+OsmTag

Open Street Map tag structure (key-value)

b

PointOfInterestClassification

-1:*

xs:string

Classification of the POI (when it is not from OSM). The codification of the classification Id may include de codification source (for example "IGN:[classificationCode]")

9.16. The complex type OsmTagStructure

OsmTagStructure

Structure of an Open Street Map tag.

The element contains a sequence of the following elements:

Tag

1:1

xs:NMTOKEN

Name of Open Street Map tag (amenity, leisure, tourism, bike, ...)

Value

1:1

xs:NMTOKEN

Value for Open Street Map tag (charging_station, hostel, yes, ...)

9.17. The complex type PointOfInterestFilterStructure

PointOfInterestFilterStructure

Filter POIs by category.

The element contains a sequence of the following elements:

Exclude

0:1

xs:boolean

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

PointOfInterestCategory

0:*

+PointOfInterestCategory

These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE).

9.18. The complex type AddressRefStructure

AddressRefStructure

AddressCode

Reference to an Address

9.19. The toplevel element AddressRef

AddressRef

+AddressRef

Reference to an Address

9.20. The AddressDetailGroup group

+ + + + + + + +

AddressDetailGroup

An address with its name entities

AddressDetail

CountryName

0:1

xs:string

Country of the address.

PostCode

0:1

xs:string

Postal code of the address.

TopographicPlaceName

0:1

xs:string

TopographicPlace name of the address. If set it should at least contain the city name.

→‍TopographicPlaceRef

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

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.21. The complex type AddressStructure

+ + + + + + + +

AddressStructure

descriptive data associated with a PLACE that can be used to describe the unique geographical context of a PLACE for the purposes of identifying it. May be refined as either a ROAD ADDRESS, a POSTAL ADDRESS or both

The element contains a sequence of the following elements:

PublicCode

1:1

AddressCode

ID of this address.

PrivateCode

0:*

+PrivateCode

Code of this address in private/foreign/proprietary coding schemes.

Name

1:1

+InternationalText

Name or description of address for use in passenger information.

NameSuffix

0:1

+InternationalText

Additional description of the address that may be appended to the name if enough space is available. F.e. "Crossing with Peterstraße".

AddressDetail

CountryName

0:1

xs:string

Country of the address.

PostCode

0:1

xs:string

Postal code of the address.

TopographicPlaceName

0:1

xs:string

TopographicPlace name of the address. If set it should at least contain the city name.

→‍TopographicPlaceRef

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

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.

+

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

- - - + + + -

OJPFareRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

Then, the element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.3. The toplevel element OJPFareDelivery

OJPFareDelivery

+OJPFareDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.4. The complex type OJPFareDeliveryStructure

+

OJPFareDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.3. The toplevel element OJPFareDelivery

OJPFareDelivery

+OJPFareDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.4. The complex type OJPFareDeliveryStructure

- - + + - - - + + + -

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.

CalcTime

0:1

Calc

Calculation time.

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.

FareResponse

FareResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

FareResult

0:*

+FareResult

Fare result choice element.

→‍siri:Extensions

0:1

→‍siri:Extensions

FareResponse

FareResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

FareResult

0:*

+FareResult

Fare result choice element.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.5. The toplevel element OJPPlaceInformationRequest

OJPPlaceInformationRequest

+OJPPlaceInformationRequest (↔ siri:AbstractFunctionalServiceRequest)

10.6. The complex type OJPPlaceInformationRequestStructure

+

OJPPlaceInformationRequestStructure

+AbstractOJPServiceRequest

10.5. The toplevel element OJPPlaceInformationRequest

OJPPlaceInformationRequest

+OJPPlaceInformationRequest (↔ siri:AbstractFunctionalServiceRequest)

10.6. The complex type OJPPlaceInformationRequestStructure

- - - + + + -

OJPPlaceInformationRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

PlaceInformationRequest

a

InitialInput

-1:1

+InitialPlaceInput

Initial input for the place information request. This input defines what is originally looked for.

b

PlaceRef

-1:1

+PlaceRef

Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.

Restrictions

0:1

+PlaceParam

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

→‍siri:Extensions

0:1

→‍siri:Extensions

Then, the element contains one of the following elements:

PlaceInformationRequest

a

InitialInput

-1:1

+InitialPlaceInput

Initial input for the place information request. This input defines what is originally looked for.

b

PlaceRef

-1:1

+PlaceRef

Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.

Restrictions

0:1

+PlaceParam

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

→‍siri:Extensions

0:1

→‍siri:Extensions

10.7. The toplevel element OJPPlaceInformationDelivery

OJPPlaceInformationDelivery

+OJPPlaceInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.8. The complex type OJPPlaceInformationDeliveryStructure

+

OJPPlaceInformationDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.7. The toplevel element OJPPlaceInformationDelivery

OJPPlaceInformationDelivery

+OJPPlaceInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.8. The complex type OJPPlaceInformationDeliveryStructure

- - - + + + - - - - + + + + -

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.

CalcTime

0:1

Calc

Calculation time.

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.

CalcTime

0:1

Calc

Calculation time.

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.

PlaceResult

0:*

+PlaceResult

→‍siri:Extensions

0:1

→‍siri:Extensions

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.

PlaceResult

0:*

+PlaceResult

→‍siri:Extensions

0:1

→‍siri:Extensions

10.9. The toplevel element OJPExchangePointsRequest

OJPExchangePointsRequest

+OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest)

10.10. The complex type OJPExchangePointsRequestStructure

+

OJPExchangePointsRequestStructure

+AbstractOJPServiceRequest

10.9. The toplevel element OJPExchangePointsRequest

OJPExchangePointsRequest

+OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest)

10.10. The complex type OJPExchangePointsRequestStructure

- - - + + + -

OJPExchangePointsRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

ExchangePointsRequest

PlaceRef

0:1

+PlaceRef

Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

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

→‍siri:Extensions

0:1

→‍siri:Extensions

ExchangePointsRequest

PlaceRef

0:1

+PlaceRef

Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

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

→‍siri:Extensions

0:1

→‍siri:Extensions

10.11. The toplevel element OJPExchangePointsDelivery

OJPExchangePointsDelivery

+OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.12. The complex type OJPExchangePointsDeliveryStructure

+

OJPExchangePointsDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.11. The toplevel element OJPExchangePointsDelivery

OJPExchangePointsDelivery

+OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.12. The complex type OJPExchangePointsDeliveryStructure

- - - + + + - - - - + + + + -

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.

CalcTime

0:1

Calc

Calculation time.

The element contains a sequence of the following elements:

→‍OJPExchangePointsRequest

0:1

→‍OJPExchangePointsRequest

ServiceResponseContext

DataFrameRef

0:1

siri:DataFrameRefStructure

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

CalcTime

0:1

Calc

Calculation time.

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

→‍siri:Extensions

0:1

→‍siri:Extensions

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

→‍siri:Extensions

0:1

→‍siri:Extensions

10.13. The toplevel element OJPStopEventRequest

OJPStopEventRequest

+OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest)

10.14. The complex type OJPStopEventRequestStructure

+

OJPStopEventRequestStructure

+AbstractOJPServiceRequest

10.13. The toplevel element OJPStopEventRequest

OJPStopEventRequest

+OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest)

10.14. The complex type OJPStopEventRequestStructure

- - - + + + -

OJPStopEventRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

StopEventRequest

Place

1:1

+PlaceContext

Place for which to obtain stop event information.

Params

0:1

+StopEventParam

Request parameter

→‍siri:Extensions

0:1

→‍siri:Extensions

StopEventRequest

Place

1:1

+PlaceContext

Place for which to obtain stop event information.

Params

0:1

+StopEventParam

Request parameter

→‍siri:Extensions

0:1

→‍siri:Extensions

10.15. The toplevel element OJPStopEventDelivery

OJPStopEventDelivery

+OJPStopEventDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.16. The complex type OJPStopEventDeliveryStructure

+

OJPStopEventDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.15. The toplevel element OJPStopEventDelivery

OJPStopEventDelivery

+OJPStopEventDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.16. The complex type OJPStopEventDeliveryStructure

- - - + + + - - - + + + -

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.

CalcTime

0:1

Calc

Calculation time.

The element contains a sequence of the following elements:

→‍OJPStopEventRequest

0:1

→‍OJPStopEventRequest

ServiceResponseContext

DataFrameRef

0:1

siri:DataFrameRefStructure

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

CalcTime

0:1

Calc

Calculation time.

StopEventResponse

StopEventResponseContext

0:1

+ResponseContext

Container for data that is referenced multiple times.

StopEventResult

0:*

+StopEventResult

Enclosing element for stop event data.

→‍siri:Extensions

0:1

→‍siri:Extensions

StopEventResponse

StopEventResponseContext

0:1

+ResponseContext

Container for data that is referenced multiple times.

StopEventResult

0:*

+StopEventResult

Enclosing element for stop event data.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.17. The toplevel element OJPTripInfoRequest

OJPTripInfoRequest

+OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest)

10.18. The complex type OJPTripInfoRequestStructure

+

OJPTripInfoRequestStructure

+AbstractOJPServiceRequest

10.17. The toplevel element OJPTripInfoRequest

OJPTripInfoRequest

+OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest)

10.18. The complex type OJPTripInfoRequestStructure

- - + + - - + + - - + + -

OJPTripInfoRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

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

DatedJourneyRef

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

TimedVehicleRef

b

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

b

TimeOfOperation

1:1

xs:dateTime

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

TimedVehicleRef

b

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

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.

→‍siri:Extensions

0:1

→‍siri:Extensions

TripInfoRequest

Params

0:1

+TripInfoParam

Request parameter.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.19. The toplevel element OJPTripInfoDelivery

OJPTripInfoDelivery

+OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.20. The complex type OJPTripInfoDeliveryStructure

+

OJPTripInfoDeliveryStructure

siri:AbstractServiceDeliveryStructure

10.19. The toplevel element OJPTripInfoDelivery

OJPTripInfoDelivery

+OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.20. The complex type OJPTripInfoDeliveryStructure

- - - + + + - - - + + + -

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.

CalcTime

0:1

Calc

Calculation time.

The element contains a sequence of the following elements:

→‍OJPTripInfoRequest

0:1

→‍OJPTripInfoRequest

ServiceResponseContext

DataFrameRef

0:1

siri:DataFrameRefStructure

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

CalcTime

0:1

Calc

Calculation time.

TripInfoResponse

TripInfoResponseContext

0:1

+ResponseContext

Response context.

TripInfoResult

0:1

+TripInfoResult

Result structure.

→‍siri:Extensions

0:1

→‍siri:Extensions

TripInfoResponse

TripInfoResponseContext

0:1

+ResponseContext

Response context.

TripInfoResult

0:1

+TripInfoResult

Result structure.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.21. The toplevel element OJPTripRequest

OJPTripRequest

+OJPTripRequest (↔ siri:AbstractFunctionalServiceRequest)

10.22. The complex type OJPTripRequestStructure

+

OJPTripRequestStructure

+AbstractOJPServiceRequest

10.21. The toplevel element OJPTripRequest

OJPTripRequest

+OJPTripRequest (↔ siri:AbstractFunctionalServiceRequest)

10.22. The complex type OJPTripRequestStructure

- - - - - - - - -

OJPTripRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

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.

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+TripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.23. The toplevel element OJPTripDelivery

OJPTripDelivery

+OJPTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.24. The complex type OJPTripDeliveryStructure

- - - - + + + + + + + + +

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.

CalcTime

0:1

Calc

Calculation time.

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.

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+TripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.23. The toplevel element OJPTripDelivery

OJPTripDelivery

+OJPTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.24. The complex type OJPTripDeliveryStructure

+ + + + - - - + + + -

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.

CalcTime

0:1

Calc

Calculation time.

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

→‍siri:Extensions

0:1

→‍siri:Extensions

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.25. The toplevel element OJPMultiPointTripRequest

OJPMultiPointTripRequest

+OJPMultiPointTripRequest (↔ siri:AbstractFunctionalServiceRequest)

10.26. The complex type OJPMultiPointTripRequestStructure

+

OJPMultiPointTripRequestStructure

+AbstractOJPServiceRequest

10.25. The toplevel element OJPMultiPointTripRequest

OJPMultiPointTripRequest

+OJPMultiPointTripRequest (↔ siri:AbstractFunctionalServiceRequest)

10.26. The complex type OJPMultiPointTripRequestStructure

- - - - - - - - -

OJPMultiPointTripRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

MultiPointTripRequest

Origin

1:*

+PlaceContext

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

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

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

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.27. The toplevel element OJPMultiPointTripDelivery

OJPMultiPointTripDelivery

+OJPMultiPointTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.28. The complex type OJPMultiPointTripDeliveryStructure

- - - - + + + + + + + + +

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.

CalcTime

0:1

Calc

Calculation time.

MultiPointTripRequest

Origin

1:*

+PlaceContext

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

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

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

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.27. The toplevel element OJPMultiPointTripDelivery

OJPMultiPointTripDelivery

+OJPMultiPointTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.28. The complex type OJPMultiPointTripDeliveryStructure

+ + + + - - - + + + + +

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.

CalcTime

0:1

Calc

Calculation time.

MultiPointTripResponse

MultiPointTripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

MultiPointTripResult

0:*

+MultiPointTripResult

The trip results found by the server.

→‍siri:Extensions

0:1

→‍siri:Extensions

MultiPointTripResponse

MultiPointTripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

MultiPointTripResult

0:*

+MultiPointTripResult

The trip results found by the server.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.29. The toplevel element OJPTripRefineRequest

OJPTripRefineRequest

+OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest)

10.30. The complex type OJPTripRefineRequestStructure

+ + + + + + + +

OJPTripRefineRequestStructure

+AbstractOJPServiceRequest

The element contains a sequence of the following elements:

TripRefineRequest

RefineParams

0:1

+TripRefineParam

Options to control the refine

TripResult

1:1

+TripResult

The trip result to be refined by the server.

TripResponseContext

0:1

+ResponseContext

Context to hold objects, which are referenced within the response.

→‍siri:Extensions

0:1

→‍siri:Extensions

10.31. The toplevel element OJPTripRefineDelivery

OJPTripRefineDelivery

+OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery)

10.32. The complex type OJPTripRefineDeliveryStructure

+ + + + + + + + +

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.

CalcTime

0:1

Calc

Calculation time.

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.

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

- - + +

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)

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

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.

CalcTime

0:1

Calc

Calculation time.

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.

11.5. The SubscriptionRequestContextGroup group

- - + + - - + + - +

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.

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.

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)

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)

SubscriptionRequestContext

Extension

0:1

xs:anyType

SubscriptionRequestContext

Extension

0:1

xs:anyType

11.6. The complex type AbstractOJPServiceRequestStructure

- - + +

AbstractOJPServiceRequestStructure

siri:AbstractFunctionalServiceRequestStructure

Basic request structure common for all OJP service requests.

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

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

- - + + - - + + - +

AbstractOJPSubscriptionRequestStructure

siri:AbstractSubscriptionRequestStructure

Basic structure common for all OJP 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.

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.

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)

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)

SubscriptionRequestContext

Extension

0:1

xs:anyType

SubscriptionRequestContext

Extension

0:1

xs:anyType

11.8. The DeliveryRequestGroup group

@@ -636,8 +702,8 @@

OJP - Open API for distributed Journey

DeliveryRequestGroup

Wrapper for SIRI delivery request group.

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

-

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.

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.

+

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.

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

13.1. Simple type definitions

HierarchyEnumeration

local | no | down | all

@@ -650,24 +716,24 @@

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

StopEventRequest

Place

1:1

+PlaceContext

Place for which to obtain stop event information.

Params

0:1

+StopEventParam

Request parameter

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

- - - + + + - - - + + + - - - - - - - + + + + + +

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:

StopEventDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in stop events.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

StopEventDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in stop events.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

StopEventPolicy

NumberOfResults

0:1

xs:positiveInteger

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

TimeWindow

0:1

xs:duration

Time window events should lie within. Starting from time given in PlaceContext.

StopEventType

0:1

StopEventType

Only departures or arrivals or both.

StopEventPolicy

NumberOfResults

0:1

xs:positiveInteger

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

TimeWindow

0:1

xs:duration

Time window events should lie within. Starting from time given in PlaceContext.

StopEventType

0:1

StopEventType

Only departures or arrivals or both.

StopEventContentFilter

IncludePreviousCalls

0:1

xs:boolean

Whether the previous calls of each vehicle journey should be included in the response.

IncludeOnwardCalls

0:1

xs:boolean

Whether the onward calls of each vehicle journey should be included in the response.

IncludeOperatingDays

0:1

xs:boolean

Whether operating day information of this stop event should be included in the response.

IncludeRealtimeData

0:1

xs:boolean

Whether realtime information of this stop event should be included in the response.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

IncludeStopHierarchy

0:1

Hierarchy

Indicates for which parts of the hierarchy of the StopPlace(s) stop events should +

StopEventContentFilter

IncludePreviousCalls

0:1

xs:boolean

Whether the previous calls of each vehicle journey should be included in the response.

IncludeOnwardCalls

0:1

xs:boolean

Whether the onward calls of each vehicle journey should be included in the response.

IncludeOperatingDays

0:1

xs:boolean

Whether operating day information of this stop event should be included in the response.

IncludeRealtimeData

0:1

xs:boolean

Whether realtime information of this stop event should be included in the response.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

IncludeStopHierarchy

0:1

Hierarchy

Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided (if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/ StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces @@ -677,21 +743,21 @@

OJP - Open API for distributed Journey

13.4. The StopEventDataFilterGroup group

- - - + + +

StopEventDataFilterGroup

Request data filters

StopEventDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in stop events.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

StopEventDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in stop events.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

13.5. The StopEventPolicyGroup group

- - - + + +

StopEventPolicyGroup

Request policies

StopEventPolicy

NumberOfResults

0:1

xs:positiveInteger

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

TimeWindow

0:1

xs:duration

Time window events should lie within. Starting from time given in PlaceContext.

StopEventType

0:1

StopEventType

Only departures or arrivals or both.

StopEventPolicy

NumberOfResults

0:1

xs:positiveInteger

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

TimeWindow

0:1

xs:duration

Time window events should lie within. Starting from time given in PlaceContext.

StopEventType

0:1

StopEventType

Only departures or arrivals or both.

13.6. The StopEventContentFilterGroup group

- - - - - - - + + + + + +

StopEventContentFilterGroup

Content filters which data is expected in the response

StopEventContentFilter

IncludePreviousCalls

0:1

xs:boolean

Whether the previous calls of each vehicle journey should be included in the response.

IncludeOnwardCalls

0:1

xs:boolean

Whether the onward calls of each vehicle journey should be included in the response.

IncludeOperatingDays

0:1

xs:boolean

Whether operating day information of this stop event should be included in the response.

IncludeRealtimeData

0:1

xs:boolean

Whether realtime information of this stop event should be included in the response.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

IncludeStopHierarchy

0:1

Hierarchy

Indicates for which parts of the hierarchy of the StopPlace(s) stop events should +

StopEventContentFilter

IncludePreviousCalls

0:1

xs:boolean

Whether the previous calls of each vehicle journey should be included in the response.

IncludeOnwardCalls

0:1

xs:boolean

Whether the onward calls of each vehicle journey should be included in the response.

IncludeOperatingDays

0:1

xs:boolean

Whether operating day information of this stop event should be included in the response.

IncludeRealtimeData

0:1

xs:boolean

Whether realtime information of this stop event should be included in the response.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

IncludeStopHierarchy

0:1

Hierarchy

Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided (if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/ StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces @@ -701,300 +767,324 @@

OJP - Open API for distributed Journey

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.

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

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

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.

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

DatedJourneyRef

a

→‍JourneyRef

1:1

→‍JourneyRef

Reference to a Journey

a

→‍OperatingDayRef

1:1

→‍OperatingDayRef

Reference to an Operating Day

TimedVehicleRef

b

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

b

TimeOfOperation

1:1

xs:dateTime

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

TimedVehicleRef

b

→‍siri:VehicleRef

1:1

→‍siri:VehicleRef

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.

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:

TripInfoPolicy

UseTimetabledDataOnly

0:1

xs:boolean

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

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.

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.

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.

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.

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.

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.

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.

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.

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.

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.

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.

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

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.

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.

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.

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.

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

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.

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

lift | stairs | seriesOfStairs | escalator | ramp | footpath

Allowed values for a AccessFeature.

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 | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture

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

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.

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.

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+TripParam

Options to control the search behaviour and response contents.

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

lift | stairs | seriesOfStairs | escalator | ramp | footpath

Allowed values for a AccessFeature.

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.

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.

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+TripParam

Options to control the search behaviour and response contents.

15.3. The complex type TripParamStructure

- - - - + + + + + - - - - - - + + + + + + - - - - + + + + - - - - - + + + + + - - - + + + - - - - - - + + + + + + - - - - -

TripParamStructure

Trip request parameter structure.

The element contains a sequence of the following elements:

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

VehicleFilter

0:1

+VehicleFilter

Filter for VEHICLE and TRAIN NUMBERs.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

Then, the element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

TripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

ItModesToCover

0:*

IndividualModes

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

TripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

ItModesToCover

0:*

IndividualModes

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

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

Extension

0:1

xs:anyType

15.4. The TripDataFilterGroup group

- - - - + + + + +

TripDataFilterGroup

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

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

Extension

0:1

xs:anyType

15.4. The TripDataFilterGroup group

+ + + + +

TripDataFilterGroup

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

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

VehicleFilter

0:1

+VehicleFilter

Filter for VEHICLE and TRAIN NUMBERs.

15.5. The TripPolicyGroup group

- - - - - + + + + + - - - + + +

TripPolicyGroup

Policies that control the trip search behaviour.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

TripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

ItModesToCover

0:*

IndividualModes

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

TripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

ItModesToCover

0:*

IndividualModes

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

15.6. The TripMobilityFilterGroup group

- - - - - - + + + + + + - - - - + + + +

TripMobilityFilterGroup

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

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

15.7. The TripContentFilterGroup group

- - - - - - + + + + + + - - - - -

TripContentFilterGroup

Parameters that control the level of detail of the trip results.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

15.8. The complex type NotViaStructure

NotViaStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.9. The complex type NoChangeAtStructure

NoChangeAtStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.10. The TripResponseGroup group

- - -

TripResponseGroup

Trip response structure.

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

15.11. The complex type TripResultStructure

TripResultStructure

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

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

ErrorMessage

0:*

+ErrorMessage

Error messages related to this trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Detailed information on trip.

b

TripSummary

-1:1

+TripSummary

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

TripFare

0:*

+TripFareResult

15.12. The complex type TripSummaryStructure

- - -

TripSummaryStructure

Structure for trip overview information.

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Origin

0:1

+PlaceRef

Describes the origin situation of this trip.

Destination

0:1

+PlaceRef

Describes the arrival situation of this trip.

Duration

0:1

xs:duration

Overall duration of the trip.

StartTime

0:1

xs:dateTime

Departure time at origin.

EndTime

0:1

xs:dateTime

Arrival time at destination.

PTTripLegs

0:1

xs:nonNegativeInteger

Number of public transport trip legs.

Distance

0:1

siri:DistanceType

Trip distance.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.13. The complex type TripStructure

- - - - - - - - -

TripStructure

[an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Duration

1:1

xs:duration

Overall duration of the trip.

StartTime

1:1

xs:dateTime

Departure time at origin.

EndTime

1:1

xs:dateTime

Arrival time at destination.

Transfers

1:1

xs:nonNegativeInteger

Number of interchanges.

Distance

0:1

siri:DistanceType

Trip distance.

TripLeg

1:*

+TripLeg

Legs of the trip

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

TripStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Delayed

0:1

xs:boolean

Whether this trip is delayed. Default is false.

Infeasible

0:1

xs:boolean

Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

Extension

0:1

xs:anyType

15.14. The complex type TripLegStructure

TripLegStructure

a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)

The element contains a sequence of the following elements:

LegId

1:1

xs:NMTOKEN

Id of this trip leg. Unique within trip result.

ParticipantRef

0:1

siri:ParticipantRefStructure

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

Then, the element contains one of the following elements:

a

ContinuousLeg

-1:1

+ContinuousLeg

b

TimedLeg

-1:1

+TimedLeg

c

TransferLeg

-1:1

+TransferLeg

15.15. The complex type TimedLegStructure

- - -

TimedLegStructure

passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE.

The element contains a sequence of the following elements:

LegBoard

1:1

+LegBoard

Stop/Station where boarding is done

LegIntermediates

0:*

+LegIntermediate

information about the intermediate passed stop points.

LegAlight

1:1

+LegAlight

Stop/Station to alight

Service

1:1

+DatedJourney

Service that is used for this trip leg.

LegAttribute

0:*

+LegAttribute

Attributes that are not valid on the whole service, but only on parts of the journey leg.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

LegTrack

0:1

+LegTrack

Geographic embedding of this leg.

Extension

0:1

xs:anyType

15.16. The complex type TransferLegStructure

- - + + + + +

TransferLegStructure

[a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

ContinuousMode

-1:1

ContinuousModes

Mode that is used for this interchange between public services.

b

TransferMode

-1:1

TransferModes

Mode that is used for this interchange between public services.

LegStart

1:1

+PlaceRef

Stop/Station where boarding is done

LegEnd

1:1

+PlaceRef

Stop/Station to alight

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

15.8. The complex type NotViaStructure

NotViaStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.9. The complex type NoChangeAtStructure

NoChangeAtStructure

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

The element contains only one element:

Then, the element contains one of the following elements:

a

→‍siri:StopPointRef

-1:1

→‍siri:StopPointRef

b

→‍StopPlaceRef

-1:1

→‍StopPlaceRef

Reference to a Stop Place

15.10. The TripResponseGroup group

+ + +

TripResponseGroup

Trip response structure.

TripResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

15.11. The complex type TripResultStructure

TripResultStructure

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

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

ErrorMessage

0:*

+ErrorMessage

Error messages related to this trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Detailed information on trip.

b

TripSummary

-1:1

+TripSummary

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

TripFare

0:*

+TripFareResult

15.12. The complex type TripSummaryStructure

+ + +

TripSummaryStructure

Structure for trip overview information.

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Origin

0:1

+PlaceRef

Describes the origin situation of this trip.

Destination

0:1

+PlaceRef

Describes the arrival situation of this trip.

Duration

0:1

xs:duration

Overall duration of the trip.

StartTime

0:1

xs:dateTime

Departure time at origin.

EndTime

0:1

xs:dateTime

Arrival time at destination.

PTTripLegs

0:1

xs:nonNegativeInteger

Number of public transport trip legs.

Distance

0:1

siri:DistanceType

Trip distance.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.13. The complex type TripStructure

+ + + + + + + + +

TripStructure

[an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs

The element contains a sequence of the following elements:

TripId

1:1

xs:NMTOKEN

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

Duration

1:1

xs:duration

Overall duration of the trip.

StartTime

1:1

xs:dateTime

Departure time at origin.

EndTime

1:1

xs:dateTime

Arrival time at destination.

Transfers

1:1

xs:nonNegativeInteger

Number of interchanges.

Distance

0:1

siri:DistanceType

Trip distance.

TripLeg

1:*

+TripLeg

Legs of the trip

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

→‍SituationFullRef

0:*

→‍SituationFullRef

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

TripStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Delayed

0:1

xs:boolean

Whether this trip is delayed. Default is false.

Infeasible

0:1

xs:boolean

Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

Extension

0:1

xs:anyType

15.14. The complex type TripLegStructure

TripLegStructure

a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)

The element contains a sequence of the following elements:

LegId

1:1

xs:NMTOKEN

Id of this trip leg. Unique within trip result.

ParticipantRef

0:1

siri:ParticipantRefStructure

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

Then, the element contains one of the following elements:

a

ContinuousLeg

-1:1

+ContinuousLeg

b

TimedLeg

-1:1

+TimedLeg

c

TransferLeg

-1:1

+TransferLeg

15.15. The complex type TimedLegStructure

+ + +

TimedLegStructure

passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE.

The element contains a sequence of the following elements:

LegBoard

1:1

+LegBoard

Stop/Station where boarding is done

LegIntermediates

0:*

+LegIntermediate

information about the intermediate passed stop points.

LegAlight

1:1

+LegAlight

Stop/Station to alight

Service

1:1

+DatedJourney

Service that is used for this trip leg.

LegAttribute

0:*

+LegAttribute

Attributes that are not valid on the whole service, but only on parts of the journey leg.

OperatingDays

OperatingDays

0:1

+OperatingDays

Bit string definition of operating days.

OperatingDaysDescription

0:1

+InternationalText

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

LegTrack

0:1

+LegTrack

Geographic embedding of this leg.

Extension

0:1

xs:anyType

15.16. The complex type TransferLegStructure

+ + - - - -

TransferLegStructure

[a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

ContinuousMode

-1:1

ContinuousModes

Mode that is used for this interchange between public services.

b

TransferMode

-1:1

TransferModes

Mode that is used for this interchange between public services.

LegStart

1:1

+PlaceRef

Stop/Station where boarding is done

LegEnd

1:1

+PlaceRef

Stop/Station to alight

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

TransferDuration

Duration

1:1

xs:duration

Overall duration of this interchange.

WalkDuration

0:1

xs:duration

Walk time as part of the overall interchange duration.

BufferTime

0:1

xs:duration

Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

LegDescription

0:1

+InternationalText

Text that describes this interchange.

Length

0:1

Length

Length of this interchange path.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

PathGuidance

0:1

+PathGuidance

Structured model further describing this interchange, its geographic embedding and accessibility.

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.17. The complex type ContinuousLegStructure

- - -

ContinuousLegStructure

[relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable

The element contains a sequence of the following elements:

LegStart

1:1

+PlaceRef

Stop/Station where boarding is done

LegEnd

1:1

+PlaceRef

Stop/Station to alight

Service

1:1

+ContinuousService

Service of this leg. May be "walk" in most cases, but also cycling or taxi etc.

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

Duration

1:1

xs:duration

Duration of this leg according to user preferences like walk speed.

LegDescription

0:1

+InternationalText

Title or summary of this leg for overview.

Length

0:1

Length

Length of the leg.

LegTrack

0:1

+LegTrack

Detailed description of each element of this leg including geometric projection.

PathGuidance

0:1

+PathGuidance

Structured model further describing this interchange, its geographic embedding and accessibility.

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.18. The complex type LegBoardStructure

- - - - - - - - - - - - + + + +

LegBoardStructure

Describes the the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information.

The element contains a sequence of the following elements:

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

0:1

+ServiceArrival

describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

1:1

+ServiceDeparture

describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

DistributorInterchangeId

0:1

xs:normalizedString

Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

TransferDuration

Duration

1:1

xs:duration

Overall duration of this interchange.

WalkDuration

0:1

xs:duration

Walk time as part of the overall interchange duration.

BufferTime

0:1

xs:duration

Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

LegDescription

0:1

+InternationalText

Text that describes this interchange.

Length

0:1

Length

Length of this interchange path.

Attribute

0:*

+GeneralAttribute

Note or service attribute.

PathGuidance

0:1

+PathGuidance

Structured model further describing this interchange, its geographic embedding and accessibility.

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.17. The complex type ContinuousLegStructure

+ + +

ContinuousLegStructure

[relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable

The element contains a sequence of the following elements:

LegStart

1:1

+PlaceRef

Stop/Station where boarding is done

LegEnd

1:1

+PlaceRef

Stop/Station to alight

Service

1:1

+ContinuousService

Service of this leg. May be "walk" in most cases, but also cycling or taxi etc.

TimeWindow

TimeWindowStart

0:1

xs:dateTime

Time at which window begins.

TimeWindowEnd

0:1

xs:dateTime

Time at which window ends.

Duration

1:1

xs:duration

Duration of this leg according to user preferences like walk speed.

LegDescription

0:1

+InternationalText

Title or summary of this leg for overview.

Length

0:1

Length

Length of the leg.

LegTrack

0:1

+LegTrack

Detailed description of each element of this leg including geometric projection.

PathGuidance

0:1

+PathGuidance

Structured model further describing this interchange, its geographic embedding and accessibility.

→‍SituationFullRef

0:*

→‍SituationFullRef

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

Extension

0:1

xs:anyType

15.18. The complex type LegBoardStructure

+ + + + + + + + + + + +

LegBoardStructure

Describes the the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information.

The element contains a sequence of the following elements:

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

0:1

+ServiceArrival

describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

1:1

+ServiceDeparture

describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

DistributorInterchangeId

0:1

xs:normalizedString

Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

15.19. The complex type LegAlightStructure

- - - - - - - - - - - - + + + + + + + + + + + +

LegAlightStructure

Describes the situation at a stop or station at which the passenger alights from a Leg of a trip including time-related information

The element contains a sequence of the following elements:

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

1:1

+ServiceArrival

describes the arrival situation at the leg alight stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

0:1

+ServiceDeparture

describes the departure situation at this leg alight stop point (empty for last leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

FeederInterchangeId

0:1

xs:normalizedString

Interchange identifier of the feeding line/service at its alighting. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

1:1

+ServiceArrival

describes the arrival situation at the leg alight stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

0:1

+ServiceDeparture

describes the departure situation at this leg alight stop point (empty for last leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

FeederInterchangeId

0:1

xs:normalizedString

Interchange identifier of the feeding line/service at its alighting. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

15.20. The complex type LegIntermediateStructure

- - - - - - - - - - - - -

LegIntermediateStructure

Describes the situation at a stop or station that lies between the LegBoard and LegAlight stop or station including time-related information.

The element contains a sequence of the following elements:

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

1:1

+ServiceArrival

describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

1:1

+ServiceDeparture

describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

15.21. The complex type PathGuidanceStructure

PathGuidanceStructure

description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

The element contains only one element:

PathGuidanceSection

1:*

+PathGuidanceSection

one or more path guidance sections that build the trip Leg

15.22. The complex type PathGuidanceSectionStructure

PathGuidanceSectionStructure

[an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

The element contains a sequence of the following elements:

TrackSection

0:1

+TrackSection

LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

TurnDescription

0:1

+InternationalText

Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName.

GuidanceAdvice

0:1

GuidanceAdvice

various types of guidance advice given to travelle.

TurnAction

0:1

TurnAction

the range of alternative turns that can be described.

DirectionHint

0:1

+InternationalText

Textual direction hint for better understanding, e.g. "follow signs to Hamburg".

Bearing

0:1

siri:AbsoluteBearingType

Absolute bearing after the described manoeuvre.

PathLink

0:1

+PathLink

Description of the type of accessibility on this navigation section.

SituationFullRef

0:*

+SituationFullRef

15.23. The TransferDurationGroup group

- - - -

TransferDurationGroup

[an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time..

TransferDuration

Duration

1:1

xs:duration

Overall duration of this interchange.

WalkDuration

0:1

xs:duration

Walk time as part of the overall interchange duration.

BufferTime

0:1

xs:duration

Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

15.24. The complex type PathLinkStructure

PathLinkStructure

[TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE.

The element contains a sequence of the following elements:

Transition

0:1

Transition

Whether path is up down or level .

AccessFeatureType

0:1

AccessFeatureType

Type of physical feature of PATH LINK.

Count

0:1

xs:positiveInteger

Number how often the access feature occurs in this PathLink

15.25. The MultiPointTripRequestGroup group

- - - - - - -

MultiPointTripRequestGroup

Multi-point trip request structure.

MultiPointTripRequest

Origin

1:*

+PlaceContext

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

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

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

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

15.26. The complex type MultiPointTripParamStructure

- - - - + + + + + + + + + + + + +

MultiPointTripParamStructure

Multi-point trip request parameter structure.

The element contains a sequence of the following elements:

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

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

PlannedQuay

0:1

+InternationalText

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

EstimatedQuay

0:1

+InternationalText

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

ServiceArrival

1:1

+ServiceArrival

describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

ServiceDeparture

1:1

+ServiceDeparture

describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME)

MeetsViaRequest

0:1

xs:boolean

This stop fulfils one of the via requirements stated in the request data.

StopCallStatus

Order

0:1

xs:positiveInteger

Sequence number of this stop in the service pattern of the journey.

RequestStop

0:1

xs:boolean

The vehicle journey calls at this stop only on demand.

UnplannedStop

0:1

xs:boolean

This stop has not been planned by the planning department.

NotServicedStop

0:1

xs:boolean

The vehicle will not call at this stop despite earlier planning.

NoBoardingAtStop

0:1

xs:boolean

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

NoAlightingAtStop

0:1

xs:boolean

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

15.21. The complex type PathGuidanceStructure

PathGuidanceStructure

description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

The element contains only one element:

PathGuidanceSection

1:*

+PathGuidanceSection

one or more path guidance sections that build the trip Leg

15.22. The complex type PathGuidanceSectionStructure

PathGuidanceSectionStructure

[an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information

The element contains a sequence of the following elements:

TrackSection

0:1

+TrackSection

LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

TurnDescription

0:1

+InternationalText

Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName.

GuidanceAdvice

0:1

GuidanceAdvice

various types of guidance advice given to travelle.

TurnAction

0:1

TurnAction

the range of alternative turns that can be described.

DirectionHint

0:1

+InternationalText

Textual direction hint for better understanding, e.g. "follow signs to Hamburg".

Bearing

0:1

siri:AbsoluteBearingType

Absolute bearing after the described manoeuvre.

PathLink

0:1

+PathLink

Description of the type of accessibility on this navigation section.

SituationFullRef

0:*

+SituationFullRef

15.23. The TransferDurationGroup group

+ + + +

TransferDurationGroup

[an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time..

TransferDuration

Duration

1:1

xs:duration

Overall duration of this interchange.

WalkDuration

0:1

xs:duration

Walk time as part of the overall interchange duration.

BufferTime

0:1

xs:duration

Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains.

15.24. The complex type PathLinkStructure

PathLinkStructure

[TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE.

The element contains a sequence of the following elements:

Transition

0:1

Transition

Whether path is up down or level .

AccessFeatureType

0:1

AccessFeatureType

Type of physical feature of PATH LINK.

Count

0:1

xs:positiveInteger

Number how often the access feature occurs in this PathLink

From

0:1

+PathLinkEnd

Designations of level and place where this PathLink starts.

To

0:1

+PathLinkEnd

Designations of level and place where this PathLink ends.

15.25. The complex type PathLinkEndStructure

PathLinkEndStructure

Designations of a floor/level.

The element contains a sequence of the following elements:

LevelPublicCode

0:1

xs:normalizedString

Public identifier of the level as found on elevators and signs.

LevelName

0:1

+InternationalText

Official name of the level.

Id

0:1

xs:normalizedString

Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located).

15.26. The MultiPointTripRequestGroup group

+ + + + + + +

MultiPointTripRequestGroup

Multi-point trip request structure.

MultiPointTripRequest

Origin

1:*

+PlaceContext

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

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

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

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

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

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

15.27. The complex type MultiPointTripParamStructure

+ + + + + - - - - - - + + + + + + - - - - + + + + - - - - - + + + + + - - - + + + - - - - - - + + + + + + - - - - -

MultiPointTripParamStructure

Multi-point trip request parameter structure.

The element contains a sequence of the following elements:

TripDataFilter

PtModeFilter

0:1

+PtModeFilter

Modes to be considered in trip calculation.

LineFilter

0:1

+LineDirectionFilter

Lines/Directions to include/exclude.

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

PrivateModeFilter

0:1

+PrivateModeFilter

Private mobility options to include/exclude.

VehicleFilter

0:1

+VehicleFilter

Filter for VEHICLE and TRAIN NUMBERs.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

BaseTripMobilityFilter

NoSingleStep

0:1

xs:boolean

The user is not able to climb one step.

NoStairs

0:1

xs:boolean

The user is not able to walk up/down stairs.

NoEscalator

0:1

xs:boolean

The user is not able to use an escalator.

NoElevator

0:1

xs:boolean

The user is not able to use an elevator.

NoRamp

0:1

xs:boolean

The user is not able to use an ramp.

NoSight

0:1

xs:boolean

The user is not able to see.

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

TripMobilityFilter

LevelEntrance

0:1

xs:boolean

The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.

BikeTransport

0:1

xs:boolean

The user wants to carry a bike on public transport.

WalkSpeed

0:1

OpenPercent

Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.

AdditionalTransferTime

0:1

xs:duration

Additional time added to all transfers (also to transfers between individual to public transport).

Then, the element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

MultiPointTripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

MultiPointType

0:1

MultiPointType

If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

MultiPointTripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

MultiPointType

0:1

MultiPointType

If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

Extension

0:1

xs:anyType

15.27. The MultiPointTripPolicyGroup group

+ + + + +

MultiPointTripPolicyGroup

Policies that control the multi-point trip search behaviour.

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

Extension

0:1

xs:anyType

15.28. The MultiPointTripPolicyGroup group

- - - - - + + + + + - - - -

MultiPointTripPolicyGroup

Policies that control the multi-point trip search behaviour.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least.

IgnoreRealtimeData

0:1

xs:boolean

The trip calculation should not use any realtime or incident data.

ImmediateTripStart

0:1

xs:boolean

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

MultiPointTripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

MultiPointType

0:1

MultiPointType

If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

15.28. 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.29. The complex type MultiPointTripResultStructure

- - -

MultiPointTripResultStructure

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

The element contains a sequence of the following elements:

ResultId

1:1

xs:NMTOKEN

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

ErrorMessage

0:*

+ErrorMessage

Error messages related to trip result.

Then, the element contains one of the following elements:

a

Trip

-1:1

+Trip

Information on the trip.

b

TripSummary

-1:1

+TripSummary

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

TripFare

0:*

+TripFareResult

15.30. The MultiPointWaitTimeGroup group

- - -

MultiPointWaitTimeGroup

Group for wait times at origin/destination.

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

15.31. The TripStatusGroup group

- - - - - + + + +

TripStatusGroup

Parameters which describe the current status of a TRIP

TripStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Delayed

0:1

xs:boolean

Whether this trip is delayed. Default is false.

Infeasible

0:1

xs:boolean

Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

MultiPointTripPolicy

TransferLimit

0:1

xs:nonNegativeInteger

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

OptimisationMethod

0:1

OptimisationMethod

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

MultiPointType

0:1

MultiPointType

If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.

15.29. The MultiPointTripResponseGroup group

+ + +

MultiPointTripResponseGroup

Multi-point trip response structure.

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

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

TripFare

0:*

+TripFareResult

15.31. The MultiPointWaitTimeGroup group

+ + +

MultiPointWaitTimeGroup

Group for wait times at origin/destination.

MultiPointWaitTime

OriginWaitTime

0:1

xs:duration

Additional wait time at origin of this trip.

DestinationWaitTime

0:1

xs:duration

Additional wait time at destination of this trip.

15.32. The TripStatusGroup group

+ + + + + +

TripStatusGroup

Parameters which describe the current status of a TRIP

TripStatus

Unplanned

0:1

xs:boolean

Whether this trip is an additional one that has not been planned. Default is false.

Cancelled

0:1

xs:boolean

Whether this trip is cancelled and will not be run. Default is false.

Deviation

0:1

xs:boolean

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

Delayed

0:1

xs:boolean

Whether this trip is delayed. Default is false.

Infeasible

0:1

xs:boolean

Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

15.33. The TripRefineRequestGroup group

+ + + +

TripRefineRequestGroup

Trip refinement request structure.

TripRefineRequest

RefineParams

0:1

+TripRefineParam

Options to control the refine

TripResult

1:1

+TripResult

The trip result to be refined by the server.

TripResponseContext

0:1

+ResponseContext

Context to hold objects, which are referenced within the response.

15.34. The complex type TripRefineParamStructure

+ + + + + + + + + + + + +

TripRefineParamStructure

Trip refinement request parameter structure.

The element contains a sequence of the following elements:

ForeignObjectRefs

0:1

xs:boolean

If true, then the request may contain object references from another system. Default is FALSE.

RefineLegRef

1:*

xs:NMTOKEN

Refers to a leg to be refined by the server.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessibility

0:1

xs:boolean

Whether the result should include accessibility information.

IncludePlacesContext

0:1

xs:boolean

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

IncludeSituationsContext

0:1

xs:boolean

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

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

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

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

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

TripSummaryOnly

0:1

xs:boolean

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

FareParam

0:1

+FareParam

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

Extension

0:1

xs:anyType

15.35. The TripRefineResponseGroup group

+ + +

TripRefineResponseGroup

Trip refinement response structure.

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.

-

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?

Embeddable

0:1

xs:boolean

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

16.4. The complex type WebLinkStructure

- - - +

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

16.1. Simple type definitions

WebLinkStructure

URL of a web resource with label.

The element contains a sequence of the following elements:

Label

1:1

+InternationalText

Label for link description.

WebLink

Url

1:1

xs:anyURI

URL to resource on web.

MimeType

0:1

xs:normalizedString

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

Embeddable

0:1

xs:boolean

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

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?

Embeddable

0:1

xs:boolean

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

16.4. The complex type WebLinkStructure

+ + +

WebLinkStructure

URL of a web resource with label.

The element contains a sequence of the following elements:

Label

1:1

+InternationalText

Label for link description.

WebLink

Url

1:1

xs:anyURI

URL to resource on web.

MimeType

0:1

xs:normalizedString

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

Embeddable

0:1

xs:boolean

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

From 21456dfbe7a07d43dd70b379f6f9926d0daf6403 Mon Sep 17 00:00:00 2001 From: Stefan de Konink Date: Tue, 18 Oct 2022 18:08:28 +0200 Subject: [PATCH 4/4] Apply suggestions from code review --- OJP/OJP_JourneySupport.xsd | 5 ++--- docs/generated/OJP.html | 37 ++++++++++++++++--------------------- 2 files changed, 18 insertions(+), 24 deletions(-) diff --git a/OJP/OJP_JourneySupport.xsd b/OJP/OJP_JourneySupport.xsd index 5ba6f0c29..b066dddc7 100644 --- a/OJP/OJP_JourneySupport.xsd +++ b/OJP/OJP_JourneySupport.xsd @@ -89,13 +89,12 @@ - Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes -will use TrainNumber. + Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. - Contains the Vehicle reference of the vehicle. In Transmodel this may be VEHICLE.Id. + Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index 6d1e94204..c8ac57c40 100644 --- a/docs/generated/OJP.html +++ b/docs/generated/OJP.html @@ -60,7 +60,7 @@

OJP - Open API for distributed Journey 2. OJP/OJP_Common.xsd - Supporting definitions of common structures
  • 3. OJP/OJP_FacilitySupport.xsd - Supporting definitions for facilities containing wrappers for SIRI
  • 4. OJP/OJP_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information
    • -
  • 5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
    • +
  • 5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
  • 6. OJP/OJP_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles
  • 7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
  • 8. OJP/OJP_Places.xsd - Request and response definitions for place information
    • @@ -113,13 +113,13 @@

    OJP - Open API for distributed Journey 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 a traveller card (f.e. BahnCard50, BahnCard50First etc.).

    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.

    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

    VatRateEnumeration

    no | full | half | mixed | unknown

    Enumeration of Value Added Tax rates.

    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

    +

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

    5.1. Simple type definitions

    FareAuthorityGroup

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

    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.

    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

    VatRateEnumeration

    no | full | half | mixed | unknown

    Enumeration of Value Added Tax rates.

    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

    -

    TariffZoneListInAreaStructure

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

    The element contains a sequence of the following elements:

    FareAuthority

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    FareAuthorityText

    1:1

    xs:string

    Textual description or name of Fare authority.

    TariffZone

    1:*

    +TariffZone

    Fare zone in area.

    5.9. The complex type TariffZoneRefListStructure

    TariffZoneRefListStructure

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

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    →‍TariffZoneRef

    1:*

    →‍TariffZoneRef

    Reference to a fare zone.

    5.10. The complex type BookingArrangementStructure

    BookingArrangementStructure

    [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey

    The element contains a sequence of the following elements:

    BookingAgencyName

    0:1

    +InternationalText

    Name of the booking agency (contractual partner).

    BookingUrl

    0:1

    +WebLink

    URL to online booking service.

    InfoUrl

    0:1

    +WebLink

    URL to information page.

    PhoneNumber

    0:1

    PhoneNumber

    Phone number for booking.

    MinimumBookingPeriod

    0:1

    xs:duration

    Minimum duration bookings must be completed before trip starts.

    Extension

    0:1

    xs:anyType

    5.11. The complex type BookingArrangementsContainerStructure

    BookingArrangementsContainerStructure

    Container for multiple booking arrangements.

    The element contains a sequence of the following elements:

    BookingArrangement

    1:*

    +BookingArrangement

    [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.

    Extension

    0:1

    xs:anyType

    5.12. The complex type FareProductRefStructure

    FareProductRefStructure

    FareProductCode

    Reference to a FareProduct.

    5.13. The toplevel element FareProductRef

    FareProductRef

    +FareProductRef

    Reference to a FareProduct.

    5.14. The complex type EntitlementProductRefStructure

    EntitlementProductRefStructure

    EntitlementProductCode

    Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

    5.15. The toplevel element EntitlementProductRef

    EntitlementProductRef

    +EntitlementProductRef

    Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

    5.16. The complex type FareProductStructure

    +

    FareProductStructure

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

    The element contains a sequence of the following elements:

    FareProductId

    1:1

    FareProductCode

    Unique Id of the FareProduct.

    FareProductName

    1:1

    xs:string

    printable FareProduct name

    TariffZone

    1:*

    +TariffZone

    Fare zone in area.

    5.9. The complex type TariffZoneRefListStructure

    TariffZoneRefListStructure

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

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    →‍TariffZoneRef

    1:*

    →‍TariffZoneRef

    Reference to a fare zone.

    5.10. The complex type BookingArrangementStructure

    BookingArrangementStructure

    [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey

    The element contains a sequence of the following elements:

    BookingAgencyName

    0:1

    +InternationalText

    Name of the booking agency (contractual partner).

    BookingUrl

    0:1

    +WebLink

    URL to online booking service.

    InfoUrl

    0:1

    +WebLink

    URL to information page.

    PhoneNumber

    0:1

    PhoneNumber

    Phone number for booking.

    MinimumBookingPeriod

    0:1

    xs:duration

    Minimum duration bookings must be completed before trip starts.

    Extension

    0:1

    xs:anyType

    5.11. The complex type BookingArrangementsContainerStructure

    BookingArrangementsContainerStructure

    Container for multiple booking arrangements.

    The element contains a sequence of the following elements:

    BookingArrangement

    1:*

    +BookingArrangement

    [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.

    Extension

    0:1

    xs:anyType

    5.12. The complex type FareProductRefStructure

    FareProductRefStructure

    FareProductCode

    Reference to a FareProduct.

    5.13. The toplevel element FareProductRef

    FareProductRef

    +FareProductRef

    Reference to a FareProduct.

    5.14. The complex type EntitlementProductListStructure

    EntitlementProductListStructure

    A list of ENTITLEMENT PRODUCTs

    The element contains only one element:

    EntitlementProduct

    1:*

    +EntitlementProduct

    [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".

    5.15. The complex type EntitlementProductStructure

    EntitlementProductStructure

    [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to the fare authority that issued the ENTITLEMENT PRODUCT

    EntitlementProductRef

    1:1

    EntitlementProductCode

    Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...)

    ValidityPeriod

    0:1

    siri:HalfOpenTimestampOutputRangeStructure

    Validity period of the ENTITLEMENT PRODUCT

    EntitlementProductName

    1:1

    xs:string

    Name of the ENTITLEMENT PRODUCT

    5.16. The complex type FareProductStructure

    @@ -129,7 +129,7 @@

    OJP - Open API for distributed Journey

    - + @@ -146,7 +146,7 @@

    OJP - Open API for distributed Journey

    FareProductStructure

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

    The element contains a sequence of the following elements:

    FareProductId

    1:1

    FareProductCode

    Unique Id of the FareProduct.

    FareProductName

    1:1

    xs:string

    printable FareProduct name

    FareAuthority

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    FareAuthorityText

    1:1

    xs:string

    Textual description or name of Fare authority.

    ProtoProduct

    0:1

    xs:boolean

    Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/

    VatRate

    0:1

    VatRate

    Rate of value added tax. Default is unknown.

    FareProductValidity

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which the FareProduct is valid.

    RequiredCard

    0:*

    +EntitlementProductRef

    One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

    RequiredCard

    0:*

    +EntitlementProduct

    One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".

    ValidFor

    0:*

    PassengerCategory

    Sequence of all passenger categories for which this FareProduct is valid.

    ValidityDuration

    0:1

    xs:duration

    Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

    ValidityDurationText

    0:1

    +InternationalText

    Textual description of maximum validity duration.

    VatRate

    0:1

    VatRate

    Rate of value added tax. Default is unknown.

    5.18. The FareProductValidityGroup group

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

    OJP - Open API for distributed Journey

    FareProductValidityGroup

    conditions of use for a particular FARE PRODUCT.

    FareProductValidity

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which the FareProduct is valid.

    RequiredCard

    0:*

    +EntitlementProductRef

    One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

    RequiredCard

    0:*

    +EntitlementProduct

    One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".

    ValidFor

    0:*

    PassengerCategory

    Sequence of all passenger categories for which this FareProduct is valid.

    ValidityDuration

    0:1

    xs:duration

    Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

    ValidityDurationText

    0:1

    +InternationalText

    Textual description of maximum validity duration.

    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

    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

    EntitlementProduct

    0:*

    +EntitlementProductRef

    [a specific form of TRAVEL DOCUMENT in TM and NeTEx] a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc)

    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

    +

    FareDataFilterGroup

    Data filter group for Fare request.

    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

    @@ -184,9 +184,8 @@

    OJP - Open API for distributed Journey

    - - + + @@ -197,9 +196,8 @@

    OJP - Open API for distributed Journey

    - - + + @@ -222,9 +220,8 @@

    OJP - Open API for distributed Journey

    - - + + @@ -246,9 +243,8 @@

    OJP - Open API for distributed Journey

    - - + + @@ -336,9 +332,8 @@

    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

    Service

    Mode

    1:1

    +Mode

    [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

    ProductCategory

    0:1

    +ProductCategory

    A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

    PublishedServiceName

    1:1

    +InternationalText

    Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes -will use TrainNumber.

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber.

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    →‍OperatorRef

    0:1

    →‍OperatorRef

    Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

    RouteDescription

    0:1

    +InternationalText

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

    Via

    0:*

    +ServiceViaPoint

    Via points of the service that may help identify the vehicle to the public.

    Service

    Mode

    1:1

    +Mode

    [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

    ProductCategory

    0:1

    +ProductCategory

    A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

    PublishedServiceName

    1:1

    +InternationalText

    Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes -will use TrainNumber.

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber.

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    →‍OperatorRef

    0:1

    →‍OperatorRef

    Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

    RouteDescription

    0:1

    +InternationalText

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

    Via

    0:*

    +ServiceViaPoint

    Via points of the service that may help identify the vehicle to the public.

    Service

    Mode

    1:1

    +Mode

    [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

    ProductCategory

    0:1

    +ProductCategory

    A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

    PublishedServiceName

    1:1

    +InternationalText

    Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes -will use TrainNumber.

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber.

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    →‍OperatorRef

    0:1

    →‍OperatorRef

    Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

    RouteDescription

    0:1

    +InternationalText

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

    Via

    0:*

    +ServiceViaPoint

    Via points of the service that may help identify the vehicle to the public.

    Service

    a

    Mode

    1:1

    +Mode

    [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

    a

    ProductCategory

    0:1

    +ProductCategory

    A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

    a

    PublishedServiceName

    1:1

    +InternationalText

    Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

    a

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes -will use TrainNumber.

    a

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    a

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber.

    a

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    a

    →‍OperatorRef

    0:1

    →‍OperatorRef

    Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

    a

    RouteDescription

    0:1

    +InternationalText

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

    a

    Via

    0:*

    +ServiceViaPoint

    Via points of the service that may help identify the vehicle to the public.

    Service

    a

    Mode

    1:1

    +Mode

    [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs

    a

    ProductCategory

    0:1

    +ProductCategory

    A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland.

    a

    PublishedServiceName

    1:1

    +InternationalText

    Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488".

    a

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes -will use TrainNumber.

    a

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    a

    TrainNumber

    0:1

    xs:normalizedString

    Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber.

    a

    →‍siri:VehicleRef

    0:1

    →‍siri:VehicleRef

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

    a

    →‍OperatorRef

    0:1

    →‍OperatorRef

    Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service

    a

    RouteDescription

    0:1

    +InternationalText

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

    a

    Via

    0:*

    +ServiceViaPoint

    Via points of the service that may help identify the vehicle to the public.