OJPLocationInformationRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| LocationInformationRequest | a |
| -1:1 | Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs. | |
b |
| -1:1 | LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g. streets) which are to be refined in a subsequent request to the next level (e.g. house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement. | ||
Then, the element contains one of the following elements: | |||||
| LocationInformationRequest | a |
| -1:1 | Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs. | |
b |
| -1:1 | LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically, it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g., streets) which are to be refined in a subsequent request to the next level (e.g., house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
| 0:1 | →siri:Extensions | |||
| 0:* | The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best. | |||
| 0:1 | →siri:Extensions | |||
OJPExchangePointsRequest
| +OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest) | Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner has to find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. + | |||
OJPExchangePointsRequest
| +OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest) | Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner must find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. The boundary points where the trip calculation is handed over to the next journey planning system are called exchange points. If they are not known in advance the exchange points can be looked up from a server by using the exchange points service. This service implements the model PI QR Location Request from TM 6. | |||
OJPExchangePointsRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | E.g. location/place types (stops, addresses, POIs) or specific location/place attributes | |||
| 0:1 | →siri:Extensions | |||
OJPExchangePointsDelivery
| +OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery) | Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner has to find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. + | |||
OJPExchangePointsDelivery
| +OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery) | Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner must find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. The boundary points where the trip calculation is handed over to the next journey planning system are called exchange points. If they are not known in advance the exchange points can be looked up from a server by using the exchange points service. This service implements the model PI QR Location Request from TM 6. | |||
OJPExchangePointsDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
The element contains a sequence of the following elements: | |||||
0:1 | Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner has to find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. + | ||||
The element contains a sequence of the following elements: | |||||
0:1 | Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner must find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. The boundary points where the trip calculation is handed over to the next journey planning system are called exchange points. If they are not known in advance the exchange points can be looked up from a server by using the exchange points service. This service implements the model PI QR Location Request from TM 6. | ||||
| ServiceResponseContext |
| 0:1 | siri:DataFrameRefStructure | identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems. | |
| 0:1 | Calculation time. | |||
| 0:* | Enclosing element for stop event data. | |||
| 0:1 | →siri:Extensions | |||
OJPTripInfoRequest
| +OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest) | This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't provide directly information about a trip. When the response changes the conditions in a way that invalidates the trip (connection no longer possible, delays, cancellation) then a new TripRequest for the reminder of the trip is necessary for a replanning of the trip. -The service also provides information about formation, occupancy and capacity. The full SIRI elements are used. Therefore a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6. | |||
OJPTripInfoRequestStructure
| |||||
OJPTripInfoRequest
| +OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest) | This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't directly provide information about a trip. When the response changes the conditions in a way that invalidates the trip (connection no longer possible, delays, cancellation) then a new TripRequest for the reminder of the trip is necessary for a replanning of the trip. +The service also provides information about formation, occupancy, and capacity. The full SIRI elements are used. Therefore, a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6. | |||
OJPTripInfoRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| TripInfoRequest |
| 0:1 | Request parameter. | ||
| 0:1 | →siri:Extensions | |||
OJPTripInfoDelivery
| +OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery) | This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't provide directly information about a trip. When the response changes the conditions in a way that invalidates the trip (connection no longer possible, delays, cancellation) then a new TripRequest for the reminder of the trip is necessary for a replanning of the trip. -The service also provides information about formation, occupancy and capacity. The full SIRI elements are used. Therefore a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6. | |||
OJPTripInfoDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
OJPTripInfoDelivery
| +OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery) | This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't directly provide information about a trip. When the response changes the conditions in a way that invalidates the trip (connection no longer possible, delays, cancellation) then a new TripRequest for the reminder of the trip is necessary for a replanning of the trip. +The service also provides information about formation, occupancy, and capacity. The full SIRI elements are used. Therefore, a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6. | |||
OJPTripInfoDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
The element contains a sequence of the following elements: | |||||
0:1 | This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't provide directly information about a trip. When the response changes the conditions in a way that invalidates the trip (connection no longer possible, delays, cancellation) then a new TripRequest for the reminder of the trip is necessary for a replanning of the trip. -The service also provides information about formation, occupancy and capacity. The full SIRI elements are used. Therefore a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6. | ||||
The element contains a sequence of the following elements: | |||||
0:1 | This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't directly provide information about a trip. When the response changes the conditions in a way that invalidates the trip (connection no longer possible, delays, cancellation) then a new TripRequest for the reminder of the trip is necessary for a replanning of the trip. +The service also provides information about formation, occupancy, and capacity. The full SIRI elements are used. Therefore, a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6. | ||||
| ServiceResponseContext |
| 0:1 | siri:DataFrameRefStructure | identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems. | |
| 0:1 | Calculation time. | |||
| 0:* | OJP generic problem for the whole delivery. | |||
The element contains a sequence of the following elements: | |||||
| MultiPointTripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops (in Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia). | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops (in Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia). | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP (in Transmodel this would be an extension to TRIP MOBILITY FILTER). | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
| 0:1 | Calculation time. | |||
| 0:* | OJP generic problem for the whole delivery. | |||
| MultiPointTripResponse |
| 0:1 | The MultiPointType should be returned, because it may differ from the one asked. Many systems will support only a subset of the MultiPointTypes and it is important to know, what the result is based on. | ||
| MultiPointTripResponse |
| 0:1 | The MultiPointType should be returned because it may differ from the one asked. Many systems will support only a subset of the MultiPointTypes and it is important to know, what the result is based on. | ||
| 0:1 | Context to hold trip response objects that occur frequently. | |||
| 0:* | The trip results found by the server. | |||
| 0:1 | →siri:Extensions | |||
| 0:1 | →siri:Extensions | |||
OJPTripRefineRequest
| +OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest) | The trip refinement service retrieves additional or updated information (e.g., real-time data) about a given, previously retrieved trip. It does not depend on the assumption that the trip has been retrieved from the same server; it may, in fact, even stem from another source than a OJP system. -An example scenario may involve a trip retrieved from a system A and one wishes to refine the trip with real time information from another system B. As it cannot be ascertained that both systems use identical objcet IDs, this is signalled by setting ExternalObjectRefs to true. -System B, being confronted with external IDs, must try to recognise the relevant objects in another way and retrieve them in its own database. In the response it will use its own object IDs. In order to maintain a consistent mapping, it is imperative that system B reflects the structure of the refine request precisely in its response (principle of structure maintenance). | |||
OJPTripRefineRequestStructure
| |||||
OJPTripRefineRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| TripRefineRequest |
| 0:1 | Options to control the refine | ||
| 0:1 | →siri:Extensions | |||
OJPTripRefineDelivery
| +OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery) | The trip refinement service retrieves additional or updated information (e.g., real-time data) about a given, previously retrieved trip. It does not depend on the assumption that the trip has been retrieved from the same server; it may, in fact, even stem from another source than a OJP system. -An example scenario may involve a trip retrieved from a system A and one wishes to refine the trip with real time information from another system B. As it cannot be ascertained that both systems use identical objcet IDs, this is signalled by setting ExternalObjectRefs to true. -System B, being confronted with external IDs, must try to recognise the relevant objects in another way and retrieve them in its own database. In the response it will use its own object IDs. In order to maintain a consistent mapping, it is imperative that system B reflects the structure of the refine request precisely in its response (principle of structure maintenance). | |||
OJPTripRefineDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
OJPTripRefineDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
The element contains a sequence of the following elements: | |||||
0:1 | The trip refinement service retrieves additional or updated information (e.g., real-time data) about a given, previously retrieved trip. It does not depend on the assumption that the trip has been retrieved from the same server; it may, in fact, even stem from another source than a OJP system. -An example scenario may involve a trip retrieved from a system A and one wishes to refine the trip with real time information from another system B. As it cannot be ascertained that both systems use identical objcet IDs, this is signalled by setting ExternalObjectRefs to true. -System B, being confronted with external IDs, must try to recognise the relevant objects in another way and retrieve them in its own database. In the response it will use its own object IDs. In order to maintain a consistent mapping, it is imperative that system B reflects the structure of the refine request precisely in its response (principle of structure maintenance). | ||||
| ServiceResponseContext |
| 0:1 | siri:DataFrameRefStructure | identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems. | |
| 0:1 | Calculation time. | |||
| 0:* | OJP generic problem for the whole delivery. | |||
| ObjectIdType | Type for identifier of a NeTEx Object. |
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 place-related FARE information. | ||
c |
| -1:1 | A request for general/static FARE information. | ||
d |
| -1:1 | A request for stop-related FARE information. | ||
e |
| -1:1 | A request to calculate the FARE information of a single trip. | ||
| 0:1 | Parameter to filter the response contents. | |||
StopFareRequestStructure
| Sub-request: stop-related fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | →siri:StopPointRef | Reference to the stop point. | ||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
PlaceFareRequestStructure
| Sub-request: PLACE related fare information. This doesn't make a lot of sense for addresses, topographic place and coordinates. However, STOP PLACE, SCHEDULED STOP POINT and POINT OF INTEREST are different. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Place to get FAREs from (usually use only StopPoint, StopPlace and PointOfInterest). | |||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
0:* | Reference to a FareProduct. If no FareProductRef is specified the responding system should reply with information about all available fare products. | ||||
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. If no FareProductRef is specified the responding system should reply with information about all available fare products. | ||||
TripFareRequestStructure
| Structure of a Single Trip Fare Request. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Context to hold trip related objects that occur frequently. Especially necessary, when the system answering the fare request is not the same as the one that did the trip request. | |||
| 1:1 | +Trip | A complete trip from origin to destination | ||
MultiTripFareRequestStructure
| Structure of a Multi Trip Fare Request. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Context to hold trip related objects that occur frequently. | |||
| 1:* | +Trip | Multiple complete trips from multiple origins and multiple destination | ||
FareResponseGroup group
| |||||
StopFareRequestStructure
| Sub-request: stop-related fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | →siri:StopPointRef | Reference to the stop point. | ||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
PlaceFareRequestStructure
| Sub-request: PLACE related fare information. This doesn't make a lot of sense for addresses, topographic place, and coordinates. However, STOP PLACE, SCHEDULED STOP POINT and POINT OF INTEREST are different. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Place to get FAREs from (usually use only StopPoint, StopPlace and PointOfInterest). | |||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
0:* | Reference to a FareProduct. If no FareProductRef is specified, the responding system should reply with information about all available fare products. | ||||
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. If no FareProductRef is specified, the responding system should reply with information about all available fare products. | ||||
TripFareRequestStructure
| Structure of a Single Trip Fare Request. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Context to hold trip related objects that occur frequently. Especially necessary, when the system answering the fare request is not the same as the one that did the trip request. | |||
| 1:1 | +Trip | A complete trip from origin to destination | ||
MultiTripFareRequestStructure
| Structure of a Multi Trip Fare Request. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Context to hold trip related objects that occur frequently. | |||
| 1:* | +Trip | Multiple complete trips from multiple origins and multiple destination | ||
FareResponseGroup group
| |||||
| FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. | |||
FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this result. | |||
| 0:* | Problems related to this FARE result. | |||
| 0:1 | xs:boolean | Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, FareClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE. | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Place-related Fare information. | ||
c |
| -1:1 | Static Fare information. | ||
d |
| -1:1 | Stop-related Fare information. | ||
e |
| -1:* | Fare and FareProducts for a given trip. | ||
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 | |||
PlaceFareResultStructure
| PLACE-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | The involved PLACE. Usually a StopPoint, StopPlace or PointOfInterest. | |||
| 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 | |||
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 | |||
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 | Identifies the "valid from" trip. | |||
| 0:1 | Identifies the "valid from" LEG. If missing, then valid from the first LEG. | |||
| 1:1 | Identifies the "valid to" trip. | |||
| 0:1 | Identifies the "valid to" LEG. If missing, then valid to the last LEG. | |||
MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| public | authorisedPublic | staff | other | Allowed values for Booking Access. |
| callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none | Allowed values for a booking method. |
| ObjectIdType | Type for identifier of a BOOKING Object. |
| xs:normalizedString | Allowed values for Booking Process UIC 7037 Code list. |
| any | information | reservations | lostProperty | publicRelations | complaints | emergency | other | Allowed values for CONTACT role. |
| xs:NMTOKEN | Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority. |
| xs:NMTOKEN | Identifier of a Fare Authority. |
| FARE_OUTOFAREA | FARE_JOURNEYNOTPERMITTED | FARE_ADDITIONALCHARGES | FARE_ADDITIONALTICKETS | FARE_ROUTENOTFEASIBLE | FARE_ALREADYCOVERED | FARE_DATEOUTOFRANGE | FARE_STOPPOINTUNKNOWN | FARE_OTHER | Types of problems that may be returned in responses to FARE requests. |
| xs:NMTOKEN | Identifier of a FareProduct |
| xs:normalizedString | Allowed values for Group Booking. |
| Adult | Child | Senior | Youth | Disabled | Dog | Bicycle | Motorcycle | Car | Truck | Group | [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:normalizedString | Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc. |
| xs:normalizedString | Allowed values for Purchase Moment. |
| xs:normalizedString | Allowed values for Purchase when. |
| xs:NMTOKEN | Identifier of a fare zone. |
BookingNotesStructure
| A structure for an ordered list of booking notes. | ||||
The element contains only one element: | |||||
| 1:* | Note about booking the LINE. | |||
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). | ||||
FareAuthorityRef
| Reference to a Fare Authority. | ||||
FareAuthorityGroup group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||
FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this result. | |||
| 0:* | Problems related to this FARE result. | |||
| 0:1 | xs:boolean | Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, FareClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE. | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Place-related Fare information. | ||
c |
| -1:1 | Static Fare information. | ||
d |
| -1:1 | Stop-related Fare information. | ||
e |
| -1:* | Fare and FareProducts for a given trip. | ||
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 | |||
PlaceFareResultStructure
| PLACE-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | The involved PLACE. Usually,a StopPoint, StopPlace or PointOfInterest. | |||
| 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 | |||
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 | |||
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 | Identifies the "valid from" trip. | |||
| 0:1 | Identifies the "valid from" LEG. If missing, then valid from the first LEG. | |||
| 1:1 | Identifies the "valid to" trip. | |||
| 0:1 | Identifies the "valid to" LEG. If missing, then valid to the last LEG. | |||
MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| public | authorisedPublic | staff | other | Allowed values for Booking Access. |
| callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none | Allowed values for a booking method. |
| ObjectIdType | Type for identifier of a BOOKING Object. |
| xs:normalizedString | Allowed values for Booking Process UIC 7037 Code list. |
| any | information | reservations | lostProperty | publicRelations | complaints | emergency | other | Allowed values for CONTACT role. |
| xs:NMTOKEN | Identifier of an ENTITLEMENT PRODUCT (e.g., BahnCard50, BahnCard50First, military card, concessionary card). It is defined by the fare authority. |
| xs:NMTOKEN | Identifier of a Fare Authority. |
| FARE_OUTOFAREA | FARE_JOURNEYNOTPERMITTED | FARE_ADDITIONALCHARGES | FARE_ADDITIONALTICKETS | FARE_ROUTENOTFEASIBLE | FARE_ALREADYCOVERED | FARE_DATEOUTOFRANGE | FARE_STOPPOINTUNKNOWN | FARE_OTHER | Types of problems that may be returned in responses to FARE requests. |
| xs:NMTOKEN | Identifier of a FareProduct |
| xs:normalizedString | Allowed values for Group Booking. |
| Adult | Child | Senior | Youth | Disabled | Dog | Bicycle | Motorcycle | Car | Truck | Group | [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:normalizedString | Type for an International phone number. + Country + MSISDN e.g., +41 675601 etc. |
| xs:normalizedString | Allowed values for Purchase Moment. |
| xs:normalizedString | Allowed values for Purchase when. |
| xs:NMTOKEN | Identifier of a fare zone. |
BookingNotesStructure
| A structure for an ordered list of booking notes. | ||||
The element contains only one element: | |||||
| 1:* | Note about booking the LINE. | |||
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). | ||||
FareAuthorityRef
| Reference to a Fare Authority. | ||||
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. | ||
TariffZoneRef
| Reference to a fare zone. | ||||
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. | ||
TariffZoneListInAreaStructure
| List of fare zones within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | URL for booking. | |||
| 0:1 | Notes about booking the LINE. | |||
| 0:1 | xs:anyType | |||
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 | |||
FareProductRefStructure
| Reference to a FareProduct. | ||||
FareProductRef
| Reference to a FareProduct. | ||||
EntitlementProductListStructure
| A list of ENTITLEMENT PRODUCTs | ||||
The element contains only one element: | |||||
| 1:* | [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | |||
EntitlementProductStructure
| [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to the fare authority that issued the ENTITLEMENT PRODUCT | ||||
| 1:1 | Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...) | |||
| 0:1 | siri:HalfOpenTimestampOutputRangeStructure | Validity period of the ENTITLEMENT PRODUCT | ||
| 1:1 | xs:string | Name of the ENTITLEMENT PRODUCT | ||
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 | Identifier of a FareProduct | |||
| 1:1 | xs:string | Printable FareProduct name | ||
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 | |||
FareProductRefStructure
| Reference to a FareProduct. | ||||
FareProductRef
| Reference to a FareProduct. | ||||
EntitlementProductListStructure
| A list of ENTITLEMENT PRODUCTs | ||||
The element contains only one element: | |||||
| 1:* | [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g., military card, concessionary card). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn". | |||
EntitlementProductStructure
| [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g., military card, concessionary card). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn". | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to the fare authority that issued the ENTITLEMENT PRODUCT | ||||
| 1:1 | Identifier of the ENTITLEMENT PRODUCT (e.g., BahnCard50, BahnCard50First) | |||
| 0:1 | siri:HalfOpenTimestampOutputRangeStructure | Validity period of the ENTITLEMENT PRODUCT | ||
| 1:1 | xs:string | Name of the ENTITLEMENT PRODUCT | ||
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 | Identifier of a 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 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/ | ||
| 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 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 | xs:NMTOKEN | iso 4217 currency code, e.g., EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. | |||
| 0:1 | xs:integer | Remaining offered tickets in this FARE PRODUCT. When absent, the number of remaining tickets is unknown or it is not limited. In most cases if the FareQuota is zero then the FareProduct is not shown. | ||
| FareProductValidity |
| 0:1 | siri:FareClassEnumeration | Fare class for which the FareProduct is valid (Transmodel: CLASS OF USE). | |
| 0:* | One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | |||
| 0:* | One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn". | |||
| 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:1 | xs:anyType | |||
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 | xs:NMTOKEN | iso 4217 currency code, e.g., EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. | |||
FareProductValidityGroup group
| conditions of use for a particular FARE PRODUCT. | ||||
| FareProductValidity |
| 0:1 | siri:FareClassEnumeration | Fare class for which the FareProduct is valid (Transmodel: CLASS OF USE). | |
| 0:* | One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | |||
| 0:* | One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn". | |||
| 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. | |||
LegRangeGroup group
| Range of LEGs (from - to) for which a Fare result (ticket) is valid. | ||||
| LegRange |
| 1:1 | Identifies the "valid from" LEG. | ||
| 1:1 | Identifies the "valid to" LEG. | |||
TripFareResultStructure
| Structure of a single TripFareResult. This may cover the whole trip or only the part the service can answer. If only partial answers can be delivered, then this must be indicated with FARE_ADDITIONALTICKETS (as a warning). For a given trip multiple FareResults may need to be combined to get the whole tariff. A typical example may be classic public transport and a sharing leg. Some legs, e.g. TransferLegs and walking ContinuousLeg will never have a price. The service may include them in one of the tickets. If the whole trip is for free, then a TripFareResult with a price of 0 is expected. It is possible to have combined FareResults (e.g. for a bundle) and in addition price each leg individually. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages. | |||
| 0:1 | ||||
| 0:1 | ||||
TripFareResultStructure
| Structure of a single TripFareResult. This may cover the whole trip or only the part the service can answer. If only partial answers can be delivered, then this must be indicated with FARE_ADDITIONALTICKETS (as a warning). For a given trip multiple FareResults may need to be combined to get the whole tariff. A typical example may be classic public transport and a sharing leg. Some legs, e.g., TransferLegs and walking ContinuousLeg will never have a price. The service may include them in one of the tickets. If the whole trip is for free, then a TripFareResult with a price of 0 is expected. It is possible to have combined FareResults (e.g., for a bundle) and in addition price each leg individually. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages. | |||
| 0:1 | ||||
| 0:1 | ||||
| LegRange |
| 1:1 | Identifies the "valid from" LEG. | ||
| 1:1 | Identifies the "valid to" 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. | |||
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:1 | A list of ENTITLEMENT PRODUCTs. | |||
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. | ||
FareDataFilterGroup group
| Data filter group for Fare request. | ||||
| 0:1 | The sequence of passed fare zones. | |||
| 0:* | One or more FareProducts that are valid for this part of the trip. | |||
| 0:* | URL to static information page on the web. | |||
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:1 | A list of ENTITLEMENT PRODUCTs. | |||
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. | ||
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 | siri:FareClassEnumeration | Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). Transmodel: CLASS OF USE. | ||
| 0:1 | siri:FareClassEnumeration | Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g., first class). Transmodel: CLASS OF USE. | ||
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 | siri:FareClassEnumeration | Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). Transmodel: CLASS OF USE. | ||
| 0:1 | siri:FareClassEnumeration | Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g., first class). Transmodel: CLASS OF USE. | ||
| 0:* | Number of travellers that will make the journey and for which Fare information needs to be gathered. | |||
| 0:1 | ACCESS MODEs to consider (usually only one). This is only used in very special cases. E.g. for carTransportRail. It indicates if one uses a car, truck, motorcycle or bike. The Access mode may result in no transportation being possible. | |||
| 0:1 | xs:anyType | |||
FareProblemType
| FareProblemType (↔ ErrorType) | ||||
| LINEINFORMATION_LINEUNKNOWN | LINEINFORMATION_OTHER | Types of problems that may be returned in responses to LINE INFORMATION requests. |
LineInformationResponseGroup group
| Line Information response group. | ||||
| LineInformationResponse |
| 0:* | |||
LineResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this Line result. | |||
| 1:1 | siri:LineRefStructure | Reference to the LINE. | ||
| 0:1 | →siri:PublishedLineName | Name or Number by which the LINE is known to the public. | ||
| 0:1 | siri:DirectionRefStructure | DIRECTION of LINE. | ||
| 0:* | The LINE's route geometry. A line can have multiple ROUTEs and each has its own geometry. The first should be the "main" geometry. | |||
| 0:* | +Area | The LINE's main area. Used for MOBILITY SERVICES that cover one or more areas. The interconnection between the areas is not calculated (e.g. exclusion zones can't be modelled). Don't mix RouteGeometry and AreaGeometry in a response. | ||
| 0:* | +Mode | List of transport modes that are supported by this line. | ||
LineInformationProblemType
| LineInformationProblemType (↔ ErrorType) | ||||
LineResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this Line result. | |||
| 1:1 | siri:LineRefStructure | Reference to the LINE. | ||
| 0:1 | →siri:PublishedLineName | Name or Number by which the LINE is known to the public. | ||
| 0:1 | siri:DirectionRefStructure | DIRECTION of LINE. | ||
| 0:* | The LINE's route geometry. A line can have multiple ROUTEs, and each has its own geometry. The first should be the "main" geometry. | |||
| 0:* | +Area | The LINE's main area. Used for MOBILITY SERVICES that cover one or more areas. The interconnection between the areas is not calculated (e.g., exclusion zones can't be modelled). Don't mix RouteGeometry and AreaGeometry in a response. | ||
| 0:* | +Mode | List of transport modes that are supported by this line. | ||
LineInformationProblemType
| LineInformationProblemType (↔ ErrorType) | ||||
| stop | address | poi | coord | location | topographicPlace | |
| origin | via | destination |
LocationInformationRequestGroup group
| |||||
The element contains one of the following elements: | |||||
| LocationInformationRequest | a |
| -1:1 | Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs. | |
b |
| -1:1 | LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g. streets) which are to be refined in a subsequent request to the next level (e.g. house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement. | ||
The element contains one of the following elements: | |||||
| LocationInformationRequest | a |
| -1:1 | Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs. | |
b |
| -1:1 | LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically, it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g., streets) which are to be refined in a subsequent request to the next level (e.g., house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
LocationInformationResponseGroup group
| |||||
| LocationInformationResponse |
| 0:1 | Context to hold response objects that occur frequently. | ||
| 0:1 | xs:nonNegativeInteger | If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. | ||
| 0:* | The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best. | |||
InitialLocationInputStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:string | Name of the LOCATION object which is looked for. This is usually the user's input. If not given, the name of the resulting location objects is not relevant. | ||
| 0:1 | siri:LocationStructure | Coordinate where to look for locations/places. If given, the result should prefer locations/place objects near to this GeoPosition. | ||
| 0:1 | Restricts the resulting location/place objects to the given geographical area. | |||
| 0:* | siri:ParticipantRefStructure | Used in distributed environments. e.g. EU-Spirit. If none is given, the location/place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location/place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
PlaceParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
InitialLocationInputStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:string | Name of the LOCATION object which is looked for. This is usually the user's input. If not given, the name of the resulting location objects is not relevant. | ||
| 0:1 | siri:LocationStructure | Coordinate where to look for locations/places. If given, the result should prefer locations/place objects near to this GeoPosition. | ||
| 0:1 | Restricts the resulting location/place objects to the given geographical area. | |||
| 0:* | siri:ParticipantRefStructure | Used in distributed environments. e.g., EU-Spirit. If none is given, the location/place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location/place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
PlaceParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
| PlaceDataFilter |
| 0:* | Allowed location/place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether location/place objects for origin, via, or destination are searched. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops. | |||
| 0:1 | xs:boolean | Tells the service to include the available public transport modes at returned stops. | ||
| 0:1 | xs:boolean | Tells the service to include the available operators at returned stops. | ||
| PlaceSorting |
| 0:1 | xs:string | If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore use with care. | |
| PlaceSorting |
| 0:1 | xs:string | If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore, use with care. | |
| 0:1 | siri:LocationStructure | WGS84 coordinates position. Locations closer to this GeoPosition are preferred. | ||
| 0:1 | xs:float | Ignore locations with a lower probability. | ||
| 0:1 | xs:anyType | |||
GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area defined by a polyline. | ||
b |
| -1:1 | Area defined by a circle. | ||
c |
| -1:1 | Area defined by a rectangle. | ||
GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | Centre position of the circle. | ||
| 1:1 | siri:DistanceType | Radius in metres. | ||
GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | Upper-left (north-west) corner of the rectangle. | ||
| 1:1 | siri:LocationStructure | Lower-right (south-east) corner of the rectangle. | ||
GeoAreaStructure
| [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE - | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Vertices of a polyline defining an area. | ||
PlaceResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this LOCATION result. | |||
| 1:1 | The Place / Location object. | |||
| 1:1 | xs:boolean | States whether the included location/place is complete or needs further refinement. Only complete locations/places are fully resolved and can be used in e.g. trip requests. Incomplete locations/places have to be refined entering them once again into a LocationInformationRequest. | ||
| 0:1 | Probability, that this result is the one meant by the user's input. Value should be between 0 and 1. | |||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Vertices of a polyline defining an area. | ||
PlaceResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this LOCATION result. | |||
| 1:1 | The Place / Location object. | |||
| 1:1 | xs:boolean | States whether the included location/place is complete or needs further refinement. Only complete locations/places are fully resolved and can be used in e.g., trip requests. Incomplete locations/places must be refined entering them once again into a LocationInformationRequest. | ||
| 0:1 | Probability, that this result is the one meant by the user's input. Value should be between 0 and 1. | |||
| 0:1 | siri:ParticipantRefStructure | Stores the system reference, where to ask for actual locations corresponding to this city name result. In order to get actual locations, a new location information request using the system ID of this result is needed. | ||
| 0:1 | List of operators operating at this place object. This list should only be filled if this is explicitly requested. | |||
PlacePolicyGroup group
| |||||
| 0:1 | siri:ParticipantRefStructure | Stores the system reference, where to ask for actual locations corresponding to this city name result. To get actual locations, a new location information request using the system ID of this result is needed. | ||
| 0:1 | List of operators operating at this place object. This list should only be filled if this is explicitly requested. | |||
PlacePolicyGroup group
| |||||
| PlacePolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g.: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response. | ||
| 0:1 | xs:nonNegativeInteger | Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response. | ||
| 0:* | If at least one is set, only location/place objects within the given localities are allowed. | |||
| 0:1 | Filter to narrow down POI searches. | |||
PlaceSortingGroup group
| |||||
| PlaceSorting |
| 0:1 | xs:string | If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore use with care. | |
| PlaceSorting |
| 0:1 | xs:string | If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore, use with care. | |
| 0:1 | siri:LocationStructure | WGS84 coordinates position. Locations closer to this GeoPosition are preferred. | ||
| 0:1 | xs:float | Ignore locations with a lower probability. | ||
ExchangePointsRequestGroup group
| |||||
| 0:* | siri:ParticipantRefStructure | One or more adjacent systems to which the exchange points should be retrieved. | ||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g. in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response. | ||
| 0:1 | xs:positiveInteger | Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g., in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response. | ||
| 0:1 | xs:nonNegativeInteger | Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response. | ||
| 0:1 | xs:anyType | |||
ExchangePointsDataFilterGroup group
| |||||
| ExchangePointsDataFilter |
| 0:* | Allowed location/place object types. If none is given, all types are allowed. | ||
| 0:* | siri:ParticipantRefStructure | One or more adjacent systems to which the exchange points should be retrieved. | ||
ExchangePointsPolicyGroup group
| |||||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g. in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response. | ||
| 0:1 | xs:positiveInteger | Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g., in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response. | ||
| 0:1 | xs:nonNegativeInteger | Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response. | ||
ExchangePointsResponseGroup group
| |||||
| ExchangePointsResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:1 | xs:nonNegativeInteger | If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. | ||
| 0:* | The exchange points found by the service. | |||
ExchangePointsResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this EXCHANGE POINTS result. | |||
| 1:1 | Place object that describes this exchange point. | |||
| 0:1 | xs:duration | Rough estimate of the travel duration from the specified reference location/place to this exchange point. | ||
| 0:1 | xs:duration | Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it has to take care, that feeding arrival and fetching departure are at least this duration apart. | ||
| 0:1 | xs:boolean | Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE. | ||
| 0:* | +Mode | List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. | ||
| 0:1 | The priority of the exchange point. 100 is the maximum. The priority can be used to select given ExchangePoints more often (e.g. because the station is a main hub). | |||
ExchangePointsResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this EXCHANGE POINTS result. | |||
| 1:1 | Place object that describes this exchange point. | |||
| 0:1 | xs:duration | Rough estimate of the travel duration from the specified reference location/place to this exchange point. | ||
| 0:1 | xs:duration | Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it must take care, that feeding arrival and fetching departure are at least this duration apart. | ||
| 0:1 | xs:boolean | Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE. | ||
| 0:* | +Mode | List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. | ||
| 0:1 | The priority of the exchange point. 100 is the maximum. The priority can be used to select given ExchangePoints more often (e.g., because the station is a main hub). | |||
| xs:normalizedString | Identifier of an Address |
| EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER | Types of problems that may be returned in responses to EXCHANGE POINTS requests |
| LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_UNSUPPORTEDSORTINGMETHOD | LOCATION_OTHER | Types of problems that may be returned in responses to LOCATION requests. |
| ObjectIdType | Type for identifier of a NeTEx Object. |
| xs:normalizedString | Identifier of a Point of Interest |
| xs:normalizedString | Identifier of a Stop Place |
| xs:normalizedString | Identifier of a TopographicPlace |
StopPointGroup group
| A stop point with id and name | ||||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 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. E.g. "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 | Name of the bay where to board/alight from the vehicle. As to the latest real-time status. | |||
StopPointStructure
| [an extended view of SCHEDULED STOP POINT in TMv6] a SCHEDULED STOP POINT extended by ACCESSIBILITY LIMITATION attributes and with identifier and name where passengers can board or alight from vehicles | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 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. E.g. "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 | Name of the bay where to board/alight from the vehicle. As to the latest real-time status. | |||
| 0:* | Code of this stop point in private/foreign/proprietary coding schemes. | |||
| 0:1 | Reference to the stop place to which this stop point belongs. | |||
0:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| StopAttributes |
| 0:1 | xs:boolean | Whether this stop is accessible for wheelchair users. | |
| 0:1 | xs:boolean | Whether this stop is lit. | ||
| StopAttributes |
| 0:1 | xs:boolean | Whether this stop is accessible for wheelchair users. | |
| 0:1 | xs:boolean | Whether this stop is lit. | ||
| 0:1 | xs:boolean | Whether this stop offers protection from weather conditions like rain, snow, storm etc. | ||
TopographicPlaceRefStructureTopographicPlaceRef
| Reference to a TopographicPlace | ||||
TopographicPlaceStructure
| [TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g. County,City, Town, Village) and of different specificity (e.g. Greater London, London, West End, Westminster, St James's). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | TopographicPlace ID. | |||
| 1:1 | Name or description of TopographicPlace for use in passenger information. | |||
| 0:* | Code of this TopographicPlace in private/foreign/proprietary coding schemes. | |||
| 0:1 | Reference to a parent TopographicPlace. | |||
| 0:1 | siri:ParticipantRefStructure | Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
| 0:1 | +Area | Area covered by the locality described as a polygon. | ||
PointOfInterestRefStructure
| Reference to a Point of Interest | ||||
PointOfInterestRef
| Reference to a Point of Interest | ||||
PointOfInterestStructure
| [corresponds to POINT OF INTEREST in TMv6 with related information] type of PLACE to or through which passengers may wish to navigate as part of their journey and which is modelled in detail by journey planners. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this Point of Interest. | |||
| 1:1 | Name or description of point of interest for use in passenger information. | |||
| 0:1 | Additional description of the point of interest that may be appended to the name if enough space is available. E.g. "Exhibition Center". | |||
| 0:* | Categories this POI is associated with. Order indicates descending relevance. | |||
| 0:* | Code of this point of interest in private/foreign/proprietary coding schemes. | |||
0:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| 0:1 | Additional information for this POI (e.g. information on available parking slots, charging infrastructure, sharing vehicles). | |||
PointOfInterestCategoryStructure
| [a view of POINT OF INTEREST CLASSIFICATION in TMv6] categorisation of POINTs OF INTEREST in respect of the activities undertaken at them (defined by key-value-pairs). | ||||
The element contains one of the following elements: | |||||
a |
| -1:* | OpenStreetMap tag structure (key-value) | ||
b |
| -1:* | xs:string | Classification of the POI (when it is not from OSM). The codification of the classification Id may include de codification source (for example "IGN:[classificationCode]") | |
PointOfInterestAdditionalInformationStructure
| Generic structure for additional information on POIs. | ||||
The element contains only one element: | |||||
| 1:* | POI additional information is a set of key/value pairs that are associated with defined categories. | |||
CategoryKeyValueType
| Category Key Value triplets. Category can be empty. Several such elements form the information necessary for a given category. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:string | |||
| 1:1 | xs:string | |||
| 1:1 | xs:string | |||
OsmTagStructure
| Structure of an OpenStreetMap tag. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Name of OpenStreetMap tag (amenity, leisure, tourism, bike, ...) | ||
| 1:1 | xs:NMTOKEN | Value for OpenStreetMap tag (charging_station, hostel, yes, ...) | ||
PointOfInterestFilterStructure
| Filter POIs by category. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether categories in list are to include or exclude from search. Default is FALSE. | ||
| 0:* | These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE). | |||
AddressRefStructure
| Reference to an Address | ||||
AddressRef
| Reference to an Address | ||||
AddressDetailGroup group
| An address with its name entities | ||||
TopographicPlaceRefStructureTopographicPlaceRef
| Reference to a TopographicPlace | ||||
TopographicPlaceStructure
| [TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g., County,City, Town, Village) and of different specificity (e.g., Greater London, London, West End, Westminster, St James's). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | TopographicPlace ID. | |||
| 1:1 | Name or description of TopographicPlace for use in passenger information. | |||
| 0:* | Code of this TopographicPlace in private/foreign/proprietary coding schemes. | |||
| 0:1 | Reference to a parent TopographicPlace. | |||
| 0:1 | siri:ParticipantRefStructure | Used in distributed environments (e.g., EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in a distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
| 0:1 | +Area | Area covered by the locality described as a polygon. | ||
PointOfInterestRefStructure
| Reference to a Point of Interest | ||||
PointOfInterestRef
| Reference to a Point of Interest | ||||
PointOfInterestStructure
| [corresponds to POINT OF INTEREST in TMv6 with related information] type of PLACE to or through which passengers may wish to navigate as part of their journey and which is modelled in detail by journey planners. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this Point of Interest. | |||
| 1:1 | Name or description of point of interest for use in passenger information. | |||
| 0:1 | Additional description of the point of interest that may be appended to the name if enough space is available. E.g. "Exhibition Center". | |||
| 0:* | Categories this POI is associated with. Order indicates descending relevance. | |||
| 0:* | Code of this point of interest in private/foreign/proprietary coding schemes. | |||
0:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| 0:1 | Additional information for this POI (e.g., information on available parking slots, charging infrastructure, sharing vehicles). | |||
PointOfInterestCategoryStructure
| [a view of POINT OF INTEREST CLASSIFICATION in TMv6] categorisation of POINTs OF INTEREST in respect of the activities undertaken at them (defined by key-value-pairs). | ||||
The element contains one of the following elements: | |||||
a |
| -1:* | OpenStreetMap tag structure (key-value) | ||
b |
| -1:* | xs:string | Classification of the POI (when it is not from OSM). The codification of the classification Id may include de codification source (for example "IGN:[classificationCode]") | |
PointOfInterestAdditionalInformationStructure
| Generic structure for additional information on POIs. | ||||
The element contains only one element: | |||||
| 1:* | POI additional information is a set of key/value pairs that are associated with defined categories. | |||
CategoryKeyValueType
| Category Key Value triplets. Category can be empty. Several such elements form the information necessary for a given category. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:string | |||
| 1:1 | xs:string | |||
| 1:1 | xs:string | |||
OsmTagStructure
| Structure of an OpenStreetMap tag. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Name of OpenStreetMap tag (amenity, leisure, tourism, bike, ...) | ||
| 1:1 | xs:NMTOKEN | Value for OpenStreetMap tag (charging_station, hostel, yes, ...) | ||
PointOfInterestFilterStructure
| Filter POIs by category. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether categories in list are to include or exclude from search. Default is FALSE. | ||
| 0:* | These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE). | |||
AddressRefStructure
| Reference to an Address | ||||
AddressRef
| Reference to an Address | ||||
AddressDetailGroup group
| An address with its name entities | ||||
| AddressDetail |
| 0:1 | xs:string | Country of the address. | |
| 0:1 | xs:string | Postal code of the address. | ||
| 0:1 | xs:string | TopographicPlace name of the address. If set it should at least contain the city name. | ||
| 0:1 | xs:string | Street name of the address. | ||
| 0:1 | xs:string | House number of the address. If none is given, either a crossing street can be given, or the whole street is meant. | ||
| 0:1 | xs:string | Crossing. This can be used to be more specific without using house numbers. | ||
PlaceStructure
| geographic PLACE of any type which may be specified as the origin or destination of a trip | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Model of an address | ||
b |
| -1:1 | Model of a POI | ||
c |
| -1:1 | Model of a stop place | ||
d |
| -1:1 | Model of a stop point | ||
e |
| -1:1 | TopographicPlace. Region, village, or city. | ||
| 1:1 | Public name of the place. | |||
| 1:1 | siri:LocationStructure | Position using WGS84/EPSG:4326 coordinates. | ||
| 0:* | +Mode | List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. | ||
| 0:1 | Access modes that are supported by this place. | |||
| 0:1 | SITUATION reference. Mostly used for STOP PLACE, SCHEDULED STOP POINT (StopPoint). However, in future a situation reference may occur on many geographic elements (e.g. roads) as well. | |||
| 0:* | Attributes associated with this place. This is used, e.g., for details, OSM attributes oder key/value descriptions. Most of them will be implementation dependend (except OSM). From Transmodel, TYPE OF POINT might be a possible attribute. | |||
| 0:1 | xs:anyType | |||
PlaceRefStructure
| Reference to a geographic PLACE of any type which may be specified as the origin or destination of a trip. | ||||
The element contains only one element: | |||||
PlaceStructure
| geographic PLACE of any type which may be specified as the origin or destination of a trip | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Model of an address | ||
b |
| -1:1 | Model of a POI | ||
c |
| -1:1 | Model of a stop place | ||
d |
| -1:1 | Model of a stop point | ||
e |
| -1:1 | TopographicPlace. Region, village, or city. | ||
| 1:1 | Public name of the place. | |||
| 1:1 | siri:LocationStructure | Position using WGS84/EPSG:4326 coordinates. | ||
| 0:* | +Mode | List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. | ||
| 0:1 | Access modes that are supported by this place. | |||
| 0:1 | SITUATION reference. Mostly used for STOP PLACE, SCHEDULED STOP POINT (StopPoint). However, in future a situation reference may occur on many geographic elements (e.g., roads) as well. | |||
| 0:* | Attributes associated with this place. This is used, e.g., for details, OSM attributes or key/value descriptions. Most of them will be implementation dependent (except OSM). From Transmodel, TYPE OF POINT might be an attribute. | |||
| 0:1 | xs:anyType | |||
PlaceRefStructure
| Reference to a geographic PLACE of any type which may be specified as the origin or destination of a trip. | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
| PlaceRef | a |
| -1:1 | →siri:StopPointRef | Reference to a stop point. |
b | -1:1 | Reference to a Stop Place | |||
c | -1:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | |||
d | -1:1 | Reference to a Point of Interest | |||
e | -1:1 | Reference to an Address | |||
f |
| -1:1 | siri:LocationStructure | WGS84 coordinates position. | |
| 1:1 | Public name of the place. | |||
| 0:* | xs:normalizedString | Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
| 0:* | xs:normalizedString | Used in distributed environments. e.g., EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
PlaceRefGroup group
| Group for reference to a geographic PLACE of any type which may be specified as the origin or destination of a trip. | ||||
The element contains one of the following elements: | |||||
| PlaceRef | a |
| -1:1 | →siri:StopPointRef | Reference to a stop point. |
b | -1:1 | Reference to a Stop Place | |||
c | -1:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | |||
d | -1:1 | Reference to a Point of Interest | |||
e | -1:1 | Reference to an Address | |||
f |
| -1:1 | siri:LocationStructure | WGS84 coordinates position. | |
| 1:1 | Public name of the place. | |||
| 0:* | xs:normalizedString | Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
| 0:* | xs:normalizedString | Used in distributed environments. e.g., EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
LocationProblemType
| LocationProblemType (↔ ErrorType) | ||||
ExchangePointsProblemType
| ExchangePointsProblemType (↔ ErrorType) | ||||
| local | no | down | all | Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided (if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/StopPlaces in the hierarchy, if - such a hierarchy exists. "all" does include all StopPoints/StopPlaces for the meta station, if it is known. How + such a hierarchy exists. "all" does include all StopPoints/StopPlaces for the meta station if it is known. How to use this: if you indicate the reference to a train station and the parameter is set to "down", the departures/ arrivals at the associated bus stations will show as well. If you have the ScheduledStopPoint of platform B of the local bus and it is associated with 3 other stations, you will get all these arrivals/departures as well, @@ -602,15 +602,15 @@ OJP - Open API for distributed Journey
0:1 xs:boolean Whether operating day information of this stop event should be included in the response.
0:1 Whether real-time information of this stop event should be used in the response. Default is "full"
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
0:1 xs:boolean Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true
0:1 Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided (if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/ StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces - for the meta station, if it is known. How to use this: if you indicate the reference to a train station + for the meta station if it is known. How to use this: if you indicate the reference to a train station and the parameter is set to "down", the departures/arrivals at the associated bus stations will show as well. If you have the ScheduledStopPoint of platform B of the local bus and it is associated with 3 other - stations, you will get all these arrivals/departures as well, if the parameter is set to "all". + stations, you will get all these arrivals/departures as well if the parameter is set to "all".
0:1 xs:anyType | ||||||||||||||||||||||||||||||||||||
StopEventDataFilterGroup group
| Request data filters | ||||
| StopEventDataFilter |
| 0:1 | MODEs to be excluded or included in stop events. We on purpose don't use ModeOfOperationFilter in the stop event service. | ||
| 0:1 | xs:boolean | Whether operating day information of this stop event should be included in the response. | ||
| 0:1 | Whether real-time information of this stop event should be used in the response. Default is "full" | |||
| 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 | ||
| 0:1 | xs:boolean | Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true | ||
| 0:1 | Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided (if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/ StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces - for the meta station, if it is known. How to use this: if you indicate the reference to a train station + for the meta station if it is known. How to use this: if you indicate the reference to a train station and the parameter is set to "down", the departures/arrivals at the associated bus stations will show as well. If you have the ScheduledStopPoint of platform B of the local bus and it is associated with 3 other - stations, you will get all these arrivals/departures as well, if the parameter is set to "all". + stations, you will get all these arrivals/departures as well if the parameter is set to "all". | |||
StopEventResponseGroup group
| Response structure for departure and arrival events at stops | ||||
| StopEventResponse |
| 0:1 | Container for data that is referenced multiple times. | ||
| 0:* | Enclosing element for stop event data. | |||
StopEventResultStructure
| Wrapper element for a single stop event result. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this result. | |||
| 0:* | Problems related to this STOPEVENT result. | |||
| 1:1 | Stop event data element. | |||
StopEventStructure
| Stop event structure. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Calls at stops that happen before this stop event (service pattern of this vehicle journey before this stop event). | |||
| 1:1 | The call of this vehicle journey at this stop. | |||
| 0:* | Calls at stops that happen after this stop event (rest of the service pattern of the vehicle journey). | |||
| 1:1 | Service that calls at this stop. | |||
| 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". | |||
| 0:1 | For SITUATIONs that affect the whole StopEvent. Otherwise References for SITUATIONs can be added at the different CALL elements | |||
| 0:1 | xs:anyType | |||
CallAtNearStopStructure
| indication of the walk distance and time to a nearby stop where relevant. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | [same as CALL in SIRI] the meeting of a VEHICLE JOURNEY with a specific SCHEDULED STOP POINT . | |||
| 0:1 | siri:DistanceType | Distance from request LOCATION / PLACE (e.g. address) to this stop in metres. | ||
| 0:1 | xs:duration | Walking duration from request LOCATION / PLACE (e.g. address) to this stop. All user options taken into account (e.g. walk speed). | ||
StopEventProblemType
| StopEventProblemType (↔ ErrorType) | ||||
OperatingDaysDescription
0:1
Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays".
SituationFullRefs
0:1
For SITUATIONs that affect the whole StopEvent. Otherwise References for SITUATIONs can be added at the different CALL elements
Extension
0:1
xs:anyType
CallAtNearStopStructure
| indication of the walk distance and time to a nearby stop where relevant. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | [same as CALL in SIRI] the meeting of a VEHICLE JOURNEY with a specific SCHEDULED STOP POINT. | |||
| 0:1 | siri:DistanceType | Distance from request LOCATION / PLACE (e.g., address) to this stop in metres. | ||
| 0:1 | xs:duration | Walking duration from request LOCATION / PLACE (e.g., address) to this stop. All user options considered (e.g., walk speed). | ||
StopEventProblemType
| StopEventProblemType (↔ ErrorType) | ||||
| none | vehiclefeature | full | Possible values how to include formations in the basic filters |
| TRIPINFO_JOURNEYREFUNKNOWN | TRIPINFO_VEHICLEUNKNOWN | TRIPINFO_NOJOURNEYFOUND | TRIPINFO_NOGEOINFO | TRIPINFO_NOREALTIME | TRIPINFO_OTHER | Types of problems that may be returned in responses to TripInfo requests. |
TripInfoRequestGroup group
| TripInfo request structure. | ||||
The element contains one of the following elements: | |||||
| DatedJourneyRef | a | 1:1 | Reference to a Journey | ||
TripInfoResponseGroup group
| TripInfo response structure. | ||||
| TripInfoResponse |
| 0:1 | Response context. | ||
| 0:1 | Result structure. | |||
TripInfoResultStructure
| TripInfo result structure containing the current status of a trip. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this TripInfo result. | |||
| 0:* | The stops this service already has called at. Including the current stop if service is currently at stop. | |||
| 0:1 | Current position of this service. | |||
| 0:* | The stops this service still has to call at. | |||
| 0:1 | Description of the service. | |||
TripInfoResultStructure
| TripInfo result structure containing the status of a trip. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this TripInfo result. | |||
| 0:* | The stops this service already has called at. Including the current stop if service is currently at stop. | |||
| 0:1 | Current position of this service. | |||
| 0:* | The stops this service still has to call at. | |||
| 0:1 | Description of the service. | |||
| 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". | |||
| 0:1 | Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays". | |||
| |||||
| 0:1 | Geographic embedding of this journey. The entire journey is regarded as one leg. | |||
| 0:1 | xs:anyType | |||
TripInfoProblemType
| TripInfoProblemType (↔ ErrorType) | ||||
| unknown | available | partiallyAvailable | notAvailable | Allowed values for status of the access feature. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown | Allowed values for a AccessFeature. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator | Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extendToFront | extendToBack | Prefer earlier or later times. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| allAccessFeaturesAvailable | accessFeatureNotAvailable | accessFeaturePartiallyAvailable | accessFeatureWithUnknownAvailability | seeSituations | Allowed values for the feasibility of a TRIP or part of a TRIP. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| origin | destination | continue | keep | turn | leave | enter | enter_roundabout | stay_in_roundabout | leave_roundabout | enter_builtup_area | leave_builtup_area | freewayAccessRamp | unknown_lane_choice | left_lane | middle_lane | right_lane | unknown_turning_kind | Various types of guidance advice given to traveller. Suitable values may differ by MODE (e.g. a car driver needs different advice than a person walking for a transfer. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ObjectIdType | Type for identifier of a NeTEx Object. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ObjectIdType | Type for identifier of a NeTEx Object. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| anyPoint | eachOrigin | eachDestination | eachOriginDestination | somePoints | How the multiple origin/destination points should be considered. - Note: Unfortunately this element was underdefined before and this resulted in different implementations. + 11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning11.1. Simple type definitions
11.2. The | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Trip request structure. | ||||
| fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | minNonLevelEntrances | minStairs | bestForVisualImpairment | bestForAuditoryImpairment | environmentalSafety | extraSafe | extraReliable | scenic | quietTravel | The types of algorithms that can be used for planning a journey (fastest, least walking, etc.). Only one method can be used. Each one really is a whole set of a policy, which is defined below. E.g., fastest also includes least transfers as a second criteria, some modes are excluded usually by default. Implementations might differ (slightly). Also, some strategies might not be implemented. The most important strategies are marked. | |||
| up | down | level | upAndDown | downAndUp | Transition types for interchanges. | |||
| TRIPCHANGE_NOLATERTRIPFOUND | TRIPCHANGE_NOEARLIERTRIPFOUND | TRIPCHANGE_INVALIDLEGREF | TRIPCHANGE_INVALIDOPERATOR | TRIPCHANGE_NOVEHICLEAVAILABLE | TRIPCHANGE_OTHER | Types of problems that may be returned in responses to TRIPCHANGE requests. | |||
| ObjectIdType | Type for identifier of a TRIP Object. | |||
| TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_TIMEWINDOWTOOLARGE | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_RESTRICTEDRESULTSDROPPED | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_MULTIPOINT_TYPE_NOT_SUPPORTED | TRIP_REFINE_LEG_UNKNOWN | REFINE_OBJECTNOTFOUND | REFINE_PROFILENOTSUPPORTED | TRIP_OTHER | Types of problems that may be returned in responses to Trip requests. | |||
| ObjectIdType | Type for identifier of a NeTEx Object. | |||
| straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action | The range of possible turns that can be described. | |||
TripRequestGroup group
| Trip request structure. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 1:* | Specifies the destination situation where the user is heading to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. @@ -710,7 +710,7 @@ OJP - Open API for distributed Journey BaseTripMobilityFilter |
0:1 xs:boolean The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded.
0:1 xs:boolean The user is not able to walk up/down stairs.
0:1 xs:boolean The user is not able to walk up/downstairs.
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 a ramp. OJP - Open API for distributed Journey TripMobilityFilter |
0:1 xs:boolean The user wants to carry a bike on public transport (could be extended in future to transporting big luggage/animals/etc).
0:1 Deviation from average walking speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.
0:1 xs:duration Additional time added to all transfers (also to transfers between individual to public transport, not modeled in Transmodel).
0:1 Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen
0:1 xs:duration Additional time added to all transfers (also to transfers between individual to public transport, not modelled in Transmodel).
0:1 Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen OJP - Open API for distributed Journey Then, the element contains one of the following elements: NumberOfResults | a
0:1 xs:nonNegativeInteger The desired number of trip results before the given time (at origin or destination). a
0: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 (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them. BaseTripPolicy | b
-0:1 xs:positiveInteger The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementations will deliver one of the TripResults before the indicated departure time. This means one always must check the results against the parameters before using them.
0:1 xs:duration Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.
0:1 The way real-time data should be used in the calculation of the trip.
0:1 xs:boolean Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE.
0:1 xs:boolean Whether the trip calculation should find a solution that starts immediately (e.g., because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE.
0:1 xs:nonNegativeInteger The maximum number of interchanges the user will accept per trip.
0:1 The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.).
0:1 xs:boolean Whether the trip calculation should take elevation data into account (bike, foot). Default is FALSE.
0:1 xs:boolean There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router, irrespective of the selected passenger categories or the MotorisedMainTravelMode. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.
0:* Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory. Then, the element contains one of the following elements: The element contains a sequence of the following elements: TripPolicy |
-0:* For each MODE or MODE OF OPERATION combination in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.
-0:1 xs:boolean Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. b
-0:1 xs:boolean The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads. Then, the element contains one of the following elements: The element contains a sequence of the following elements: TripPolicy |
-0:* For each MODE or MODE OF OPERATION combination in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.
-0:1 xs:boolean Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. b
-0:1 xs:boolean The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g., because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads. BaseTripContentFilter |
0:1 xs:boolean Whether the result should include TrackSection elements to describe the geographic route of each journey leg. OJP - Open API for distributed Journey
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 the access features (stairs, elevator, etc.) on each path link.
0:1 xs:boolean Whether the result should include real time status of access features to indicate broken equipment.
0:* Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired).
0:* Which accessibility features and other accessibility-related information to retrieve (e.g., guidance text for the visually impaired).
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
0:1 xs:boolean Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true. TripContentFilter |
0:1 xs:boolean Whether the result should include intermediate stops (between the passenger's board and alight stops).
0:1 xs:boolean Whether the result should include fare information.
0:1 xs:boolean Whether the result should include operating day information - as encoded bit string and in natural language.
0:1 xs:boolean If true, then the response will contain only summaries of the found trips. Default is false.
0:1 Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup).
0:1 xs:anyType | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TripDataFilterGroup group
| Data to be included/excluded from search, e.g. modes, operators (Transmodel: TRIP REQUEST FILTER). | ||||
| 0:1 | Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). | |||
| 0:1 | xs:anyType | |||
TripDataFilterGroup group
| Data to be included/excluded from search, e.g., modes, operators (Transmodel: TRIP REQUEST FILTER). | ||||
| TripDataFilter |
| 0:* | MODEs and MODEs OF OPERATION to be considered in trip calculation. If only MODE is used, then it is for all MODE OF OPERATION. If combinations of MODE and MODE OF OPERATION are used (multiples), then all combinations are to be considered. | ||
| 0:1 | Lines/Directions to include/exclude. | |||
| 0:1 | Transport operators to include/exclude. | |||
The element contains one of the following elements: | |||||
| NumberOfResults | a |
| 0:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 0: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 (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementations will deliver one of the TripResults before the indicated departure time. This means one always must check the results against the parameters before using them. |
| 0:1 | xs:duration | Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation. | ||
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g., because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
| 0:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | |||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, foot). Default is FALSE. | ||
| 0:1 | xs:boolean | There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router, irrespective of the selected passenger categories or the MotorisedMainTravelMode. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed. | ||
| 0:* | Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory. | |||
The element contains one of the following elements: | |||||
The element contains a sequence of the following elements: | |||||
| TripPolicy |
| -0:* | For each MODE or MODE OF OPERATION combination in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | ||
| -0:1 | xs:boolean | Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. | ||
b |
| -0:1 | xs:boolean | The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads. | |
The element contains one of the following elements: | |||||
The element contains a sequence of the following elements: | |||||
| TripPolicy |
| -0:* | For each MODE or MODE OF OPERATION combination in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | ||
| -0:1 | xs:boolean | Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. | ||
b |
| -0:1 | xs:boolean | The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g., because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads. | |
TripMobilityFilterGroup group
| Parameters the user can set to restrict the mobility options - particularly for interchanging. | ||||
| BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to walk up/downstairs. | ||
| 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 a ramp. | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport (could be extended in future to transporting big luggage/animals/etc). | |
| 0:1 | Deviation from average walking speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modeled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modelled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 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 the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g., guidance text for the visually impaired). | |||
| 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 | ||
| 0:1 | xs:boolean | Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true. | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
NotViaStructure
| Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | Reference to a not-via stop point. | |
b | -1:1 | Reference to a not-via stop place. | |||
NoChangeAtStructure
| No-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | Reference to a no-change stop point. | |
b | -1:1 | Reference to a no-change stop place. | |||
TariffzoneFilterStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether to include or exclude given tariff zones in the list from the search. Default is to include. | ||
| 1:1 | List of fare zones to include or exclude. | |||
TripResponseGroup group
| Trip response structure. | ||||
| TripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. | |||
TripResultStructure
| Structure for a single trip result and associated problems. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip result for referencing purposes. Unique within trip response. | |||
| 0:* | Problems related to this Trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Detailed information on trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* | Fare and fare product information for this trip as a whole or parts of it. | |||
| 0:1 | xs:boolean | When the result is an alternative option from IncludeAlternativeOptions, then the flag should be set to true. If it is an alternative option this means that the server decided to add this result for its own reasons: e.g. to push a certain trip leg, because it believes that it might better suit at least some possible customers. Such options are not an optimal fit to the criteria that were in the request. The client may therefore disregard such results depending on the use case. | ||
TripSummaryStructure
| Structure for trip overview information (only implementation related and therefore not modeled in Transmodel). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip for referencing purposes. Unique within trip response. | |||
| 0:1 | Describes the origin situation of this trip. | |||
| 0:1 | Describes the arrival situation of this trip. | |||
| 0:1 | xs:duration | Overall duration of the trip (TRIP attribute, not detailed in Transmodel, available from constituing LEGs). | ||
| 0:1 | xs:dateTime | Departure time at origin (TRIP attribute, not detailed in Transmodel, available from constituing LEGs). | ||
| 0:1 | xs:dateTime | Arrival time at destination (TRIP attribute, not detailed in Transmodel, available from constituing LEGs). | ||
| 0:1 | xs:nonNegativeInteger | Number of public transport legs. | ||
| 0:1 | siri:DistanceType | Trip distance (TRIP attribute, not detailed in Transmodel, available from constituing LEGs). | ||
TripResultStructure
| Structure for a single trip result and associated problems. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip result for referencing purposes. Unique within trip response. | |||
| 0:* | Problems related to this Trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Detailed information on trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* | Fare and fare product information for this trip as a whole or parts of it. | |||
| 0:1 | xs:boolean | When the result is an alternative option from IncludeAlternativeOptions, then the flag should be set to true. If it is an alternative option this means that the server decided to add this result for its own reasons: e.g., to push a certain trip leg, because it believes that it might better suit at least some possible customers. Such options are not an optimal fit to the criteria that were in the request. The client may therefore disregard such results depending on the use case. | ||
TripSummaryStructure
| Structure for trip overview information (only implementation related and therefore not modelled in Transmodel). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip for referencing purposes. Unique within trip response. | |||
| 0:1 | Describes the origin situation of this trip. | |||
| 0:1 | Describes the arrival situation of this trip. | |||
| 0:1 | xs:duration | Overall duration of the trip (TRIP attribute, not detailed in Transmodel, available from constituting LEGs). | ||
| 0:1 | xs:dateTime | Departure time at origin (TRIP attribute, not detailed in Transmodel, available from constituting LEGs). | ||
| 0:1 | xs:dateTime | Arrival time at destination (TRIP attribute, not detailed in Transmodel, available from constituting LEGs). | ||
| 0:1 | xs:nonNegativeInteger | Number of public transport legs. | ||
| 0:1 | siri:DistanceType | Trip distance (TRIP attribute, not detailed in Transmodel, available from constituting LEGs). | ||
| 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". | |||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripStructure
| [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more LEGs | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip for referencing purposes. Unique within trip response. | |||
| 1:1 | xs:duration | Overall duration of the trip (TRIP attribute, not detailed in Transmodel, available from constituing LEGs). | ||
| 1:1 | xs:dateTime | Departure time at origin (TRIP attribute, not detailed in Transmodel, available from constituing LEGs). | ||
| 1:1 | xs:dateTime | Arrival time at destination (TRIP attribute, not detailed in Transmodel, available from constituing LEGs). | ||
| 1:1 | xs:nonNegativeInteger | Number of interchanges. | ||
| 0:1 | siri:DistanceType | Trip distance (TRIP attribute, not detailed in Transmodel, available from constituing LEGs). | ||
| 1:* | +Leg | Legs of the trip (Transmodel: LEG or MONITORED LEG). Note: There is always a TransferLeg between two TimedLegs. There can be a TransferLeg between two ContinuousLegs (e.g. because some special time consuming action is necessary like a car hire). There can be a TransferLeg between a ContinuousLeg and a TimedLeg for the same reason. There aren't two consecutive TransferLegs. | ||
| 0:1 | Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays". | |||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripStructure
| [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more LEGs | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip for referencing purposes. Unique within trip response. | |||
| 1:1 | xs:duration | Overall duration of the trip (TRIP attribute, not detailed in Transmodel, available from constituting LEGs). | ||
| 1:1 | xs:dateTime | Departure time at origin (TRIP attribute, not detailed in Transmodel, available from constituting LEGs). | ||
| 1:1 | xs:dateTime | Arrival time at destination (TRIP attribute, not detailed in Transmodel, available from constituting LEGs). | ||
| 1:1 | xs:nonNegativeInteger | Number of interchanges. | ||
| 0:1 | siri:DistanceType | Trip distance (TRIP attribute, not detailed in Transmodel, available from constituting LEGs). | ||
| 1:* | +Leg | Legs of the trip (Transmodel: LEG or MONITORED LEG). Note: There is always a TransferLeg between two TimedLegs. There can be a TransferLeg between two ContinuousLegs (e.g., because some special time consuming action is necessary like a car hire). There can be a TransferLeg between a ContinuousLeg and a TimedLeg for the same reason. There aren't two consecutive TransferLegs. | ||
| 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". | |||
| 0:1 | Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays". | |||
| TripStatus |
| 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 | xs:boolean | Whether this trip is delayed. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false. | ||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
LegStructure
| A single stage of a TRIP that is made without change of MODE or service (ie: between each interchange). Implements LEG from TM 6.2. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this leg. Unique within trip result. | |||
| 0:1 | siri:ParticipantRefStructure | [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s) | ||
| 0:1 | xs:duration | The duration of the LEG (e.g. from Transmodel PT RIDE LEG.Duration). | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | A specialised type of RIDE LEG in with Timed=false, a PERSONAL LEG or an ACCESS LEG TM 6 and NeTEx. LEG of a TRIP that is not bound to a timetable. | ||
b |
| -1:1 | Corresponds to a RIDE or PT RIDE LEG in TM 6.2 with the attribute Timed (with related information). Passenger LEG with timetabled schedule. | ||
c |
| -1:1 | TRANSFER LEG or CONNECTION LEG according to TM 6.2. Description of a LEG which links other LEGs where a TRANSFER or CONNECTION between different LOCATIONs is required. | ||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
LegStructure
| A single stage of a TRIP that is made without change of MODE or service (e.g., between each interchange). Implements LEG from TM 6.2. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this leg. Unique within trip result. | |||
| 0:1 | siri:ParticipantRefStructure | [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s) | ||
| 0:1 | xs:duration | The duration of the LEG (e.g., from Transmodel PT RIDE LEG.Duration). | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | A specialised type of RIDE LEG in with Timed=false, a PERSONAL LEG or an ACCESS LEG TM 6 and NeTEx. LEG of a TRIP that is not bound to a timetable. | ||
b |
| -1:1 | Corresponds to a RIDE or PT RIDE LEG in TM 6.2 with the attribute Timed (with related information). Passenger LEG with timetabled schedule. | ||
c |
| -1:1 | TRANSFER LEG or CONNECTION LEG according to TM 6.2. Description of a LEG which links other LEGs where a TRANSFER or CONNECTION between different LOCATIONs is required. | ||
| Sustainability |
| 0:1 | Estimation of CO2 emissions. | ||
| 0:1 | xs:boolean | TRUE if leg got changed by TripChange-Request. | ||
TimedLegStructure
| Corresponds to a RIDE or PT RIDE LEG in TM 6.2 with the attribute Timed (with related information). Passenger LEG with timetabled schedule. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 0:* | Information about the intermediate passed stop points. | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service that is used for this leg. | |||
| 0:* | Attributes that are not valid on the whole service, but only on parts of the journey leg. | |||
| 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". | |||
| 0:1 | Geographic embedding of this leg. | |||
| 0:* | Services running combined with at least parts of this journey, e.g. wing trains. The contained stop sequence interval refers to the original journey. | |||
| 0:1 | Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays". | |||
| 0:1 | Geographic embedding of this leg. | |||
| 0:* | Services running combined with at least parts of this journey, e.g., wing trains. The contained stop sequence interval refers to the original journey. | |||
| Sustainability |
| 0:1 | Estimation of CO2 emissions. | ||
| 0:1 | xs:anyType | |||
TransferLegStructure
| TRANSFER LEG or CONNECTION LEG according to TM 6.2. Description of a LEG which links other LEGs where a TRANSFER or CONNECTION between different LOCATIONs is required. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | TYPE that is used for this interchange between public services (TYPE OF TRANSFER, but also ACCESS MODE and PERSONAL MODE as far as a TRANSFER is concerned). In some constellations multiple TransferType are possible. | |||
| 1:1 | Stop/Station/Place where boarding is done (can be a PLACE, SCHEDULED STOP POINT or a VEHICLE MEETING POINT) | |||
| 1:1 | Stop/Station/Place to alight (can be a PLACE, SCHEDULED STOP POINT or a VEHICLE MEETING POINT). | |||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
| TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange (Transmodel: PT CONNECTION LEG.MEAN INTERCHANGE TIME). | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration (in Transmodel might be modeled as TRANSFER.CONNECTION.DefaultDuration). | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, e.g. check in/out times, sometimes are mandatory for using certain services as e.g. airplanes, ferries or highspeed trains. | ||
| 0:1 | xs:duration | Walk time as part of the overall interchange duration (in Transmodel might be modelled as TRANSFER.CONNECTION.DefaultDuration). | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, e.g., check in/out times, sometimes are mandatory for using certain services as e.g., airplanes, ferries or highspeed trains. | ||
| Interchange |
| 0:1 | siri:InterchangeRefStructure | Reference of an INTERCHANGE. | |
| 0:1 | xs:boolean | Whether this interchange is an addition to the plan. Can only be used when both participants recognise the same schedule version. If omitted, defaults to 'false': the interchange is not an addition. (since SIRI 2.1) | ||
| 0:1 | xs:dateTime | Time at which window ends. | ||
| 1:1 | xs:duration | Duration of this leg according to user preferences like walking speed. | ||
| 0:1 | Title or summary of this leg for overview. | |||
| 0:1 | Length of the leg. | |||
| 0:1 | Detailed description of each element of this leg including geometric projection. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility (LEG.PATH GUIDANCE). | |||
| 0:* | Information about the feasibility of the ContinuousLeg, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| Sustainability |
| 0:1 | Estimation of CO2 emissions. | ||
| 0:1 | xs:anyType | |||
LegBoardStructure
| Describes the the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information. | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| 0:1 | xs:anyType | |||
LegBoardStructure
| Describes the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information. | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| StopPoint | a |
| 1:1 | →siri:StopPointRef | Reference to a stop point. |
a |
| 1:1 | Name or description of stop point for use in passenger information. | ||
a |
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. E.g. "opposite main entrance". | ||
a |
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | ||
a |
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest realtime status. | ||
b |
| -1:1 | siri:LocationStructure | ||
| 0:1 | Contains ARRIVAL times (timetable, recorded, estimated, timing bands estimated) and the ARRIVAL formation. | |||
| 1:1 | Contains DEPARTURE times (timetable, recorded, estimated, timing bands estimated) and the DEPARTURE formation. | |||
| 0:1 | xs:normalizedString | Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
a |
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest real-time status. | ||
b |
| -1:1 | siri:LocationStructure | ||
| 0:1 | Contains ARRIVAL times (timetable, recorded, estimated, timing bands estimated) and the ARRIVAL formation. | |||
| 1:1 | Contains DEPARTURE times (timetable, recorded, estimated, timing bands estimated) and the DEPARTURE formation. | |||
| 0:1 | xs:normalizedString | Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g., EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| 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. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly show elements that are important for accessibility. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly shows elements that are important for accessibility. | ||
| 0:* | Note or attribute. | |||
LegAlightStructure
| Describes the situation at a stop or station at which the passenger alights from a Leg of a trip including time-related information | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 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. E.g. "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. | |||
| 1:1 | describes the arrival situation at the leg alight stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | describes the departure situation at this leg alight stop point (empty for last leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:normalizedString | Interchange identifier of the feeding line/service at its alighting. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scenario (aka "line id"). See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest real-time status. | |||
| 1:1 | describes the arrival situation at the leg alight stop point (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | describes the departure situation at this leg alight stop point (empty for last leg) (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:normalizedString | Interchange identifier of the feeding line/service at its alighting. This is not a reference. This identifier is used to recognize in a distributed environment (e.g., EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scenario (aka "line id"). See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| 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. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly show elements that are important for accessibility. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly shows elements that are important for accessibility. | ||
| 0:* | Note or attribute. | |||
LegIntermediateStructure
| Describes the situation at a stop or station that lies between the LegBoard and LegAlight stop or station including time-related information. | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 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. E.g. "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. | |||
| 1:1 | describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 1:1 | describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest real-time status. | |||
| 1:1 | describes the arrival situation at this leg board stop point (empty for first leg) (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 1:1 | describes the departure situation at this leg board stop point (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| 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. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly show elements that are important for accessibility. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly shows elements that are important for accessibility. | ||
| 0:* | Note or attribute. | |||
PathGuidanceStructure
| Description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information. | ||||
The element contains only one element: | |||||
| 1:* | A view of LEG TRACK including PATH JUNCTION information, PATH LINK information and PATH GUIDANCE. One or more path guidance sections that form the LEG. For a good PATH GUIDANCE a fine granularity of the sections may be needed. This may also depend on the MODE and the type of guidance required. | |||
PathGuidanceSectionStructure
| An extended definition of a NAVIGATION PATH in TMv6 and PATH GUIDANCE to include the textual navigation instructions. Description of a part of a TRIP. May include geographic information, turn instructions and accessibility information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | An aggregate of information that may be leaning on LEG TRACK together with duration and length that can be used for representing the leg on a map. The points may be STOP PLACE, SCHEDULED STOP POINT, coordinates or ADDRESSes. | |||
| 0:1 | Textual description of a traveller manoeuvre. Contains information from manoeuvre, TurnAction, and TrackSection.RoadName. | |||
| 0:1 | Various types of guidance advice given to traveller (according to Transmodel a view of a LEG TRACK and PATH GUIDANCE). | |||
| 0:1 | The range of possible turns that can be described (according to Transmodel a view of a LEG TRACK and PATH GUIDANCE). | |||
| 0:1 | Road name | |||
| 0:* | Signs, roads, POI to follow. | |||
| 0:1 | Textual direction hint for better understanding, e.g. "follow signs to Hamburg" (according to Transmodel a view of a LEG TRACK and PATH GUIDANCE). | |||
| 0:1 | siri:AbsoluteBearingType | Absolute bearing (sky direction) after the described manoeuvre. | ||
| 0:1 | Description of the type of accessibility on this navigation section. This view is simplified in comparison to the NeTEx PathLink structure. | |||
| 0:1 | A list of references to SITUATIONs. | |||
FollowStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Follow a direction. | ||
b |
| -1:1 | Follow an exit. | ||
c |
| -1:1 | Follow a road/route. | ||
d |
| -1:1 | Follow a sign. | ||
TransferDurationGroup group
| [an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time. | ||||
PathGuidanceStructure
| Description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information. | ||||
The element contains only one element: | |||||
| 1:* | A view of LEG TRACK including PATH JUNCTION information, PATH LINK information and PATH GUIDANCE. One or more path guidance sections that form the LEG. For a good PATH GUIDANCE, a fine granularity of the sections may be needed. This may also depend on the MODE and the type of guidance required. | |||
PathGuidanceSectionStructure
| An extended definition of a NAVIGATION PATH in TMv6 and PATH GUIDANCE to include the textual navigation instructions. Description of a part of a TRIP. May include geographic information, turn instructions and accessibility information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | An aggregate of information that may be leaning on LEG TRACK together with duration and length that can be used for representing the leg on a map. The points may be STOP PLACE, SCHEDULED STOP POINT, coordinates, or ADDRESSes. | |||
| 0:1 | Textual description of a traveller manoeuvre. Contains information from manoeuvre, TurnAction, and TrackSection.RoadName. | |||
| 0:1 | Several types of guidance advice given to traveller (according to Transmodel a view of a LEG TRACK and PATH GUIDANCE). | |||
| 0:1 | The range of possible turns that can be described (according to Transmodel a view of a LEG TRACK and PATH GUIDANCE). | |||
| 0:1 | Road name | |||
| 0:* | Signs, roads, POI to follow. | |||
| 0:1 | Textual direction hint for better understanding, e.g., "follow signs to Hamburg" (according to Transmodel a view of a LEG TRACK and PATH GUIDANCE). | |||
| 0:1 | siri:AbsoluteBearingType | Absolute bearing (sky direction) after the described manoeuvre. | ||
| 0:1 | Description of the type of accessibility on this navigation section. This view is simplified in comparison to the NeTEx PathLink structure. | |||
| 0:1 | A list of references to SITUATIONs. | |||
FollowStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Follow a direction. | ||
b |
| -1:1 | Follow an exit. | ||
c |
| -1:1 | Follow a road/route. | ||
d |
| -1:1 | Follow a sign. | ||
TransferDurationGroup group
| [an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time. | ||||
| TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange (Transmodel: PT CONNECTION LEG.MEAN INTERCHANGE TIME). | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration (in Transmodel might be modeled as TRANSFER.CONNECTION.DefaultDuration). | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, e.g. check in/out times, sometimes are mandatory for using certain services as e.g. airplanes, ferries or highspeed trains. | ||
| 0:1 | xs:duration | Walk time as part of the overall interchange duration (in Transmodel might be modelled as TRANSFER.CONNECTION.DefaultDuration). | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, e.g., check in/out times, sometimes are mandatory for using certain services as e.g., airplanes, ferries or highspeed trains. | ||
InterchangeGroup group
| Adding interchange elements from SIRI to a transfer leg. | ||||
| Interchange |
| 0:1 | siri:InterchangeRefStructure | Reference of an INTERCHANGE. | |
| 0:1 | xs:boolean | Whether this interchange is an addition to the plan. Can only be used when both participants recognise the same schedule version. If omitted, defaults to 'false': the interchange is not an addition. (since SIRI 2.1) | ||
| 0:1 | xs:boolean | Whether this interchange is a cancellation of a previously announced interchange (or planned according to the long-term timetable. Can only be used when both participants recognise the same schedule version. If omitted, defaults to 'false': the interchange is not cancelled. (since SIRI 2.1) | ||
| |||||
PathLinkStructure
| [TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs, BOARDING POSITIONs, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE. Here we use a reduced form of a PATH LINK containing the description of the type of accessibility on this navigation section. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Whether path is up, down or level. | |||
| 0:1 | Type of physical feature of PATH LINK. | |||
| 0:1 | xs:positiveInteger | Number indicating how often the access feature occurs in this PathLink | ||
| 0:1 | Whether the access feature is available or out of service. | |||
| 0:1 | Textual information about reduced availability of the access feature, in particular if AccessFeatureStatus is partiallyAvailable. | |||
| 0:* | Presence of an accessibility feature on the PathLink. | |||
0:* | Reference to a situation that affects the availability of the access feature. | ||||
| 0:1 | Designations of level and place where this PathLink starts. | |||
| 0:1 | Designations of level and place where this PathLink ends. | |||
PathLinkEndStructure
| Designations of a floor/level. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:normalizedString | Public identifier of the level as found on elevators and signs. | ||
| 0:1 | Official name of the level. | |||
| 0:1 | Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located). | |||
MultiPointTripRequestGroup group
| Multi-point trip request structure. | ||||
PathLinkStructure
| [TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs, BOARDING POSITIONs, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists, or other out-of-vehicle passengers within or between a PLACE. Here we use a reduced form of a PATH LINK containing the description of the type of accessibility on this navigation section. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Whether path is up, down, or level. | |||
| 0:1 | Type of physical feature of PATH LINK. | |||
| 0:1 | xs:positiveInteger | Number indicating how often the access feature occurs in this PathLink | ||
| 0:1 | Whether the access feature is available or out of service. | |||
| 0:1 | Textual information about reduced availability of the access feature, in particular if AccessFeatureStatus is partiallyAvailable. | |||
| 0:* | Presence of an accessibility feature on the PathLink. | |||
0:* | Reference to a situation that affects the availability of the access feature. | ||||
| 0:1 | Designations of level and place where this PathLink starts. | |||
| 0:1 | Designations of level and place where this PathLink ends. | |||
PathLinkEndStructure
| Designations of a floor/level. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:normalizedString | Public identifier of the level as found on elevators and signs. | ||
| 0:1 | Official name of the level. | |||
| 0:1 | Id of the element at this end of the PathLink (typically a PLACE, e.g., where the elevator is located). | |||
MultiPointTripRequestGroup group
| Multi-point trip request structure. | ||||
| MultiPointTripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops (in Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia). | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops (in Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia). | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP (in Transmodel this would be an extension to TRIP MOBILITY FILTER). | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
| BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to walk up/downstairs. | ||
| 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 a ramp. | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport (could be extended in future to transporting big luggage/animals/etc). | |
| 0:1 | Deviation from average walking speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modeled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modelled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
Then, the element contains one of the following elements: | |||||
| NumberOfResults | a |
| 0:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 0: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 (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementations will deliver one of the TripResults before the indicated departure time. This means one always must check the results against the parameters before using them. |
| 0:1 | xs:duration | Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation. | ||
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g., because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
| 0:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | |||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, foot). Default is FALSE. | ||
| 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 the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g., guidance text for the visually impaired). | |||
| 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 | ||
| 0:1 | xs:boolean | Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true. | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
The element contains one of the following elements: | |||||
| NumberOfResults | a |
| 0:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 0: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 (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementations will deliver one of the TripResults before the indicated departure time. This means one always must check the results against the parameters before using them. |
| 0:1 | xs:duration | Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation. | ||
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g., because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
| 0:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | |||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, foot). Default is FALSE. | ||
| MultiPointTripPolicy |
| 1:1 | If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found. | ||
MultiPointTripResponseGroup group
| Multi-point trip response structure. | ||||
| MultiPointTripResponse |
| 0:1 | The MultiPointType should be returned, because it may differ from the one asked. Many systems will support only a subset of the MultiPointTypes and it is important to know, what the result is based on. | ||
| MultiPointTripResponse |
| 0:1 | The MultiPointType should be returned because it may differ from the one asked. Many systems will support only a subset of the MultiPointTypes and it is important to know, what the result is based on. | ||
| 0:1 | Context to hold trip response objects that occur frequently. | |||
| 0:* | The trip results found by the server. | |||
MultiPointTripResultStructure
| Structure for a multipoint trip result and associated problems | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip result for referencing purposes. Unique within multipoint-trip response. | |||
| 0:* | Problems related to this trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Information on the trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* | Fare and fare product information for this trip as a whole or parts of it. | |||
MultiPointWaitTimeGroup group
| Group for wait times at origin/destination. | ||||
| MultiPointWaitTime |
| 0:1 | xs:duration | Additional wait time at origin of this trip. | |
| 0:1 | xs:duration | Additional wait time at destination of this trip. | ||
TripStatusGroup group
| Parameters which describe the current status of a TRIP (will be added to MONITORED TRIP in Transmodel). | ||||
TripStatusGroup group
| Parameters which describe the status of a TRIP (will be added to MONITORED TRIP in Transmodel). | ||||
| TripStatus |
| 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. | ||
| TripRefineRequest |
| 0:1 | Options to control the refine | ||
| 1:1 | The trip result to be refined by the server. | |||
| 0:1 | Context to hold objects, which are referenced within the response. | |||
TripRefineParamStructure
| Trip refinement request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | If true, then the request may contain object references from another system. Default is FALSE. | ||
| 1:* | Refers to the legs to be refined by the server. If none is given, then all legs are open for refinement (depending if the relevant system can refine them). | |||
| 0:1 | xs:normalizedString | System reference to use for the refinement. If not specified the origin systems of each leg are used for the refinement. | ||
TripRefineParamStructure
| Trip refinement request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | If true, then the request may contain object references from another system. Default is FALSE. | ||
| 1:* | Refers to the legs to be refined by the server. If none is given, then all legs are open for refinement (depending on if the relevant system can refine them). | |||
| 0:1 | xs:normalizedString | System reference to use for the refinement. If not specified, the origin systems of each leg are used for the refinement. | ||
| BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to walk up/downstairs. | ||
| 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 a ramp. | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport (could be extended in future to transporting big luggage/animals/etc). | |
| 0:1 | Deviation from average walking speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modeled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modelled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
Then, the element contains one of the following elements: | |||||
| NumberOfResults | a |
| 0:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 0: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 (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementations will deliver one of the TripResults before the indicated departure time. This means one always must check the results against the parameters before using them. |
| 0:1 | xs:duration | Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation. | ||
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g., because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
| 0:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | |||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, foot). Default is FALSE. | ||
| 0:1 | xs:boolean | There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router, irrespective of the selected passenger categories or the MotorisedMainTravelMode. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed. | ||
| 0:* | Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory. | |||
Then, the element contains one of the following elements: | |||||
The element contains a sequence of the following elements: | |||||
| TripPolicy |
| -0:* | For each MODE or MODE OF OPERATION combination in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | ||
| -0:1 | xs:boolean | Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. | ||
b |
| -0:1 | xs:boolean | The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads. | |
Then, the element contains one of the following elements: | |||||
The element contains a sequence of the following elements: | |||||
| TripPolicy |
| -0:* | For each MODE or MODE OF OPERATION combination in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | ||
| -0:1 | xs:boolean | Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. | ||
b |
| -0:1 | xs:boolean | The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g., because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads. | |
| 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 turn-by-turn instructions for each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g., guidance text for the visually impaired). | |||
| 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 | ||
| 0:1 | xs:boolean | Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true. | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| TripChangeRequest |
| 0:1 | Options to control the change. | ||
| 1:1 | The trip result to be changed by the server. | |||
| 0:1 | Context to hold objects, which are referenced within the response. | |||
TripChangeParamStructure
| Trip change request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Refers to the leg to be adapted by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or a sharing leg for which the exact times shall be retrieved for a specific operator. | |||
| 0:1 | xs:normalizedString | System reference to use for the refinement. If not specified the origin systems of each leg are used for the refinement. | ||
| 0:1 | Whether to extend the initial time interval of the ChangeLeg towards the front or the back of the trip (earlier respectively later times). | |||
| 0:1 | xs:duration | Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested. | ||
| 0:1 | Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest. | |||
| 0:1 | xs:anyType | |||
TripChangeResponseGroup group
| Trip change response structure. | ||||
TripChangeParamStructure
| Trip change request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Refers to the leg to be adapted by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or a sharing leg for which the exact times shall be retrieved for a specific operator. | |||
| 0:1 | xs:normalizedString | System reference to use for the refinement. If not specified, the origin systems of each leg are used for the refinement. | ||
| 0:1 | Whether to extend the initial time interval of the ChangeLeg towards the front or the back of the trip (earlier respectively later times). | |||
| 0:1 | xs:duration | Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g., since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested. | ||
| 0:1 | Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest. | |||
| 0:1 | xs:anyType | |||
TripChangeResponseGroup group
| Trip change response structure. | ||||
| TripChangeResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:1 | The trip results refined by the server. | |||
TripChangeProblemType
| TripChangeProblemType (↔ ErrorType) | ||||
StopPointName
1:1
Name or description of stop point for use in passenger information.
NameSuffix
0:1
Additional description of the stop point that may be appended to the name if enough space is available. E.g. "opposite main entrance".
PlannedQuay
0:1
Name of the bay where to board/alight from the vehicle. According to planned timetable.
EstimatedQuay
0:1
Name of the bay where to board/alight from the vehicle. As to the latest realtime status.
DisplayPriority
0:1
Priority of this via point to be displayed when space is limited.
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". | ||||
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. | ||
ParallelServiceStructure
| Services running combined with at least parts of this journey, e.g. wing trains. The contained stop sequence interval refers to the original journey. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest real-time status. | |||
| 0:1 | Priority of this via point to be displayed when space is limited. | |||
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". | ||||
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. | ||
ParallelServiceStructure
| Services running combined with at least parts of this journey, e.g., wing trains. The contained stop sequence interval refers to the original journey. | ||||
The element contains a sequence of the following elements: | |||||
| StopSequenceInterval |
| 0:1 | xs:positiveInteger | Stop sequence number, where the interval begins (inclusive). If missing, the interval begins at the beginning of the leg (or at the beginning of the journey for uses in StopEvents and TripInfo). | |
| 0:1 | xs:positiveInteger | Stop sequence number, where the interval ends (inclusive). If missing, the interval ends at the end of the leg (or at the end of the journey for uses in StopEvents and TripInfo). | ||
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | ||
| |||||
| 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, e.g. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 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, e.g., "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles). | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free-floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g., "Airport via City Centre". | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles). | ||
| 0:1 | Information about the restriction. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | ||
| |||||
| 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, e.g. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 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, e.g., "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles). | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free-floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g., "Airport via City Centre". | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles). | ||
| 0:1 | Information about the restriction. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | ||
| |||||
| 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, e.g. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 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, e.g., "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles). | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free-floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g., "Airport via City Centre". | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles). | ||
| 0:1 | Information about the restriction. | |||
| 0:* | Note or service attribute. | |||
ServiceDestinationGroup group
| Last serviced stop of a vehicle journey (also VEHICLE MEETING POINT or ADDRESSABLE PLACE). | ||||
| ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 0:1 | Label for last stop. Should be set for classic public transport. Demand responsive and newer modes of operation will often not have a destination text. | |||
RouteDescriptionGroup group
| Descriptive text for a route, e.g. "Airport via City Centre" | ||||
RouteDescriptionGroup group
| Descriptive text for a route, e.g., "Airport via City Centre". | ||||
| RouteDescription |
| 1:1 | |||
DatedJourneyGroup group
| Vehicle journey that runs at a specific date. | ||||
| DatedJourney |
| 0:1 | MODE OF OPERATION for scheduled and flexible services (NeTEx). | ||
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | ||
| |||||
| 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, e.g. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 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, e.g., "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles). | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free-floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g., "Airport via City Centre". | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles). | ||
| 0:1 | Information about the restriction. | |||
| 0:* | Note or service attribute. | |||
b |
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | |
| |||||
| Service | b |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
b |
| 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. | ||
b |
| 1:1 | Line name or service description as known to the public, e.g. "512", "S8" or "Circle Line" or "ICE 488". | ||
b |
| 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. | ||
b |
| 1:1 | Line name or service description as known to the public, e.g., "512", "S8" or "Circle Line" or "ICE 488". | ||
b |
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | |
b |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
b |
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | ||
b |
| 0:1 | Descriptive text for a route, e.g. "Airport via City Centre" | ||
b |
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | ||
b |
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles). | |
b |
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free-floating sharing companies. | ||
b |
| 0:1 | Descriptive text for a route, e.g., "Airport via City Centre". | ||
b |
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | ||
b |
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles). | |
b |
| 0:1 | Information about the restriction. | ||
b |
| 0:* | Note or service attribute. | ||
| The formation elements on the journey level. | ||||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | Indicates whether this service needs some kind of reservation or booking to run. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripLocationStructure
| A trip location represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip request from within this service. A trip location 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 | ||||
| |||||
TimeWindowGroup group
| The window of opportunity that the traveller has to perform this leg of the journey (e.g. a bridge is only open during a given interval). | ||||
| The formation elements on the journey level. | ||||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | Indicates whether this service needs some kind of reservation or booking to run. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripLocationStructure
| A trip location represents the current logical position of a journey service. It can be used similarly to a place e.g., for starting a new trip request from within this service. A trip location 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 | ||||
| |||||
TimeWindowGroup group
| The window of opportunity that the traveller has to perform this leg of the journey (e.g., a bridge is only open during a given interval). | ||||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
ServiceTimeGroup group
| Contains at least scheduled time, but can contain real time and estimated times | ||||
| 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. E.g. "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). | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest real-time 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. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly show elements that are important for accessibility. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly shows elements that are important for accessibility. | ||
| 0:* | Note or attribute. | |||
| 0:1 | A list of references to SITUATIONs. | |||
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 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. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly show elements that are important for accessibility. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly shows elements that are important for accessibility. | ||
| 0:* | Note or attribute. | |||
ServiceStatusGroup group
| parameters which describe the current status of a DATED VEHICLE JOURNEY | ||||
ServiceStatusGroup group
| parameters which describe the 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. | ||
a |
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | |
| |||||
| 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, e.g. "512", "S8" or "Circle Line" or "ICE 488". | ||
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, e.g., "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | |
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
a |
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | ||
a |
| 0:1 | Descriptive text for a route, e.g. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | ||
a |
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles). | |
a |
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free-floating sharing companies. | ||
a |
| 0:1 | Descriptive text for a route, e.g., "Airport via City Centre". | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | ||
a |
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles). | |
a |
| 0:1 | Information about the restriction. | ||
a |
| 0:* | Note or service attribute. | ||
| Service | a |
| 0:1 | siri:JourneyRelationsStructure | Relations of the journey with other journeys, e.g., in case a joining/splitting takes place or the journey substitutes for another one etc. |
The element contains a sequence of the following elements: | |||||
| -1:1 | PERSONAL MODE used either for PERSONAL MODE OF OPERATION or in ALTERNATIVE MODE OF OPERATION. | |||
| -0:1 | Shared mobility offer. | |||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
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 (expected to be consistent with Transmodel ROUTE or LEG TRACK and PATH GUIDANCE). | ||
| 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. | ||
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 | Location within a (moving) vehicle. | ||
Then, the element contains one of the following elements: | |||||
a |
| -0:1 | xs:dateTime | Time when departure/arrival from/to location is required. | |
b |
| -0:1 | xs:duration | Extra time needed before reaching/after leaving this location (an example of a TRIP ACCESS CONSTRAINT. In Transmodel it is modeled more extensively and could relate to ACCESS MODE e.g. walk max. 5 minutes, but cycle 10 minutes). | |
| 0:* | Options how to access/leave the place by individual transport. | |||
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 | ||||
The element contains a sequence of the following elements: | |||||
| -1:1 | PERSONAL MODE used either for PERSONAL MODE OF OPERATION or in ALTERNATIVE MODE OF OPERATION. | |||
| -0:1 | Shared mobility offer. | |||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
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 (expected to be consistent with Transmodel ROUTE or LEG TRACK and PATH GUIDANCE). | ||
| 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. | ||
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 | Location within a (moving) vehicle. | ||
Then, the element contains one of the following elements: | |||||
a |
| -0:1 | xs:dateTime | Time when departure/arrival from/to location is required. | |
b |
| -0:1 | xs:duration | Extra time needed before reaching/after leaving this location (an example of a TRIP ACCESS CONSTRAINT. In Transmodel it is modelled more extensively and could relate to ACCESS MODE e.g., walk max. 5 minutes, but cycle 10 minutes). | |
| 0:* | Options how to access/leave the place by individual transport. | |||
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 |
| 0:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). | |
| 0:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | ||
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 |
| 0:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 0: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 (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementations will deliver one of the TripResults before the indicated departure time. This means one always must check the results against the parameters before using them. |
| 0:1 | xs:duration | Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation. | ||
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g., because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
| 0:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | |||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, foot). Default is FALSE. | ||
| 0:* | Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory. | |||
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 pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to walk up/downstairs. | ||
| 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 a ramp. | ||
| 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 the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g., guidance text for the visually impaired). | |||
| 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 | ||
| 0:1 | xs:boolean | Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true. | ||
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. | ||
LegTrackStructure
| The LINK PROJECTION of a Leg onto the topography of the route being followed. | ||||
The element contains only one element: | |||||
| 1:* | A geographical view of a Transmodel LEG TRACK together with duration and length that can be used for representing the leg on a map. The points may be STOP PLACE, SCHEDULED STOP POINT, coordinates or ADDRESSes. Specialisation of SECTION. | |||
TrackSectionStructure
| SECTION of a LEG TRACK on the infrastructure network of the LEG together with time information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Start place of this track section (Start of a SECTION of a LEG.TRACK). | |||
| 0:1 | End place of this track section (End of a SECTION of a LEG.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 (LEG TRACK.SECTION NAME, may also be something like "bicycle line along Tellstrasse"). | ||
| 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 | |||
LegTrackStructure
| The LINK PROJECTION of a Leg onto the topography of the route being followed. | ||||
The element contains only one element: | |||||
| 1:* | A geographical view of a Transmodel LEG TRACK together with duration and length that can be used for representing the leg on a map. The points may be STOP PLACE, SCHEDULED STOP POINT, coordinates, or ADDRESSes. Specialisation of SECTION. | |||
TrackSectionStructure
| SECTION of a LEG TRACK on the infrastructure network of the LEG together with time information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Start place of this track section (Start of a SECTION of a LEG.TRACK). | |||
| 0:1 | End place of this track section (End of a SECTION of a LEG.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 (LEG TRACK.SECTION NAME, may also be something like "bicycle line along Tellstrasse"). | ||
| 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 | |||
| AVAILABILITY_NOSERVICEFOUND | AVAILABILITY_LOCATIONUNSERVED | AVAILABILITY_LOCATIONUNKNOWN | AVAILABILITY_OUTSIDERULES | AVAILABILITY_SERVICEDISRUPTED | AVAILABILITY_UNAVAILABLE | AVAILABILITY_OTHER | Types of problems that may be returned in responses to AVAILABILITY requests. |
| wheelchair | motorisedWheelchair | foldableWheelchair | walkingFrame | pram | heavyLuggage | childSeatTakenAlong | childSeatSupplied | babyCarrierTakenAlong | babyCarrierSupplied | seatBoosterSupplied | bicycle | guideDog | dog | boardingAssistance | alightingAssistance | onboardAssistance | unassistedMinorAssistance | Types of bookable service items. |
AvailabilityRequestGroup group
| Availability request. Used to check the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY or SINGLE JOURNEY. Be aware that usually after the response arrives, the rest of the TRIP must be recalculated. As especially pickup and setdown locations may have shifted from where they were in the previously calculated TRIP. | ||||
The element contains one of the following elements: | |||||
| AvailabilityRequest | a |
| -1:1 | Definition of the journey leg to be covered by public transport. Other mobility services can be added later. | |
| 1:* | Passenger(s) for whom the service needs to be booked, one MobilityUser per passenger. | |||
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | ||
| |||||
| 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, e.g. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 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, e.g., "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles). | ||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free-floating sharing companies. | |||
| 0:1 | Descriptive text for a route, e.g., "Airport via City Centre". | |||
| 0:* | Via points of the service that may help identify the vehicle to the public (In Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description). | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles). | ||
| 0:1 | Information about the restriction. | |||
| 0:* | Note or service attribute. | |||
| BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to walk up/downstairs. | ||
| 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 a ramp. | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport (could be extended in future to transporting big luggage/animals/etc). | |
| 0:1 | Deviation from average walking speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modeled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modelled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 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. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly show elements that are important for accessibility. | ||
The element contains a sequence of the following elements: | |||||
| 0:* | →siri:ExpectedDepartureOccupancy | The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation. | ||
| 0:* | →siri:ExpectedDepartureCapacities | The Capacity structure also will probably rarely be used and parsed. When used, then it mainly shows elements that are important for accessibility. | ||
| 0:* | Note or attribute. | |||
MinMaxTimeBandGroup group
| Earliest possible departure time from a start location and latest possible arrival at a different destination location. | ||||
| MinMaxTimeBand |
| 0:1 | xs:dateTime | Earliest possible departure time from start location. | |
| BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to walk up/downstairs. | ||
| 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 a ramp. | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport (could be extended in future to transporting big luggage/animals/etc). | |
| 0:1 | Deviation from average walking speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modeled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport, not modelled in Transmodel). | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
ErrorType
| xs:string | ||||
ProblemDetailGroup group
| Detailed description of the problem. | ||||
| ProblemDetail |
| 0:1 | Explanation of the problem. | ||
| 0:1 | xs:string | Additional log data. | ||
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. | ||
LinearShapeStructure
| An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure. | ||||
The element contains only one element: | |||||
| 2:* | siri:LocationStructure | Ordered list of locations representing the geometry of the link or route. | ||
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. | ||
ParticipantRef
| siri:ParticipantRefStructure | Reference to a Participant ([equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)) | |||
OperatorRef
| siri:OperatorRefStructure | Reference to an Operator ([TMv6] company providing public transport services.) | |||
OperatorRefs_RelStructure
| |||||
The element contains only one element: | |||||
| 1:* | siri:OperatorRefStructure | |||
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 | ||
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). | |||
LineDirectionFilterStructure
| Filter for in/exclusion of lines (and directions). | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | siri:LineDirectionStructure | Reference to a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables. | ||
| 0:1 | xs:boolean | Whether lines in list are to include or exclude from search. Default is exclude. | ||
JourneyRefStructure
| Reference to a Journey | ||||
JourneyRef
| Reference to a Journey | ||||
DatedJourneyRefGroup group
| Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day). | ||||
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. | ||
LinearShapeStructure
| An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g., LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure. | ||||
The element contains only one element: | |||||
| 2:* | siri:LocationStructure | Ordered list of locations representing the geometry of the link or route. | ||
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. | ||
ParticipantRef
| siri:ParticipantRefStructure | Reference to a Participant ([equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)) | |||
OperatorRef
| siri:OperatorRefStructure | Reference to an Operator ([TMv6] company providing public transport services.) | |||
OperatorRefs_RelStructure
| |||||
The element contains only one element: | |||||
| 1:* | siri:OperatorRefStructure | |||
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 | ||
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). | |||
LineDirectionFilterStructure
| Filter for in/exclusion of lines (and directions). | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | siri:LineDirectionStructure | Reference to a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables. | ||
| 0:1 | xs:boolean | Whether lines in list are to include or exclude from search. Default is exclude. | ||
JourneyRefStructure
| Reference to a Journey | ||||
JourneyRef
| Reference to a Journey | ||||
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 | ||||
DatedTrainNumberRefGroup group
| Reference to a TRAIN NUMBER of an OPERATOR at a given OPERATING DAY. | ||||
AlternativeServiceStructure
| Service that provides shared vehicles (The Transmodel MODE OF OPERATION is VEHICLE SHARING; other related Transmodel concepts: ALTERNATIVE MODE LEG.SINGLE JOURNEY.COMMON.VEHICLE SERVICE.TRANSPORT ORGANISATION). | ||||
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. | ||
| AlternativeServiceUsage |
| 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 the web page providing more details on the service. | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles). | ||
| 0:1 | Information about the restriction. | |||
OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
OperatingDayRefStructure
| Reference to an Operating Day | ||||
OperatingDayRef
| Reference to an Operating Day | ||||
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. This is useful, when the trip can be made during several days. Often users search in "general" withouth setting a date and then refine with the actual date. By using OperatingDaysStructure the result can directly be reused without an additional OJPTripRequest. | ||||
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. | |||
OperatingDaysGroup group
| Coded as bit pattern | ||||
| 0:1 | Link to the web page providing more details on the service. | |||
| 0:1 | xs:boolean | This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles). | ||
| 0:1 | Information about the restriction. | |||
OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
OperatingDayRefStructure
| Reference to an Operating Day | ||||
OperatingDayRef
| Reference to an Operating Day | ||||
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. This is useful, when the trip can be made during several days. Often users search in "general" withouth setting a date and then refine with the actual date. By using OperatingDaysStructure the result can directly be reused without an additional OJPTripRequest. | ||||
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 happens on the day that is represented by the bit position. | |||
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". | |||
| 0:1 | Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays". | |||
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. | ||
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:NMTOKEN | Key if the attribute is used as a key/value pair. | ||
| 0:1 | xs:string | Value if the attribute is used as a key/value pair. | ||
| 0:* | siri:AllFacilitiesFeatureStructure | Facilities associated with this attribute. | ||
| 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 | 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. | ||
SustainabilityGroup group
| Elements about sustainability. Primarily for TRIPs and LEGs. | ||||
| Sustainability |
| 0:1 | Estimation of CO2 emissions. | ||
EmissionCO2Structure
| Estimation of CO2 emissions. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Kilograms of CO2 emission by person and by kilometre. | |||
ServiceFacilityGroup group
| Wrapper for SIRI service facilities. | ||||
| |||||
| sharing | stationLessSharing | stationBasedSharing | singleStationBasedSharing | multipleStationBasedSharing | peerToPeerSharing | parkAndRideSharing | sharingClubSharing | prM | pooling | taxi | shuttle | dynamicPooling | longDistancePooling | commuterPooling | parkAndRidePooling | chauffeured | demandResponsive | flexibleArea | companyShuttle | hotelShuttle | hire | other | ALTERNATIVE MODE OF OPERATION offered. |
| scheduled | demandResponsive | flexibleRoute | flexibleArea | shuttle | pooling | replacement | school | pRM | Types of MODES OF OPERATION are scheduled, classic and also flexible. From NeTEx. |
| foot | bicycle | car | motorcycle | truck | scooter | other | TYPE OF MODE that can be used in an individual context. PERSONAL MODE in TM 6.2. |
| self | own | otherOwned | privateLift | lease | PERSONAL MODE OF OPERATION |
| walk | shuttle | taxi | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut | parkAndRide | bikeAndRide | carHire | bikeHire | other | TYPE OF TRANSFER. It is a mix between MODE information, MODE OF OPERATION information and a more stringent TYPE OF TRANSFER. |
IndividualTransportOptionStructure
| Individual modes and their usage limits as stated by the passenger (TRIP ACCESS CONSTRAINT). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Combinations of MODE and MODE OPERATION for ACCESS LEG. If no MODE OF OPERATION is given, then all can be used. Usually the result will be the own vehicle. | |||
| 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. | ||
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 a (conventional) PUBLIC TRANSPORT MODE. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used, if no other value applies. | |
| sharing | stationLessSharing | stationBasedSharing | singleStationBasedSharing | multipleStationBasedSharing | peerToPeerSharing | parkAndRideSharing | sharingClubSharing | prM | pooling | taxi | shuttle | dynamicPooling | longDistancePooling | commuterPooling | parkAndRidePooling | chauffeured | demandResponsive | flexibleArea | companyShuttle | hotelShuttle | hire | other | ALTERNATIVE MODE OF OPERATION offered. |
| scheduled | demandResponsive | flexibleRoute | flexibleArea | shuttle | pooling | replacement | school | pRM | Types of MODES OF OPERATION are scheduled, classic and flexible. From NeTEx. |
| foot | bicycle | car | motorcycle | truck | scooter | other | TYPE OF MODE that can be used in an individual context. PERSONAL MODE in TM 6.2. |
| self | own | otherOwned | privateLift | lease | PERSONAL MODE OF OPERATION |
| walk | shuttle | taxi | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut | parkAndRide | bikeAndRide | carHire | bikeHire | other | TYPE OF TRANSFER. It is a mix between MODE information, MODE OF OPERATION information and a more stringent TYPE OF TRANSFER. |
IndividualTransportOptionStructure
| Individual modes and their usage limits as stated by the passenger (TRIP ACCESS CONSTRAINT). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Combinations of MODE and MODE OPERATION for ACCESS LEG. If no MODE OF OPERATION is given, then all can be used. Usually, the result will be the own vehicle. | |||
| 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. | ||
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 a (conventional) PUBLIC TRANSPORT MODE. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also, in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used if no other value applies. | |
| |||||
| 0:1 | Name of the mode. | |||
| 0:1 | Short name or acronym of the mode. | |||
| 0:1 | Additional text that further describes the mode. | |||
ModeGroup group
| Elements for a Transport Mode | ||||
| Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of a (conventional) PUBLIC TRANSPORT MODE. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used, if no other value applies. | |
| Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of a (conventional) PUBLIC TRANSPORT MODE. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also, in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used if no other value applies. | |
| |||||
ModeFilterStructure
| List of MODE to exclude or include. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether MODEs in list are to be excluded or included from search. Default is to exclude. | ||
| 0:* | siri:VehicleModesOfTransportEnumeration | List of PT Transport modes to include/exclude. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used, if no other value applies. | ||
| 0:* | List of personal transport modes to include/exclude. Those are also used in many of the ALTERNATIVE MODES OF OPERATION. | |||
| |||||
ModeAndModeOfOperationFilterStructure
| List of MODE and MODE OF OPERATION filter offers to include or exclude. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether MODE and MODE OF OPERATION combination in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:VehicleModesOfTransportEnumeration | List of PT Transport modes to include/exclude. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used, if no other value applies. | ||
| 0:* | List of personal transport modes to include/exclude. Those are also used in many of the ALTERNATIVE MODES OF OPERATION. | |||
| |||||
| 0:* | List of personal mobility offers to include/exclude. | |||
| 0:* | List of alternative mobility offers to include/exclude. | |||
| 0:* | List of conventional mobility offers to include/exclude. | |||
ItModesStructure
| Combinations of MODE and MODE OF OPERATION that should be covered as monomodal trips (or for the ACCESS LEGs). If no MODE OF OPERATION is added usually "own" is assumed. But the trip planner may add other relevant results (e.g. sharing, if sensible trips are possible). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Relevant PERSONAL MODE to be used for the monomodal trip. | |||
| 0:* | List of personal mobility offers for this MODE. | |||
| 0:* | List of alternative mobility offers for this MODE. | |||
ModeFilterStructure
| List of MODE to exclude or include. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether MODEs in list are to be excluded or included from search. Default is to exclude. | ||
| 0:* | siri:VehicleModesOfTransportEnumeration | List of PT Transport modes to include/exclude. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also, in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used if no other value applies. | ||
| 0:* | List of personal transport modes to include/exclude. Those are also used in many of the ALTERNATIVE MODES OF OPERATION. | |||
| |||||
ModeAndModeOfOperationFilterStructure
| List of MODE and MODE OF OPERATION filter offers to include or exclude. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether MODE and MODE OF OPERATION combination in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:VehicleModesOfTransportEnumeration | List of PT Transport modes to include/exclude. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also, in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used if no other value applies. | ||
| 0:* | List of personal transport modes to include/exclude. Those are also used in many of the ALTERNATIVE MODES OF OPERATION. | |||
| |||||
| 0:* | List of personal mobility offers to include/exclude. | |||
| 0:* | List of alternative mobility offers to include/exclude. | |||
| 0:* | List of conventional mobility offers to include/exclude. | |||
ItModesStructure
| Combinations of MODE and MODE OF OPERATION that should be covered as monomodal trips (or for the ACCESS LEGs). If no MODE OF OPERATION is added usually "own" is assumed. But the trip planner may add other relevant results (e.g., sharing, if sensible trips are possible). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Relevant PERSONAL MODE to be used for the monomodal trip. | |||
| 0:* | List of personal mobility offers for this MODE. | |||
| 0:* | List of alternative mobility offers for this MODE. | |||
SituationsStructure
| Wrapper type for SIRI PtSituationsElementStructure | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | siri:PtSituationElementStructure | SIRI situation details in public transport, see CEN/TS 15531-5. | ||
| 0:* | siri:RoadSituationElementStructure | SIRI situation details in individual transport, see CEN/TS 15531-5. | ||
SituationFullRef
| Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
SituationFullRefStructure
| siri:SituationFullRefStructure | Reference structure for situation message. Situation details might be found in response context or through other communication channels. | |||
SituationRefList
| List of references to SITUATIONs. | ||||
The element contains only one element: | |||||
1:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| xs:normalizedString | Type definition for email addresses. |
| xs:nonNegativeInteger | Data type for lengths, in meters. |
| xs:nonNegativeInteger | Percent value as integer, no upper limit. |
| xs:nonNegativeInteger | Percent value as integer, limited to max value 100. |
| xs:normalizedString | Type definition for phone numbers |
| xs:nonNegativeInteger | Data type for priority values, from 1 (highest) to 5 (lowest). |
| xs:string | sequence of bits (values 0 or 1) coded as a text string and representing days |
InternationalTextStructure
| [a restricted view of ALTERNATIVE NAME in TMv6] alternative identified text to be used in specified languages. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | siri:NaturalLanguageStringStructure | Text content. | ||
| 0:1 | xs:NMTOKEN | Id of this text. May be used for matching to pre-recorded audio files. | ||
WebLinkGroup group
| URL of a web resource including type of resource. | ||||
| 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 | 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. | ||
WebLinkStructure
| URL of a web resource with label. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Label for link description. | |||
| 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 | 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. | ||
| STATUS_INSTANCE_USAGE_DEPRECATED | STATUS_OTHER | Types of problems that may be returned in responses to status requests. |
StatusProblemType
| StatusProblemType (↔ ErrorType) | ||||
OJPStatusResponse
| +OJPStatusResponse (↔ siri:AbstractFunctionalServiceCapabilitiesResponse) | ||||
OJPStatusResponseStructure
| siri:AbstractServiceCapabilitiesResponseStructure | ||||