OJPTripRequest

Key concepts

• Stops: Use DiDok or stop datasets from other sources.
• Journeys: A journey involves transporting customers along a particular route, according to a particular timetable connection, by a particular means of transport, at a particular time, in a particular direction.
• Timetable: A timetable determines the progress of a means of transport in public short- and long-distance passenger traffic and in railway freight traffic. The information required for this includes train numbers, days of operation, routes, arrival, departure and passing times at the stops, as well as permissible speeds in individual sections of the route.
• Forecasts: Forecasts concern a train’s running times in the future, which are calculated based on the train’s current location. This also takes into account conflicts and their currently intended settlements in the next x minutes. A less elaborate method is used to calculate future values of the forecast.
• Means of transport (VM): Either used synonymously with vehicles (train, boat, tram, bus) from different carriers or in the sense of a “transport system” (public transport etc.).
• DateTime in Response: It is always based on Zulu time (i.e. UTC). That means, you have to add two hours in summer and one hour in winter.

OJP Trip Service

TripRequest is the main service. A trip can be planned by specifying origin and destination.

A trip has multiple legs (sections).

API Explorer

You can try your own requests – direct link to the API explorer.

Request

<?xml version="1.0" encoding="UTF-8"?>
<OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns="http://www.siri.org.uk/siri" version="1.0" 
xmlns:ojp="http://www.vdv.de/ojp" xsi:schemaLocation="http://www.siri.org.uk/siri ../ojp-xsd-v1.0/OJP.xsd">
    <OJPRequest>
        <ServiceRequest>
			<RequestTimestamp>2020-01-31T12:30:00Z</RequestTimestamp>
            <RequestorRef>3CC3C04A-20A0-4B12-AC46-5A7843E328A7</RequestorRef>
            <ojp:OJPTripRequest>
				<RequestTimestamp>2020-01-31T12:30:00Z</RequestTimestamp>
                <ojp:Origin>
                    <ojp:PlaceRef>
                        <ojp:StopPlaceRef>8503000</ojp:StopPlaceRef>
                        <ojp:LocationName>
                            <ojp:Text>Bern</ojp:Text>
                        </ojp:LocationName>
                    </ojp:PlaceRef>
                </ojp:Origin>
                <ojp:Destination>
                    <ojp:PlaceRef>
                        <ojp:StopPlaceRef>8505000</ojp:StopPlaceRef>
                        <ojp:LocationName>
                            <ojp:Text>Luzern</ojp:Text>
                        </ojp:LocationName>
                    </ojp:PlaceRef>
                </ojp:Destination>
                <ojp:Params>
                    <ojp:NumberOfResults>10</ojp:NumberOfResults>
                    <ojp:OptimisationMethod>fastest</ojp:OptimisationMethod>
                </ojp:Params>
            </ojp:OJPTripRequest>
        </ServiceRequest>
    </OJPRequest>
</OJP>

<RequestTimestamp>2020-01-31T12:30:00Z</RequestTimestamp>

<MessageIdentifier>756</MessageIdentifier>

<ojp:Origin>
  <ojp:PlaceRef>
    <ojp:StopPlaceRef>8503000</ojp:StopPlaceRef>
    <ojp:LocationName>
      <ojp:Text>Bern</ojp:Text>
    </ojp:LocationName>
  </ojp:PlaceRef>
  <ojp:DepArrTime>2020-01-20T12:00:00Z</ojp:DepArrTime>
</ojp:Origin>

<ojp:Destination>
  <ojp:PlaceRef>
    <ojp:StopPlaceRef>8505000</ojp:StopPlaceRef>
    <ojp:LocationName>
      <ojp:Text>Luzern</ojp:Text>
    </ojp:LocationName>
  </ojp:PlaceRef>
  <ojp:DepArrTime>2020-01-20T12:00:00Z</ojp:DepArrTime>
</ojp:Destination>

<ojp:Via>
	<ojp:ViaPoint>
		<StopPointRef>8506000</StopPointRef>
		<ojp:LocationName>
			<ojp:Text>Winterthur</ojp:Text>
		</ojp:LocationName>
	</ojp:ViaPoint>
</ojp:Via>

<ojp:Params>
	<ojp:IncludeTrackSections>true</ojp:IncludeTrackSections>
	<ojp:IncludeLegProjection>true</ojp:IncludeLegProjection>
	<ojp:IncludeTurnDescription>true</ojp:IncludeTurnDescription>
	<ojp:IncludeAccessibility>true</ojp:IncludeAccessibility>
	<ojp:IncludeIntermediateStops>true</ojp:IncludeIntermediateStops>
	<ojp:IncludeFare>true</ojp:IncludeFare>
</ojp:Params>

Origin/Destination structure

<ojp:PlaceRef>
	<StopPointRef>8530813</StopPointRef>
	<ojp:LocationName>
		<ojp:Text>Zürich Kreuzplatz</ojp:Text>
	</ojp:LocationName>
</ojp:PlaceRef>

<ojp:PlaceRef>
	<StopPointRef>8530813</StopPointRef>
	<ojp:LocationName>
		<ojp:Text>Zürich Kreuzplatz</ojp:Text>
	</ojp:LocationName>
</ojp:PlaceRef>

<ojp:PlaceRef>
	<ojp:GeoPosition>
		<Longitude>8.484003</Longitude>
		<Latitude>47.386135</Latitude>
	</ojp:GeoPosition>
	<ojp:LocationName>
		<ojp:Text>Altstetten</ojp:Text>
	</ojp:LocationName>
</ojp:PlaceRef>

<ojp:PlaceRef>
	<ojp:TopographicPlaceRef>23006351:1</ojp:TopographicPlaceRef>
	<ojp:LocationName>
		<ojp:Text>Bern (Bern)</ojp:Text>
	</ojp:LocationName>
</ojp:PlaceRef>

<ojp:PlaceRef>
	<ojp:PointOfInterestRef>1</ojp:PointOfInterestRef>
	<ojp:LocationName>
		<ojp:Text>unbekannt</ojp:Text>
	</ojp:LocationName>
</ojp:PlaceRef>

<ojp:PlaceRef>
	<ojp:AddressRef>
	      <ojp:AddressCode>streetID:1500000041::23020227:-1:Via al Dosso:Torricella-Taverne:Via al Dosso::Via al Dosso: 6807:ANY:DIVA_STREET:994668:6208464:MRCV:sbb</ojp:AddressCode>
	</ojp:>AddressRef
</ojp:PlaceRef>

<ojp:PlaceRef>
	<StopPointRef>8503003</StopPointRef>
	<ojp:LocationName>
	<ojp:Text>Zürich Stadelhofen</ojp:Text>
	</ojp:LocationName>
</ojp:PlaceRef>

<ojp:DepArrTime>2020-01-20T12:00:00Z</ojp:DepArrTime>

<ojp:TimeAllowance>PT2H</ojp:TimeAllowance>

<ojp:IndividualTransportOptions>
    <ojp:Mode>walk</ojp:Mode>
    <ojp:MaxDistance>5000</ojp:MaxDistance>
    <ojp:MaxDuration>PT1H</ojp:MaxDuration>
    <ojp:Speed>120</ojp:Speed>
</ojp:IndividualTransportOptions>

IndividualTransportOptions

<ojp:Mode>walk</ojp:Mode>

<ojp:MaxDistance>10000</ojp:MaxDistance>

<ojp:MaxDuration>PT2H</ojp:MaxDuration>

<ojp:MinDistance>1</ojp:MinDistance>

<ojp:MinDuration>PT1S</ojp:MinDuration>

<ojp:Speed>1000</ojp:Speed>

Params

<ojp:PtModeFilter>
	<ojp:Exclude>true</ojp:Exclude>
	<ojp:Mode>
		<ojp:PtMode>urbanRail</ojp:PtMode>
	</ojp:Mode>
	<ojp:Mode>
		<ojp:PtMode>bus</ojp:PtMode>
		<ojp:BusSubMode>regionalBus</ojp:BusSubMode>
	</ojp:Mode>
</ojp:PtModeFilter>

<ojp:LineFilter>
    <ojp:Line>
        <LineRef>sbb:92080::R</LineRef>
    </ojp:Line>
    <ojp:Line>
        <LineRef>sbb:91012:B:H</LineRef>
    </ojp:Line>
    <ojp:Exclude>true</ojp:Exclude>
</ojp:LineFilter>

<ojp:OperatorFilter>
    <ojp:Exclude>false</ojp:Exclude>
    <ojp:OperatorRef>sbb:11:SchweizerischeBundesbahnenSBB</ojp:OperatorRef>
</ojp:OperatorFilter>

<ojp:NumberOfResults>10</ojp:NumberOfResults>

<ojp:NumberOfResultsBefore>4</ojp:NumberOfResultsBefore>

<ojp:NumberOfResultsAfter>6</ojp:NumberOfResultsAfter>

<ojp:IgnoreRealtimeData>true</ojp:IgnoreRealtimeData>

<ojp:TransferLimit>3</ojp:TransferLimit>

<ojp:IncludeTrackSections>true</ojp:IncludeTrackSections>

<ojp:IncludeLegProjection>true</ojp:IncludeLegProjection>

<ojp:IncludeTurnDescription>true</ojp:IncludeTurnDescription>

<ojp:IncludeAccessibility>true</ojp:IncludeAccessibility>

<ojp:IncludeIntermediateStops>true</ojp:IncludeIntermediateStops>

<ojp:IncludeFare>true</ojp:IncludeFare>

Response

An example of a complete response: tripresponse

First ojp:TripResponseContext is returned. It contains information on all the places used (stops, locations, addresses, etc.) in the ojp:Places: element

<ojp:Location>
	<ojp:StopPlace>
		<ojp:StopPlaceRef>8591252</ojp:StopPlaceRef>
		<ojp:StopPlaceName>
			<ojp:Text>Zürich, Letzigrund</ojp:Text>
		</ojp:StopPlaceName>
		<ojp:TopographicPlaceRef>23026261:27</ojp:TopographicPlaceRef>
	</ojp:StopPlace>
	<ojp:LocationName>
		<ojp:Text xml:lang="de">Zürich, Letzigrund</ojp:Text>
	</ojp:LocationName>
	<ojp:GeoPosition>
		<siri:Longitude>8.50373</siri:Longitude>
		<siri:Latitude>47.38124</siri:Latitude>
	</ojp:GeoPosition>
</ojp:Location>

In future the context may also include the situations (faults).

This is followed by 0:* TripResult. The header is followed by

<ojp:TripResult>
	<ojp:ResultId>ID-153A06C3-1F00-4048-9141-A217840479A6</ojp:ResultId>
	<ojp:Trip>
		<ojp:TripId>ID-153A06C3-1F00-4048-9141-A217840479A6</ojp:TripId>
		<ojp:Duration>PT29M</ojp:Duration>
		<ojp:StartTime>2020-01-20T11:57:00Z</ojp:StartTime>
		<ojp:EndTime>2020-01-20T12:26:00Z</ojp:EndTime>
		<ojp:Transfers>1</ojp:Transfers>
<!-- ... -->

the individual trips.

If not calculating from and to a stop, the legs leading up to the stop are shown first.

Otherwise a TimedLeg follows.

<ojp:TripLeg>
	<ojp:LegId>1</ojp:LegId>
	<ojp:TimedLeg>
		<ojp:LegBoard>
			<siri:StopPointRef>8591252</siri:StopPointRef>
				<ojp:StopPointName>
					<ojp:Text>Zürich, Letzigrund</ojp:Text>
				</ojp:StopPointName>
				<ojp:ServiceDeparture>
					<ojp:TimetabledTime>2020-01-20T11:57:00Z</ojp:TimetabledTime>
				</ojp:ServiceDeparture>
				<ojp:Order>1</ojp:Order>
		</ojp:LegBoard>
		<ojp:LegIntermediates>
			<siri:StopPointRef>8591038</siri:StopPointRef>
			<ojp:StopPointName>
				<ojp:Text>Zürich, Albisriederplatz</ojp:Text>
			</ojp:StopPointName>
			<ojp:ServiceArrival>
				<ojp:TimetabledTime>2020-01-20T11:59:00Z</ojp:TimetabledTime>
			</ojp:ServiceArrival>
			<ojp:ServiceDeparture>
				<ojp:TimetabledTime>2020-01-20T11:59:00Z</ojp:TimetabledTime>
			</ojp:ServiceDeparture>
			<ojp:Order>2</ojp:Order>
		</ojp:LegIntermediates>
<!-- weitere LegIntermediate --->
		<ojp:LegAlight>
			<siri:StopPointRef>8591105</siri:StopPointRef>
			<ojp:StopPointName>
				<ojp:Text>Zürich, Bürkliplatz</ojp:Text>
			</ojp:StopPointName>
			<ojp:ServiceArrival>
				<ojp:TimetabledTime>2020-01-20T12:13:00Z</ojp:TimetabledTime>
			</ojp:ServiceArrival>
			<ojp:Order>11</ojp:Order>
		</ojp:LegAlight>
		<ojp:Service>
			<ojp:OperatingDayRef>2020-01-20</ojp:OperatingDayRef>
			<ojp:JourneyRef>sbb:91002::H:j20:1253</ojp:JourneyRef>
			<siri:LineRef>sbb:91002:</siri:LineRef>
			<siri:DirectionRef>H</siri:DirectionRef>
			<ojp:Mode>
				<ojp:PtMode>tram</ojp:PtMode>
				<siri:TramSubmode>cityTram</siri:TramSubmode>
				<ojp:Name>
					<ojp:Text xml:lang="de">Tram</ojp:Text>
				</ojp:Name>
			</ojp:Mode>
			<ojp:PublishedLineName>
				<ojp:Text>2</ojp:Text>
			</ojp:PublishedLineName>
			<ojp:OperatorRef>sbb:3849</ojp:OperatorRef>
			<ojp:Attribute>
				<ojp:Text>
					<ojp:Text xml:lang="de">Niederflureinstieg</ojp:Text>
				</ojp:Text>
				<ojp:Code>A__NF</ojp:Code>
			</ojp:Attribute>
			<ojp:DestinationStopPointRef>de:00000:-1</ojp:DestinationStopPointRef>
			<ojp:DestinationText>
				<ojp:Text xml:lang="de">Zürich Tiefenbrunnen, Bahnhof</ojp:Text>
			</ojp:DestinationText>
		</ojp:Service>
	</ojp:TimedLeg>
</ojp:TripLeg>

Comments:

• Real-time data is unfortunately not yet available. Otherwise, the respective details would already have been integrated.
• The XXXRef will gradually be adapted with the new Swiss Identifiers.
• The DestinationStopPointRefs are not ideal yet.
• The attributes are formed from the known attributes from HRDF with A__ .

Some points are stored in extensions:

• Name/text (e.g. “Train“) Train Transport mode (transport mode category, download from https://opentransportdata.swiss/de/dataset/verkehrsmittellisten)
• ShortName/Text (e.g. “IC“) Transport submode abbr. (Offer category short description, download from https://opentransportdata.swiss/de/dataset/verkehrsmittellisten
• PublishedLineName/Text (e.g. “IC8” or “S1”) passenger relevant route text
• TimedLeg.Extension.TransportTypeName/Text (e.g. “InterCity“) Transport submode name (offer category name, download from https://opentransportdata.swiss/de/dataset/verkehrsmittellisten)
• TimedLeg.Extension.PublishedJourneyNumber/Text (e.g. “829”) Train number (train number)
• TimedLeg.Extension.OperatorName/Text (e.g. “Swiss Federal Railways SBB“) OperatorName

TransferLegs are used for changes:

<ojp:TransferLeg>
	<ojp:TransferMode>walk</ojp:TransferMode>
	<ojp:LegStart>
		<siri:StopPointRef>8591105</siri:StopPointRef>
		<ojp:LocationName>
			<ojp:Text xml:lang="de">Zürich, Bürkliplatz</ojp:Text>
		</ojp:LocationName>
	</ojp:LegStart>
	<ojp:LegEnd>
		<siri:StopPointRef>8591105</siri:StopPointRef>
		<ojp:LocationName>
			<ojp:Text xml:lang="de">Zürich, Bürkliplatz</ojp:Text>
		</ojp:LocationName>
	</ojp:LegEnd>
	<ojp:TimeWindowStart>2020-01-20T12:13:00Z</ojp:TimeWindowStart>
	<ojp:TimeWindowEnd>2020-01-20T12:15:00Z</ojp:TimeWindowEnd>
	<ojp:Duration>PT2M</ojp:Duration>
	<ojp:WalkDuration>PT2M</ojp:WalkDuration>
	<ojp:BufferTime>PT0M</ojp:BufferTime>
</ojp:TransferLeg>

Improvements will be necessary particularly for transfers in terms of BehiG (disability equality legislation).

Geographical information used

The walking routes are based on OSM.

The following parts are currently based exclusively on OSM:

• in ContinuousLeg and TransferLeg (TransferMode=walk):
• TrackSection (without coordinates because the LegProjection can only be configured for all leg types together due to missing trip routes)
• TurnAction
• in TimedLeg
• LegIntermediates

Important:

• IncludeAccessibility will only be supported once BehiG enters into force

OJP-TripRequest with Sharing Services

New since August 2022, OJP TripRequest can compute trips which include sharing vehicles (bycicle, eScooter, rental bike or carsharer) at the beginning and/or end (first and/or last mile).

General Notes

The functionality has an experimental character for the time being. Unexpected or less practical travel chains may result. The SKI+ team is happy to receive feedback on this.

As far as possible, elements of the OJP 1.0 standard were used. However, some enhancements had to be implemented by means of extensions. Adjustments are to be expected with regard to the planned new major version OJP 2.0.

The calculations are based on this data source.

As an alternative to the TripRequest, the locations of the sharing vehicles can now be retrieved via the OJPLocationInformationRequest.

Parameters for Configuration of the TripRequest

The query in the TripRequest is controlled via parameters (additional XML elements) in four possible places:

1. Monomodal Trips by Bicyle

Based on the OJP 1.0 standard, <ojp:Params> is supplemented with the element <ojp:ItModesToCover>, having a value “cycle”:

<ojp:ItModesToCover>cycle</ojp:ItModesToCover>

2. Monomodal Trips by eScooter, Bicycle Rental or Car Sharing

<ojp:Params> is supplemented with an extension:

<ojp:Extension> ...
  <ojp:ItModesToCover>escooter_rental</ojp:ItModesToCover> ...
</ojp:Extension>

with the value “escooter_rental”, “bicycle_rental” or “car_sharing”, respectively.

3. Intermodal Trips with Public Transport and Bicycle at the Beginning and/or End

Based on the OJP 1.0 standard, <ojp:Origin> and/or <ojp:Destination> are supplemented with the <ojp:IndividualTransportOptions> element. This defines the mode (cycle), duration min/max in minutes and distance min/max in meters, as shown in the following example.

<ojp:IndividualTransportOptions>
  <ojp:Mode>cycle</ojp:Mode> <!--Fahrrad am Anfang -->
  <ojp:MaxDuration>PT30M</ojp:MaxDuration> <!--Optional: maximum duration-->
  <ojp:MinDuration>PT2M</ojp:MinDuration> <!--Optional: minimum duration-->
  <ojp:MaxDistance>20000</ojp:MaxDistance> <!--Optional: maximum distance-->
  <ojp:MinDistance>100</ojp:MinDistance> <!--Optional: minimum distance-->
</ojp:IndividualTransportOptions>

4. Intermodal Trips with Public Transport and eScooter, Bicycle Rental or Car Sharing at the Beginning and/or End

<ojp:Params> is extended with an extension, with <ojp:Origin> and/or <ojp:Destination> and with mode escooter_rental, bicycle_rental or car_sharing, respectively, as shown in the following example:

<ojp:Extension>
  <ojp:Origin>
    <ojp:Mode>escooter_rental</ojp:Mode> <!--eScooter at beginning-->
    <ojp:MaxDuration>PT30M</ojp:MaxDuration> <!--Optional: maximum duration-->
    <ojp:MinDuration>PT2M</ojp:MinDuration> <!--Optional: minimum duration-->
    <ojp:MaxDistance>20000</ojp:MaxDistance> <!--Optional: maximum distance-->
    <ojp:MinDistance>100</ojp:MinDistance> <!--Optional: minimum distance-->
  </ojp:Origin>
</ojp:Extension>

Overview of Possible Combinations

The following table shows which combinations make sense for monomodal and multimodal trips. (Note: public transport is considered here as one mode, even if including different modes of transport and interchanges):