1. OJP.xsd - OJP messages as extension of SIRI
1.1. The toplevel element OJP
| Root element for OJP messages based on SIRI message exchange protocol. | ||||
| 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 | -1:1 | OJP Request - Groups individual functional requests. | |||
b | -1:1 | OJP Request - Groups individual functional responses. | |||
0:1 |
1.2. The toplevel element OJPRequest
| OJP Request - Groups individual functional requests. |
1.3. The complex type OJPRequestStructure
| Type for OJP Request - Groups individual functional requests. | ||||
The element contains only one element: | |||||
1.4. The toplevel element OJPResponse
| OJP Request - Groups individual functional responses. |
1.5. The complex type OJPResponseStructure
| Type for OJP Response - Groups individual functional responses. | ||||
The element contains only one element: | |||||
2. OJP/OJP_Common.xsd - Supporting definitions of common structures
2.1. Simple type definitions
| xs:NMTOKEN | Identifier of a Journey |
| xs:NMTOKEN | Identifier of an Operating Day |
| xs:NMTOKEN | identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE |
| xs:NMTOKEN | Type for identifier of an product category code. |
| singleStationBased | multipleStationBased | nonStationBased | Sharing service loan and return scheme. |
| 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
| Structured error messages | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:normalizedString | Code of the error situation. | ||
| 0:1 | Description of the error situation. |
2.3. The complex type PrivateCodeStructure
| Code within scope of a private referential system | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Code of the foreign referential system. | ||
| 1:1 | xs:NMTOKEN | Object code within this private/foreign system. |
2.4. The complex type 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: | |||||
| 2:* | siri:LocationStructure | Ordered list of locations representing the geogemtry of the link. |
2.5. The complex type AreaStructure
| Area described as a polygon. | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Ordered list of geographic locations describing the polygon of the area. |
2.6. The toplevel element 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
| siri:OperatorRefStructure | Reference to an Operator ([TMv6] company providing public transport services.) |
2.8. The complex type OperatorFilterStructure
| Filter for in/exclusion of transport operators. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether operators in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:OperatorRefStructure | Reference to transport operator |
2.9. The complex type ProductCategoryRefStructure
| 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
| 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
| Filter for in/exclusion of lines (and directions). | ||||
The element contains a sequence of the following elements: | |||||
| 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.. | ||
| 0:1 | xs:boolean | Whether lines in list are to include or exclude from search. Default is exclude. |
2.12. The complex type JourneyRefStructure
| Reference to a Journey |
2.13. The toplevel element JourneyRef
| Reference to a Journey |
2.14. The DatedJourneyRefGroup
group
| Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day) | ||||
DatedJourneyRef | 1:1 | Reference to a Journey | |||
1:1 | Reference to an Operating Day |
| Root element for OJP messages based on SIRI message exchange protocol. | ||||
| 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 | -1:1 | OJP Request - Groups individual functional requests. | |||
b | -1:1 | OJP Request - Groups individual functional responses. | |||
0:1 |
1.2. The toplevel element OJPRequest
| OJP Request - Groups individual functional requests. |
1.3. The complex type OJPRequestStructure
| Type for OJP Request - Groups individual functional requests. | ||||
The element contains only one element: | |||||
1.4. The toplevel element OJPResponse
| OJP Request - Groups individual functional responses. |
1.5. The complex type OJPResponseStructure
| Type for OJP Response - Groups individual functional responses. | ||||
The element contains only one element: | |||||
2. OJP/OJP_Common.xsd - Supporting definitions of common structures
2.1. Simple type definitions
| xs:NMTOKEN | Identifier of a Journey |
| xs:NMTOKEN | Identifier of an Operating Day |
| xs:NMTOKEN | identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE |
| xs:NMTOKEN | Type for identifier of an product category code. |
| singleStationBased | multipleStationBased | nonStationBased | Sharing service loan and return scheme. |
| 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
| Structured error messages | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:normalizedString | Code of the error situation. | ||
| 0:1 | Description of the error situation. |
2.3. The complex type PrivateCodeStructure
| Code within scope of a private referential system | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Code of the foreign referential system. | ||
| 1:1 | xs:NMTOKEN | Object code within this private/foreign system. |
2.4. The complex type 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: | |||||
| 2:* | siri:LocationStructure | Ordered list of locations representing the geogemtry of the link. |
2.5. The complex type AreaStructure
| Area described as a polygon. | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Ordered list of geographic locations describing the polygon of the area. |
2.6. The toplevel element 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
| siri:OperatorRefStructure | Reference to an Operator ([TMv6] company providing public transport services.) |
2.8. The complex type OperatorFilterStructure
| Filter for in/exclusion of transport operators. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether operators in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:OperatorRefStructure | Reference to transport operator |
2.9. The complex type ProductCategoryRefStructure
| 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
| 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
| Filter for in/exclusion of lines (and directions). | ||||
The element contains a sequence of the following elements: | |||||
| 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.. | ||
| 0:1 | xs:boolean | Whether lines in list are to include or exclude from search. Default is exclude. |
2.12. The complex type JourneyRefStructure
| Reference to a Journey |
2.13. The toplevel element JourneyRef
| Reference to a Journey |
2.14. The DatedJourneyRefGroup
group
| Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day) | ||||
DatedJourneyRef | 1:1 | Reference to a Journey | |||
1:1 | Reference to an Operating Day |
2.15. The TimedVehicleRefGroup
group
| Reference to a vehicle for a specific point in time. | ||||
TimedVehicleRef |
| 1:1 | →siri:VehicleRef | ||
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | ||
TimedVehicleRef |
| 1:1 | →siri:VehicleRef | ||
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". |
2.16. The SharingServiceUsageGroup
group
| Usage parameters of a sharing service. | ||||
SharingServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. |
2.17. The complex type SharingServiceStructure
| Service that provides shared vehicles. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:OperatorRefStructure | Identifier of the operator of the sharing service | ||
| 0:1 | xs:string | Public name of the service. | ||
| 0:1 | Type of the sharing scheme. | |||
SharingServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
| 0:1 | Link to web page providing more details on service. |
2.18. The complex type OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE |
2.19. The toplevel element OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE |
2.20. The complex type OperatingDayRefStructure
| Reference to an Operating Day |
2.21. The toplevel element OperatingDayRef
| Reference to an Operating Day |
2.22. The complex type 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: | |||||
| 1:1 | xs:date | Start date of period. | ||
| 1:1 | xs:date | End date of period. | ||
| 1:1 | 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
| Coded as bit pattern | ||||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". |
2.24. The complex type 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: | |||||
| 0:* | [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays | |||
| 1:1 | xs:time | Start time of period. | ||
| 1:1 | xs:duration | Time duration of period. |
2.25. The complex type 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: | |||||
| 1:1 | Text of the attribute to be shown to the user. | |||
| 1:1 | xs:NMTOKEN | Internal code of the attribute. Can be used for detection of double occurrences. | ||
SharingServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. |
2.17. The complex type SharingServiceStructure
| Service that provides shared vehicles. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:OperatorRefStructure | Identifier of the operator of the sharing service | ||
| 0:1 | xs:string | Public name of the service. | ||
| 0:1 | Type of the sharing scheme. | |||
SharingServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
| 0:1 | Link to web page providing more details on service. |
2.18. The complex type OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE |
2.19. The toplevel element OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE |
2.20. The complex type OperatingDayRefStructure
| Reference to an Operating Day |
2.21. The toplevel element OperatingDayRef
| Reference to an Operating Day |
2.22. The complex type 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: | |||||
| 1:1 | xs:date | Start date of period. | ||
| 1:1 | xs:date | End date of period. | ||
| 1:1 | 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
| Coded as bit pattern | ||||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". |
2.24. The complex type 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: | |||||
| 0:* | [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays | |||
| 1:1 | xs:time | Start time of period. | ||
| 1:1 | xs:duration | Time duration of period. |
2.25. The complex type 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: | |||||
| 1:1 | Text of the attribute to be shown to the user. | |||
| 1:1 | xs:NMTOKEN | Internal code of the attribute. Can be used for detection of double occurrences. | ||
| |||||
| 0:1 | xs:boolean | Defines whether the attribute has to be shown to the user. | ||
| 0:1 | Importance of the attribute. | |||
WebLink |
| 1:1 | xs:anyURI | URL to resource on web. | |
| 0:1 | xs:normalizedString | MIME type of the referenced resource. To which kind of resource does the URL point to? | ||
| 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. | ||
| 0:1 | xs:boolean | Defines whether the attribute has to be shown to the user. | ||
| 0:1 | Importance of the attribute. | |||
WebLink |
| 1:1 | xs:anyURI | URL to resource on web. | |
| 0:1 | xs:normalizedString | MIME type of the referenced resource. To which kind of resource does the URL point to? | ||
| 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
| Wrapper for SIRI facilities. | ||||
| |||||
|
4. OJP/OJP_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information
4.1. The FareRequestGroup
group
| Fare request structure. | ||||
The element contains one of the following elements: | |||||
FareRequest | a |
| -1:1 | A request to calculate aggregated Fare information of multiple single trips | |
b |
| -1:1 | A request for general/static Fare information. | ||
c |
| -1:1 | A request for stop-related Fare information. | ||
d |
| -1:1 | A request to calculate the Fare information of a single trip | ||
| 0:1 | Parameter to filter the response contents. |
4.2. The complex type StopFareRequestStructure
| Sub-request: stop-related fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | →siri:StopPointRef | |||
| 0:1 | xs:date | Date for which to retrieve Fare information. |
4.3. The complex type StaticFareRequestStructure
| General Fare information. May depend on date. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
0:* | Reference to a FareProduct. |
4.4. The complex type TripFareRequestStructure
| Structure of a Single Trip Fare Request. | ||||
The element contains only one element: | |||||
| 1:1 | +Trip | A complete trip from origin to destination |
4.5. The complex type MultiTripFareRequestStructure
| Structure of a Multi Trip Fare Request. | ||||
The element contains only one element: | |||||
| 1:* | +Trip | Multiple complete trips from multiple origins and multiple destination |
4.6. The FareResponseGroup
group
| |||||
FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. |
4.7. The complex type FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | ID of this result. | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Static Fare information. | ||
c |
| -1:1 | Stop-related Fare information. | ||
d |
| -1:* | Fare and FareProducts for a given trip. |
4.8. The complex type StopFareResultStructure
| Stop-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | One or more lists of Fare zones that belong to a Fare authority/area. | |||
| 0:1 | xs:anyType |
4.9. The complex type StaticFareResultStructure
| General Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information. | |||
| 0:* | URL to information page on the web. | |||
| 0:1 | xs:anyType |
4.10. The complex type 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: | |||||
1:1 | Reference to a FareProduct. | ||||
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid from" tripLeg. If missing, then valid from the first leg. | ||
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid to" tripLeg. If missing, then valid to the last leg. |
4.11. The complex type MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages. | |||
| 1:* | Non-empty list of trip references in the corresponding MultiTripFareRequestStructure | |||
| 0:* | Zero, one or more FareProducts that are valid for the referenced trips / part of trips. | |||
| 0:1 | The set of passed zones. | |||
| 0:* | 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
| xs:NMTOKEN | Identifier of a traveller card (f.e. BahnCard50, BahnCard50First etc.). |
| xs:NMTOKEN | Identifier of a Fare Authority. |
| xs:NMTOKEN | Identifier of a FareProduct |
| 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. |
| xs:NMTOKEN | Identifier of a fare zone. |
| all | first | second | third | business | economy | classes of travel available on a particular service which will affect the price to be paid |
| no | full | half | mixed | unknown | Enumeration of Value Added Tax rates. |
5.2. The complex type FareAuthorityRefStructure
| 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
| Reference to a Fare Authority. |
5.4. The FareAuthorityGroup
group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||
FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. |
5.6. The toplevel element TariffZoneRef
| Reference to a fare zone. |
5.7. The complex type 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: | |||||
1:1 | Reference to a fare zone. | ||||
| 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
| List of fare zones within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
| 1:* | Fare zone in area. |
5.9. The complex type TariffZoneRefListStructure
| List of fare zones references within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a Fare Authority. | ||||
1:* | Reference to a fare zone. |
5.10. The complex type 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: | |||||
| 0:1 | Name of the booking agency (contractual partner). | |||
| 0:1 | URL to online booking service. | |||
| 0:1 | URL to information page. | |||
| 0:1 | Phone number for booking. | |||
| 0:1 | xs:duration | Minimum duration bookings must be completed before trip starts. | ||
| 0:1 | xs:anyType |
5.11. The complex type BookingArrangementsContainerStructure
| Container for multiple booking arrangements. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey. | |||
| 0:1 | xs:anyType |
5.12. The complex type FareProductRefStructure
| Reference to a FareProduct. |
5.13. The toplevel element FareProductRef
| Reference to a FareProduct. |
5.14. The complex type EntitlementProductRefStructure
| 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
| 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
| [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: | |||||
| 1:1 | Unique Id of the FareProduct. | |||
| 1:1 | xs:string | printable FareProduct name | ||
FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
| 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 |
| 0:1 | xs:decimal | FareProduct price as decimal number. | |
| 0:1 | xs:decimal | Net FareProduct price as decimal number for accounting purposes. | ||
| 0:1 | xs:NMTOKEN | iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. Default is unknown. | |||
The element contains one of the following elements: | |||||
FareRequest | a |
| -1:1 | A request to calculate aggregated Fare information of multiple single trips | |
b |
| -1:1 | A request for general/static Fare information. | ||
c |
| -1:1 | A request for stop-related Fare information. | ||
d |
| -1:1 | A request to calculate the Fare information of a single trip | ||
| 0:1 | Parameter to filter the response contents. |
4.2. The complex type StopFareRequestStructure
| Sub-request: stop-related fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | →siri:StopPointRef | |||
| 0:1 | xs:date | Date for which to retrieve Fare information. |
4.3. The complex type StaticFareRequestStructure
| General Fare information. May depend on date. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
0:* | Reference to a FareProduct. |
4.4. The complex type TripFareRequestStructure
| Structure of a Single Trip Fare Request. | ||||
The element contains only one element: | |||||
| 1:1 | +Trip | A complete trip from origin to destination |
4.5. The complex type MultiTripFareRequestStructure
| Structure of a Multi Trip Fare Request. | ||||
The element contains only one element: | |||||
| 1:* | +Trip | Multiple complete trips from multiple origins and multiple destination |
4.6. The FareResponseGroup
group
| |||||
FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. |
4.7. The complex type FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | ID of this result. | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Static Fare information. | ||
c |
| -1:1 | Stop-related Fare information. | ||
d |
| -1:* | Fare and FareProducts for a given trip. |
4.8. The complex type StopFareResultStructure
| Stop-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | One or more lists of Fare zones that belong to a Fare authority/area. | |||
| 0:1 | xs:anyType |
4.9. The complex type StaticFareResultStructure
| General Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information. | |||
| 0:* | URL to information page on the web. | |||
| 0:1 | xs:anyType |
4.10. The complex type 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: | |||||
1:1 | Reference to a FareProduct. | ||||
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid from" tripLeg. If missing, then valid from the first leg. | ||
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid to" tripLeg. If missing, then valid to the last leg. |
4.11. The complex type MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages. | |||
| 1:* | Non-empty list of trip references in the corresponding MultiTripFareRequestStructure | |||
| 0:* | Zero, one or more FareProducts that are valid for the referenced trips / part of trips. | |||
| 0:1 | The set of passed zones. | |||
| 0:* | 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
| xs:NMTOKEN | Identifier of a traveller card (f.e. BahnCard50, BahnCard50First etc.). |
| xs:NMTOKEN | Identifier of a Fare Authority. |
| xs:NMTOKEN | Identifier of a FareProduct |
| 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. |
| xs:NMTOKEN | Identifier of a fare zone. |
| all | first | second | third | business | economy | classes of travel available on a particular service which will affect the price to be paid |
| no | full | half | mixed | unknown | Enumeration of Value Added Tax rates. |
5.2. The complex type FareAuthorityRefStructure
| 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
| Reference to a Fare Authority. |
5.4. The FareAuthorityGroup
group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||
FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. |
5.6. The toplevel element TariffZoneRef
| Reference to a fare zone. |
5.7. The complex type 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: | |||||
1:1 | Reference to a fare zone. | ||||
| 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
| List of fare zones within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
| 1:* | Fare zone in area. |
5.9. The complex type TariffZoneRefListStructure
| List of fare zones references within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a Fare Authority. | ||||
1:* | Reference to a fare zone. |
5.10. The complex type 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: | |||||
| 0:1 | Name of the booking agency (contractual partner). | |||
| 0:1 | URL to online booking service. | |||
| 0:1 | URL to information page. | |||
| 0:1 | Phone number for booking. | |||
| 0:1 | xs:duration | Minimum duration bookings must be completed before trip starts. | ||
| 0:1 | xs:anyType |
5.11. The complex type BookingArrangementsContainerStructure
| Container for multiple booking arrangements. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey. | |||
| 0:1 | xs:anyType |
5.12. The complex type FareProductRefStructure
| Reference to a FareProduct. |
5.13. The toplevel element FareProductRef
| Reference to a FareProduct. |
5.14. The complex type EntitlementProductRefStructure
| 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
| 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
| [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: | |||||
| 1:1 | Unique Id of the FareProduct. | |||
| 1:1 | xs:string | printable FareProduct name | ||
FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
| 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 |
| 0:1 | xs:decimal | FareProduct price as decimal number. | |
| 0:1 | xs:decimal | Net FareProduct price as decimal number for accounting purposes. | ||
| 0:1 | xs:NMTOKEN | iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. Default is unknown. | |||
FareProductValidity |
| 0:1 | Travel class for which the FareProduct is valid. | ||
| 0:* | 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. | |||
| 0:* | Sequence of all passenger categories for which this FareProduct is valid. | |||
| 0:1 | xs:duration | Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation). | ||
| 0:1 | Textual description of maximum validity duration. | |||
| 0:* | Spatial validity of FareProduct defined as list of fare zones. | |||
| 0:1 | Textual description of spatial validity. | |||
FareProductValidity |
| 0:1 | Travel class for which the FareProduct is valid. | ||
| 0:* | 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. | |||
| 0:* | Sequence of all passenger categories for which this FareProduct is valid. | |||
| 0:1 | xs:duration | Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation). | ||
| 0:1 | Textual description of maximum validity duration. | |||
| 0:* | Spatial validity of FareProduct defined as list of fare zones. | |||
| 0:1 | Textual description of spatial validity. | |||
FareProductBooking |
| 0:* | URL to information for this FareProduct | ||
| 0:* | URL to buy the FareProduct online | |||
| 0:* | ||||
| 0:1 | xs:anyType |
5.17. The FareProductPriceGroup
group
| [related to FARE PRODUCT PRICE in TM and NeTEx] price at which a FARE PRODUCT can be purchased. | ||||
FareProductPrice |
| 0:1 | xs:decimal | FareProduct price as decimal number. | |
| 0:1 | xs:decimal | Net FareProduct price as decimal number for accounting purposes. | ||
| 0:1 | xs:NMTOKEN | iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. Default is unknown. | |||
FareProductBooking |
| 0:* | URL to information for this FareProduct | ||
| 0:* | URL to buy the FareProduct online | |||
| 0:* | ||||
| 0:1 | xs:anyType |
5.17. The FareProductPriceGroup
group
| [related to FARE PRODUCT PRICE in TM and NeTEx] price at which a FARE PRODUCT can be purchased. | ||||
FareProductPrice |
| 0:1 | xs:decimal | FareProduct price as decimal number. | |
| 0:1 | xs:decimal | Net FareProduct price as decimal number for accounting purposes. | ||
| 0:1 | xs:NMTOKEN | iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. Default is unknown. |
5.18. The FareProductValidityGroup
group
| conditions of use for a particular FARE PRODUCT. | ||||
FareProductValidity |
| 0:1 | Travel class for which the FareProduct is valid. | ||
| 0:* | 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. | |||
| 0:* | Sequence of all passenger categories for which this FareProduct is valid. | |||
| 0:1 | xs:duration | Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation). | ||
| 0:1 | Textual description of maximum validity duration. | |||
| 0:* | Spatial validity of FareProduct defined as list of fare zones. | |||
| 0:1 | Textual description of spatial validity. | |||
FareProductValidity |
| 0:1 | Travel class for which the FareProduct is valid. | ||
| 0:* | 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. | |||
| 0:* | Sequence of all passenger categories for which this FareProduct is valid. | |||
| 0:1 | xs:duration | Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation). | ||
| 0:1 | Textual description of maximum validity duration. | |||
| 0:* | Spatial validity of FareProduct defined as list of fare zones. | |||
| 0:1 | Textual description of spatial validity. |
5.19. The FareProductBookingGroup
group
| [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 |
| 0:* | URL to information for this FareProduct | ||
| 0:* | URL to buy the FareProduct online | |||
| 0:* | ||||
FareProductBooking |
| 0:* | URL to information for this FareProduct | ||
| 0:* | URL to buy the FareProduct online | |||
| 0:* |
5.20. The TripLegRangeGroup
group
| Range of trip legs (from - to) for which a Fare result (ticket) is valid. | ||||
TripLegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip leg. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip leg. |
5.21. The complex type TripFareResultStructure
| Structure of a Single Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages | |||
TripLegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip leg. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip leg. | ||
| 0:1 | The sequence of passed fare zones. | |||
| 0:* | One ore more FareProducts that are valid for this part of the trip. | |||
| 0:* | URL to static information page on the web. |
5.22. The complex type 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 |
| -1:1 | xs:nonNegativeInteger | Age of the passenger on the day of travel. | |
b |
| -1:1 | sequence of all passenger categories, for which this FareProduct is valid | ||
| 0:* | [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 |
| -1:* | Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it. | ||
b |
| -1:1 | Fare zones for which the passenger already has a valid FareProduct. |
5.23. The FareDataFilterGroup
group
| Data filter group for Fare request. | ||||
FareDataFilter |
| 0:* | Fare authority for which to retrieve Fare information. | ||
| 0:* | sequence of all passenger categories, for which this FareProduct is valid | |||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS | |||
TripLegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip leg. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip leg. |
5.21. The complex type TripFareResultStructure
| Structure of a Single Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages | |||
TripLegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip leg. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip leg. | ||
| 0:1 | The sequence of passed fare zones. | |||
| 0:* | One ore more FareProducts that are valid for this part of the trip. | |||
| 0:* | URL to static information page on the web. |
5.22. The complex type 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 |
| -1:1 | xs:nonNegativeInteger | Age of the passenger on the day of travel. | |
b |
| -1:1 | sequence of all passenger categories, for which this FareProduct is valid | ||
| 0:* | [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 |
| -1:* | Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it. | ||
b |
| -1:1 | Fare zones for which the passenger already has a valid FareProduct. |
5.23. The FareDataFilterGroup
group
| Data filter group for Fare request. | ||||
FareDataFilter |
| 0:* | Fare authority for which to retrieve Fare information. | ||
| 0:* | sequence of all passenger categories, for which this FareProduct is valid | |||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS |
5.24. The complex type 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 |
| 0:* | Fare authority for which to retrieve Fare information. | ||
| 0:* | sequence of all passenger categories, for which this FareProduct is valid | |||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS | |||
| 0:* | Number of travellers that will make the journey and for which Fare information needs to be gathered. |
FareAuthorityFilter
0:*
Fare authority for which to retrieve Fare information.
PassengerCategory
0:*
sequence of all passenger categories, for which this FareProduct is valid
TravelClass
0:1
Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS
Traveller
0:*
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
| Not yet operated | Operation finished | At stop | Between stops | Vehicle progress relative to timetable service pattern. |
6.2. The complex type 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 |
| 1:1 | →siri:StopPointRef | ||
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest realtime status. | |||
| 0:1 | Priority of this via point to be displayed when space is limited. |
6.3. The complex type 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: | |||||
| 0:1 | Full name of this product category, e.g. "Autoreisezug" in Switzerland or "Dampfschiff" | |||
| 0:1 | 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. | |||
0:1 | 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
| VIA restrictions for a TRIP. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Reference to specify the via place. | |||
| 0:1 | xs:duration | Duration the passenger wants to stay at the via place. Default is 0. |
6.5. The ScheduledJourneyGroup
group
| Vehicle journey (not dated). | ||||
ScheduledJourney | 1:1 | Reference to a Journey | |||
StopPoint |
| 1:1 | →siri:StopPointRef | ||
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest realtime status. | |||
| 0:1 | Priority of this via point to be displayed when space is limited. |
6.3. The complex type 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: | |||||
| 0:1 | Full name of this product category, e.g. "Autoreisezug" in Switzerland or "Dampfschiff" | |||
| 0:1 | 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. | |||
0:1 | 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
| VIA restrictions for a TRIP. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Reference to specify the via place. | |||
| 0:1 | xs:duration | Duration the passenger wants to stay at the via place. Default is 0. |
6.5. The ScheduledJourneyGroup
group
| Vehicle journey (not dated). | ||||
ScheduledJourney | 1:1 | Reference to a Journey | |||
| |||||
Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | 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. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | 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. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. |
6.6. The ServiceGroup
group
| Properties of a service (line and direction): attributes of Continuous Journey Structure or Dated Journey Structure. | ||||
| |||||
Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | 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. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | 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. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. |
6.7. The ServiceOriginGroup
group
| First serviced stop of a vehicle journey. | ||||
ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. | |||
ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. |
6.8. The ServiceDestinationGroup
group
| Last serviced stop of a vehicle journey. | ||||
ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. | |||
ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. |
6.9. The RouteDescriptionGroup
group
| Descriptive text for a route, f.e. "Airport via City Centre" | ||||
RouteDescription |
| 1:1 | |||
RouteDescription |
| 1:1 |
6.10. The DatedJourneyGroup
group
| Vehicle journey that runs at a specific date. | ||||
DatedJourney | 1:1 | Reference to an Operating Day | |||
| 0:1 | →siri:VehicleRef | |||
DatedJourney | 1:1 | Reference to an Operating Day | |||
| 0:1 | →siri:VehicleRef | |||
ScheduledJourney | 1:1 | Reference to a Journey | |||
ScheduledJourney | 1:1 | Reference to a Journey | |||
| |||||
Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | 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. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | 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. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. |
6.11. The PrivateServiceGroup
group
| specific service operated by a Private Mode | ||||
PrivateService | 0:1 | Reference to a Journey | |||
| 1:1 | [a category of MODE in TMv6] MODEs offered by private individuals | |||
| 0:1 | siri:OperatorRefStructure | |||
| 0:1 | Link to web page providing more details on service. | |||
PrivateService | 0:1 | Reference to a Journey | |||
| 1:1 | [a category of MODE in TMv6] MODEs offered by private individuals | |||
| 0:1 | siri:OperatorRefStructure | |||
| 0:1 | Link to web page providing more details on service. |
6.12. The complex type 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 | 1:1 | Reference to an Operating Day | ||
a |
| 0:1 | →siri:VehicleRef | ||
DatedJourney | a | 1:1 | Reference to an Operating Day | ||
a |
| 0:1 | →siri:VehicleRef | ||
ScheduledJourney | a | 1:1 | Reference to a Journey | ||
ScheduledJourney | a | 1:1 | Reference to a Journey | ||
| |||||
Service | a |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
a |
| 0:1 | 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 |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
Service | a |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
a |
| 0:1 | 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 |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
PrivateService | b | 0:1 | Reference to a Journey | ||
b |
| 1:1 | [a category of MODE in TMv6] MODEs offered by private individuals | ||
b |
| 0:1 | siri:OperatorRefStructure | ||
b |
| 0:1 | Link to web page providing more details on service. | ||
PrivateService | b | 0:1 | Reference to a Journey | ||
b |
| 1:1 | [a category of MODE in TMv6] MODEs offered by private individuals | ||
b |
| 0:1 | siri:OperatorRefStructure | ||
b |
| 0:1 | Link to web page providing more details on service. | ||
ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. | |||
ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. | |||
ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. | |||
ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. | |||
ServiceStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 0:1 | xs:boolean | Whether this trip is cancelled and will not be run. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 0:1 | siri:OccupancyEnumeration | [equivalent to OCCUPANCY in SIRI] passenger load status of a VEHICLE. If omitted, not known. | ||
| 0:1 | Container with information on booking possibilities for this service. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType |
6.13. The complex type 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: | |||||
1:1 | Reference to an Operating Day | ||||
1:1 | Reference to a Journey | ||||
|
6.14. The TimeWindowGroup
group
| The window of opportunity that the traveller has to perform this leg of the journey. | ||||
TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
ServiceStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 0:1 | xs:boolean | Whether this trip is cancelled and will not be run. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 0:1 | siri:OccupancyEnumeration | [equivalent to OCCUPANCY in SIRI] passenger load status of a VEHICLE. If omitted, not known. | ||
| 0:1 | Container with information on booking possibilities for this service. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType |
6.13. The complex type 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: | |||||
1:1 | Reference to an Operating Day | ||||
1:1 | Reference to a Journey | ||||
|
6.14. The TimeWindowGroup
group
| The window of opportunity that the traveller has to perform this leg of the journey. | ||||
TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. |
6.15. The ServiceTimeGroup
group
| Contains at least scheduled time, but can contain real time and estimated times | ||||
ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. |
6.16. The EstimatedTimeBandGroup
group
| Range for estimated time. | ||||
EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. |
6.17. The complex type 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 |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. |
6.18. The complex type 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 |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. |
6.19. The complex type 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 |
| 1:1 | →siri:StopPointRef | ||
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest realtime status. | |||
| 0:1 | Arrival times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | |||
| 0:1 | Departure times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | |||
StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 0:1 | xs:boolean | Boarding will not be allowed at this stop of this journey. | ||
| 0:1 | xs:boolean | Alighting will not be allowed at this stop of this journey. | ||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. |
6.20. The StopCallStatusGroup
group
| Status properties for the vehicle call at this stop. | ||||
StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 0:1 | xs:boolean | Boarding will not be allowed at this stop of this journey. | ||
| 0:1 | xs:boolean | Alighting will not be allowed at this stop of this journey. | ||
StopPoint |
| 1:1 | →siri:StopPointRef | ||
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest realtime status. | |||
| 0:1 | Arrival times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | |||
| 0:1 | Departure times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | |||
StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 0:1 | xs:boolean | Boarding will not be allowed at this stop of this journey. | ||
| 0:1 | xs:boolean | Alighting will not be allowed at this stop of this journey. | ||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. |
6.20. The StopCallStatusGroup
group
| Status properties for the vehicle call at this stop. | ||||
StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 0:1 | xs:boolean | Boarding will not be allowed at this stop of this journey. | ||
| 0:1 | xs:boolean | Alighting will not be allowed at this stop of this journey. |
6.21. The ServiceStatusGroup
group
| parameters which describe the current status of a DATED VEHICLE JOURNEY | ||||
ServiceStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 0:1 | xs:boolean | Whether this trip is cancelled and will not be run. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 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
| [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 |
| -1:1 | Continuous transport options. | ||
b |
| -1:1 | Individual transport options. | ||
Then, the element contains one of the following elements: | |||||
DatedJourney | a | 1:1 | Reference to an Operating Day | ||
a |
| 0:1 | →siri:VehicleRef | ||
ServiceStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 0:1 | xs:boolean | Whether this trip is cancelled and will not be run. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 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
| [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 |
| -1:1 | Continuous transport options. | ||
b |
| -1:1 | Individual transport options. | ||
Then, the element contains one of the following elements: | |||||
DatedJourney | a | 1:1 | Reference to an Operating Day | ||
a |
| 0:1 | →siri:VehicleRef | ||
ScheduledJourney | a | 1:1 | Reference to a Journey | ||
ScheduledJourney | a | 1:1 | Reference to a Journey | ||
| |||||
Service | a |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
a |
| 0:1 | 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 |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
Service | a |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
a |
| 0:1 | 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 |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber description from NeTEx. If several TrainNumber types exist, use the commercial number. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
b |
| -0:1 | |||
ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. | |||
b |
| -0:1 | |||
ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. | |||
ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. | |||
| 0:1 | Container with information on booking possibilities for this service. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType |
6.23. The complex type VehiclePositionStructure
| Geographical and logical position of a vehicle. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | siri:LocationStructure | Geographic position of vehicle. | ||
| 0:1 | Logical progress of vehicle relative to service pattern. | |||
| 0:1 | siri:AbsoluteBearingType | Bearing in compass degrees in which vehicle is heading. | ||
| 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
| [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 |
| -1:1 | Static place. | ||
b |
| -1:1 | Place within a (moving) vehicle. | ||
Then, the element contains one of the following elements: | |||||
a |
| -0:1 | xs:dateTime | Time when departure/arrival from/to place is required. | |
b |
| -0:1 | xs:duration | Extra time needed before reaching/after leaving this place. | |
| 0:* | Options how to access/leave the place by individual transport. |
6.25. The NumberOfResultsGroup
group
| 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 |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). | |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | ||
ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. | |||
| 0:1 | Container with information on booking possibilities for this service. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType |
6.23. The complex type VehiclePositionStructure
| Geographical and logical position of a vehicle. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | siri:LocationStructure | Geographic position of vehicle. | ||
| 0:1 | Logical progress of vehicle relative to service pattern. | |||
| 0:1 | siri:AbsoluteBearingType | Bearing in compass degrees in which vehicle is heading. | ||
| 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
| [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 |
| -1:1 | Static place. | ||
b |
| -1:1 | Place within a (moving) vehicle. | ||
Then, the element contains one of the following elements: | |||||
a |
| -0:1 | xs:dateTime | Time when departure/arrival from/to place is required. | |
b |
| -0:1 | xs:duration | Extra time needed before reaching/after leaving this place. | |
| 0:* | Options how to access/leave the place by individual transport. |
6.25. The NumberOfResultsGroup
group
| 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 |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). | |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). |
6.26. The BaseTripPolicyGroup
group
| Policies that control the trip search behaviour for both public and individual transport. | ||||
The element contains one of the following elements: | |||||
NumberOfResults | a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | |
BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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 |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | |
BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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
| Base mobility options to be applied for both public and individual transport. | ||||
BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to climb one step. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to use an escalator. | ||
| 0:1 | xs:boolean | The user is not able to use an elevator. | ||
| 0:1 | xs:boolean | The user is not able to use an ramp. | ||
| 0:1 | xs:boolean | The user is not able to see. | ||
BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to climb one step. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to use an escalator. | ||
| 0:1 | xs:boolean | The user is not able to use an elevator. | ||
| 0:1 | xs:boolean | The user is not able to use an ramp. | ||
| 0:1 | xs:boolean | The user is not able to see. |
6.28. The BaseTripContentFilterGroup
group
| Parameters to control the level of detail of both public and individual transport journey results. | ||||
BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include turn-by-turn instructions for each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include accessibility information. | ||
| 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. | ||
| 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
| 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: | |||||
| 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. | ||
| 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
| The LINK PROJECTION of a Leg onto the topography of the route being followed. | ||||
The element contains only one element: | |||||
| 1:* | LINK PROJECTION on the infrastructure network of the trip leg section together with time information. |
6.31. The complex type TrackSectionStructure
| LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Start place of this track. | |||
| 0:1 | End place of this track. | |||
| 0:1 | An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. | |||
| 0:1 | xs:string | Name of the road this track section is attached to. | ||
| 0:1 | xs:duration | Duration the passenger needs to travel through this track section. | ||
| 0:1 | siri:DistanceType | Length of this track section. | ||
| 0:1 | xs:anyType |
7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
7.1. Simple type definitions
| walk | demandResponsive | replacementService | Types of cmodes that run at any time without a timetable. |
| 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) |
| carPooling | [a category of MODE in TMv6] MODEs offered by private individuals |
| walk | parkAndRide | bikeAndRide | carHire | bikeHire | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut | MODEs dedicated to peform TRANSFERs |
7.2. The complex type IndividualTransportOptionsStructure
| Individual modes and their usage limits as stated by the passenger | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | 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. | |||
| 0:1 | siri:DistanceType | Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Maximum duration. If given, it restricts the maximum time of routes with the given mode. | ||
| 0:1 | siri:DistanceType | Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Minimum duration. If given, it restricts the minimum time of routes with the given mode. | ||
| 0:1 | Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100). | |||
| 0:1 | xs:duration | Additional time added to the actual traveling time needed to use a specific mode. |
7.3. The complex type 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 |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include turn-by-turn instructions for each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include accessibility information. | ||
| 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. | ||
| 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
| 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: | |||||
| 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. | ||
| 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
| The LINK PROJECTION of a Leg onto the topography of the route being followed. | ||||
The element contains only one element: | |||||
| 1:* | LINK PROJECTION on the infrastructure network of the trip leg section together with time information. |
6.31. The complex type TrackSectionStructure
| LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Start place of this track. | |||
| 0:1 | End place of this track. | |||
| 0:1 | An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. | |||
| 0:1 | xs:string | Name of the road this track section is attached to. | ||
| 0:1 | xs:duration | Duration the passenger needs to travel through this track section. | ||
| 0:1 | siri:DistanceType | Length of this track section. | ||
| 0:1 | xs:anyType |
7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
7.1. Simple type definitions
| walk | demandResponsive | replacementService | Types of cmodes that run at any time without a timetable. |
| 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) |
| carPooling | [a category of MODE in TMv6] MODEs offered by private individuals |
| walk | parkAndRide | bikeAndRide | carHire | bikeHire | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut | MODEs dedicated to peform TRANSFERs |
7.2. The complex type IndividualTransportOptionsStructure
| Individual modes and their usage limits as stated by the passenger | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | 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. | |||
| 0:1 | siri:DistanceType | Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Maximum duration. If given, it restricts the maximum time of routes with the given mode. | ||
| 0:1 | siri:DistanceType | Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Minimum duration. If given, it restricts the minimum time of routes with the given mode. | ||
| 0:1 | Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100). | |||
| 0:1 | xs:duration | Additional time added to the actual traveling time needed to use a specific mode. |
7.3. The complex type 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 |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
| |||||
| 0:1 | Name of the mode. | |||
| 0:1 | Short name or acronym of the mode. | |||
| 0:1 | Additional text that further describes the mode. |
7.4. The ModeGroup
group
| Elements for a Transport Mode | ||||
Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
| 0:1 | Name of the mode. | |||
| 0:1 | Short name or acronym of the mode. | |||
| 0:1 | Additional text that further describes the mode. |
7.4. The ModeGroup
group
| Elements for a Transport Mode | ||||
Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
|
7.5. The complex type 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: | |||||
| 0:1 | xs:boolean | Whether modes in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:VehicleModesOfTransportEnumeration | List of PT Transport modes to include/exclude. | ||
|
7.6. The complex type PrivateModeFilterStructure
| List of private mobility offers to include or exclude. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether modes in list are to include or exclude from search. Default is exclude. | ||
| 0:* | List of private mobility offers to include/exclude. |