Requirements for timetable data
Service journeys
The result from our journey planner is a list of trip patterns, which is basically a list of suggested legs with
(serviceJourneyId, fromStopPlaceId, toStopPlaceId), based on the timetable data you have uploaded to Entur. This, and
any information present in the Service Journeys you uploaded can be used when Entur calls your Sales API to retrieve
offers.
Important: all parameters your Sales API requires must be derivable from the information in the Service Journeys, from static configuration parameters or from the request made by the user. For instance, if your Sales API is based on OSDM, offer requests are usually mapped as follows:
| OSDM Offer request | Timetable data |
|---|---|
| TripSpecification.legs.timedLeg.service.vehicleNumbers | ServiceJourney.privateCode or ServiceJourney.id |
| TripSpecification.legs.timedLeg.service.carriers | ServiceJourney.line.authority |
| TripSpecification.legs.timedLeg.service.mode | ServiceJourney.transportMode |
| TripSpecification.legs.timedLeg.service.productCategory | ServiceJourney.transportSubmode |
| TripSpecification.legs.timedLeg.service.start.stopPlaceRef | TripPattern.fromStopPlaceId |
| TripSpecification.legs.timedLeg.service.start.serviceDeparture.timetabledTime | ServiceJourney.estimatedCalls[].aimedDepartureTime |
| TripSpecification.legs.timedLeg.service.end.stopPlaceRef | TripPattern.toStopPlaceId |
| TripSpecification.legs.timedLeg.service.end.serviceArrival.timetabledTime | ServiceJourney.estimatedCalls[].aimedArrivalTime |
In the timetable data, all stop places must be present in the National Stop Place Register (NSR). Stop places in this
register have IDs on the format NSR:StopPlace:1234. We will use the same IDs as parameters to your Sales API. If this
is impossible, you must provide a mapping between the IDs used in your Sales API and the official NSR Stop Place IDs.
Dated service journeys
If you offer seat reservations, Dated Service Journeys are required. Entur uses the DatedServiceJourney ID to store seat reservations. If there is no Dated Service Journey for a particular departure, the consequence is that the user will not be able to change or see seat reservations in Entur's sales channels.
Journey planning
The timetable data you deliver will be used for journey planning. If your data indicates that it is possible to travel between A and C by using service journey 1 between A and B and then service journey 2 between B and C, this combination will be presented as a travel suggestion. If there are reasons why you think it should not, you must encode this in the timetable data.
Examples:
- Minimum transfer time. If there is enough time to walk between the stops for the first and second service journey, we will suggest the transfer. However, certain transfers may require a little more time if it is a busy station, if delays are common or the second service journey may depart ahead of schedule.
- Transfer not recommended. If both service journeys stop at several of the same stop places, transfer could be possible at either one stop place. However, if one of them is along a heavily trafficked road in a stop place without shelter and the other one is a bus terminal, the first transfer should be prohibited.
- Alight or board only stops. To prevent local travels on long haul service journeys, stops are often marked as "alighting only" or "boarding only".
By encoding restrictions into the timetable data you can control which travel suggestions Entur's journey planner shows. It is important to do this well, since travel suggestions that cannot be sold leads to many enquiries with customer support.