Location
1:1
LOCATION / PLACE for which to obtain stop event information. If a coordinate or an address is used, then the result may depend on other parameters: All stops in reasonable walking distance and stops that are within range of limitations of the IndividualTransportAptions should be shown. If the next stop is too far away, then no result is shown. "Reasonable" is usually defined as part of the server configuration.
Params
0:1
Request parameter
StopEventParamStructure
| Request specific parameters (parameters which define what is to be included in a Stop Event result) | ||||
The element contains a sequence of the following elements: | |||||
| StopEventDataFilter |
| 0:1 | Modes (VEHICLE MODE) to be excluded or included in stop events. We on purpose don't use ModeOfOperationFilter in the stop event service. | ||
| 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 | Lines/Directions to include/exclude. | |||
| 0:1 | Transport operators to include/exclude. | |||
| 0:1 | 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. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements. | |||
| 0:1 | xs:anyType | |||
StopEventDataFilterGroup group
| Request data filters | ||||
| StopEventDataFilter |
| 0:1 | Modes (VEHICLE MODE) to be excluded or included in stop events. We on purpose don't use ModeOfOperationFilter in the stop event service. | ||
| 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 | Lines/Directions to include/exclude. | |||
| 0:1 | Transport operators to include/exclude. | |||
| 0:1 | 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. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements. | |||
| 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) | ||||
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 | Leg by a continuously available service or mode of transport. | ||
b |
| -1:1 | Timetabled Leg. | ||
c |
| -1:1 | Leg to connect between different services or modes of transport (interchanges). | ||
| 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. | ||
| Sustainability |
| 0:1 | Estimation of CO2 emissions. | ||
| 0:1 | xs:boolean | TRUE if leg got changed by TripChange-Request. | ||
TimedLegStructure
| passenger LEG with timetabled schedule. Corresponds to a RIDE. | ||||
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. | |||
| 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. | |||
| Sustainability |
| 0:1 | Estimation of CO2 emissions. | ||
| 0:1 | xs:anyType | |||
TransferLegStructure
| [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required | ||||
The element contains a sequence of the following elements: | |||||
| 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). | |||
| 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. | ||
| 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) | ||
| |||||
| 0:1 | Text that describes this interchange. | |||
| 0:1 | Length of this interchange path. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility (LEG.PATH GUIDANCE). | |||
| 0:* | Information about the feasibility of the TransferLeg, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
ContinuousLegStructure
| [relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | PLACE where the leg starts (can be a PLACE, SCHEDULED STOP POINT or a VEHICLE MEETING POINT) with time information. | |||
| 1:1 | PLACE to alight (can be a SCHEDULED STOP POINT or a VEHICLE MEETING POINT) with time information. | |||
| 1:1 | Service of this leg. | |||
| 0:1 | Text that describes this interchange. | |||
| 0:1 | Length of this interchange path. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility (LEG.PATH GUIDANCE). | |||
| 0:* | Information about the feasibility of the TransferLeg, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
ContinuousLegStructure
| [relates to a specific type of RIDE LEG with Timed=false or an ACCESS LEG in TM and NeTEx] leg of a journey that is not bound to a timetable | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | PLACE where the leg starts (can be a PLACE, SCHEDULED STOP POINT or a VEHICLE MEETING POINT) with time information. | |||
| 1:1 | PLACE to alight (can be a SCHEDULED STOP POINT or a VEHICLE MEETING POINT) with time information. | |||
| 1:1 | Service of this leg. | |||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 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. | |||
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 | 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 than can be used in an individual context. |
| self | own | otherOwned | privateLift | lease | hire | 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) 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 | 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 than can be used in an individual context. PERSONAL MODE in TM 6.2. |
| self | own | otherOwned | privateLift | lease | hire | 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) 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 public transport modes ([from SIRI] mode of public transport service, corresponds to PUBLIC TRANSPORT MODE) to exclude or include. Also the necessary filter elements for PERSONAL MODE and MODE OF OPERATION. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether VEHICLE 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. | ||||