Aller au contenu

TripRequest (TRIAS 2020)

(TRIAS TripRequest)

TripRequest est un open service (API). Il s’agit d’un type de prévision relative au trajet (un deuxième type étant TripInfoRequest). Il correspond au service « TripRequest » de VDV431.

Description technique

TripRequest offre une fonctionnalité de planificateur d’itinéraire. Données d’entrée nécessaires sont les arrêts de départ et d’arrivée. En plus, il est possible d’en ajouter l’heure de départ ou d’arrivée.

L’implémentation des CFF ne trouve que des trajets directs (sans changement de train ou de moyen de transport) :

  • Berne – Olten fournit un résultat, ils existent des trajets directs.
  • Lausanne – Chur ne fournit pas de résultat, il faut toujours changer de train.

 

Concepts importants

  • Halte : Les jeux de données suivants seront d’utilité : DiDok et la liste des gares
  • Trajet / voyage : Un trajet comprend le transport suivant un certain itinéraire et une certaine liaison selon l’horaire, à une certaine heure, utilisant un certain moyen de transport, dans une certaine direction.
  • Horaire : L’horaire, dans le contexte des transports publics (ainsi que du transport des marchandises sur rail), détermine l’itinéraire d’un moyen de transport. Il définit en plus les numéros des trains, les jours de service, la route, les heures d’arrivée, de départ et de passage pour toutes les haltes, ainsi que les vitesses permises dans les différents secteurs.
  • Pronostic : Un pronostic est une prévision des heures d’arrivée et de départ en tenant compte de la position actuelle du moyen de transport ainsi que des conflits résultant d’un retard et les décisons prévues qui en suivent dans les prochaines x minutes et leurs effets. Pour des prévisions plus loins dans le futur, une méthode plus simple est appliquée.
  • Moyen de transport : Soit portant la signification « type de véhicule » (train, bateau, tram, bus) ou la signification « système de transport » (transports publics, etc.).
  • DateTime dans Response : Il’s agit de l’« heure Zoulou » dans tous les cas (c.-à.-d. UTC). Pour obtenir l’heure locale suisse, il faut ajouter deux heures en été, une heure en hiver.

Détails techniques

API Explorer

Autorisation et Open Services

Afin de pouvoir accéder l’API vous avez besoin d’une clé API. Elle peut être obtenue par le portail développeurs.

La clé doit être incluse comme « Authorization » dans le header HTTP.

L’URL pour y accéder

API: https://api.opentransportdata.swiss/trias2020

Clé d’essai : 57c5dbbbf1fe4d000100001842c323fa9ff44fbba0b9b925f0c052d1

En spécifiant le header contenant l’autorisation et Content-Type= „text/XML“ ou „application/XML“

Authorization header

Exemple d’une requête

On spécifie, entre autres, la halte de départ et la halte d’arrivée (numéro DiDok), ainsi que l’heure de départ ou d’arrivée souhaitée (sans indication : départ immédiat). La réponse fournit de données temps réel, si disponibles.

La requête est transmise comme body.

Explication détaillée de la requête

Les éléments principaux de la requête :

nom obligatoire? description exemple
Origin oui Données spécifiant le lieu de départ
 
LocationRef oui
StopPointRef oui La halte, numéro DiDok 8500320
DepArrTime non L’heure de départ ou d’arrivée. Si l’élément manque : l’heure actuelle 2020-08-01T09:11:40
Via non, plusieurs Un ou plusieurs lieux via. Les via devront être visités dans la séquence indiquée. Le serveur a la liberté de remplacer une halte via par une autre halte équivalente.

Attention : Ne pas implémenté dans le système actuel

NoChangeAt non, plusieurs Pas de changement à ces haltes

Attention : Ne pas implémenté dans le système actuel

Destination oui Données spécifiant le lieu d’arrivée

Même structure que Origin

Params non … voir la tabelle suivante

Params :

nom obligatoire? description exemple
IncludeTrackSections non Affichage des TrackSections. Valeur par défaut = true.

Implémentation partielle (un seul track), ne pas vraiment intéressant

true
IncludeLegProjection non Attention : Ne pas implémenté true
IncludeIntermediateStops non Implémenté, mais il manque l’affichage des intermediate stops. true
NumberOfResults non Nombre des trajets dans la réponse. Valeur par défaut = 3. C’est aussi le nombre minimal, même si une valeur inférieure à 3 a été spécifiée. 20

Les paramètre suivants (définis dans VDV432) n’étaient pas implémentés dans la version précédente de TRIAS. L’état de situation pour TRIAS2020 n’est pas encore suffisamment clair et documenté à l’heure actuelle (octobre 2020). La liste suivante ne correspond donc potentiellement pas à l’état actuel. Une mise à jour est prévue dans les mois à venir.

  • PtModeFilter: Filter nach Verkehrsmitteltypen
  • LineFilter: Erlaubte Linien (ggf. verfeinert auf Richtungen)
  • OperatorFilter: Filter nach Verkehrsunternehmen
  • NoSingleStep: Legt fest, ob der Benutzer eine Stufe bewältigen kann. Falls nein, wird dieser Parameter auf true gesetzt.
  • NoStairs: Legt fest, ob der Benutzer eine Treppe bewältigen kann. Falls nein, wird dieser Parameter gesetzt.
  • NoEscalator: Legt fest, ob der Benutzer eine Rolltreppe benutzen kann. Falls nein, wird dieser Parameter gesetzt.
  • NoElevator: legt fest, ob der Benutzer einen Aufzug benutzen kann. Falls nein, wird dieser Parameter gesetzt.
  • NoRamp: Legt fest, ob der Benutzer eine Rampe bewältigen kann. Falls nein, wird dieser Parameter gesetzt.
  • LevelEntrace: Legt fest, ob der Benutzer beim Ein- und Aussteigen in und aus Fahrzeugen einen ebenen Zugang benötigt. Dazu reicht u.U. auch ein Hublift am Fahrzeug oder am Bahnsteig. Falls der ebene Zugang notwendig ist, wird dieser Parameter gesetzt.
  • BikeTransport: Legt fest, ob der Benutzer ein Fahrrad an Bord der Verkehrsmittel mitnehmen will. Falls ja, wird dieser Parameter gesetzt.
  • WalkSpeed: Veränderung der Standardgehgeschwindigkeit in Prozent. Der Wert 100 stellt den Standard dar. Werte kleiner 100 stellen eine langsamere Geschwindigkeit dar, Werte grösser 100 eine schnellere.
  • IgnoreRealtime Data: Wenn dieser Parameter gesetzt ist, sollen in der Verbindungssuche keine Echtzeitdaten oder Störungsinformationen sondern nur Sollfahrplandaten berücksichtigt werden.
  • ImmediateTripStart: Wenn dieser Parameter gesetzt ist, soll die zu suchende Verbindung unmittelbar an der angegeben Startsituation beginnen. Eine Optimierung der Abfahrtszeit am Start nach der Regel « Starte so spät wie möglich, solange nur die gleiche Ankunftszeit am Ziel gewährleistet ist », ist dann nicht notwendig.
  • InterchangeLimit: Anzahl der maximal zugelassenen Umsteigevorgänge. Achtung: Dieser Parameter wird ignoriert.
  • AlgorithmType: Art der Zielfunktion, nach der der Algorithmus die Verbindung optimieren soll: fastest, minChanges, leastWalking, leastCost
  • ItModesToCover: Für jeden IV-Typ in dieser Liste soll eine eigene monomodale Verbindung gefunden werden – zusätzlich zu den intermodalen Verbindungen.
  • IncludeTurnDescription: Legt fest, ob im Resultat Routenhinweise mit Abbiegeempfehlungen mit ausgegeben werden sollen. Default ist false. Parameter wird ignoriert.
  • IncludeAccessibilitiy: Legt fest, ob im Resultat Informationen zur Barrierefreiheit mit ausgegeben werden sollen. Default ist false. Parameter wird ignoriert.
  • IncludeFares: Legt fest, ob im Resultat Tarifinformationen mit ausgegeben werden sollen. Default ist false. Parameter wird ignoriert.
  • IncludeOperatingDays: Legt fest, ob im Resultat Informationen zu den Verkehrstagen mit ausgegeben werden sollen. Default ist false.
  • FaresParam: Parameter für die Tarifermittlung. Parameter werden ignoriert.
  • Extension: Erweiterungen. Keine umgesetzt.

Explication d’une réponse

Structure d’une réponse :

Les éléments de la réponse :

  • TripResponse: la réponse …
  • … qui contient des TripResults

Ce qu’on retrouve dans un TripResult:

Trip

nom obligatoire? description exemple
ResultID oui Id à usage interne ID-95725E00-4D45-4651-99A7-3BB4AFFA4E0D
TripID oui Id à usage interne ID-95725E00-4D45-4651-99A7-3BB4AFFA4E0D
Duration oui Durée complète en minutes 7
StartTime oui L’heure de départ, heure Zoulou 2020-08-01T07:19:00Z
EndTime oui L’heure d’arrivée, heure Zoulou 2020-08-01T07:26:00Z
Interchanges oui Nombe de changements 0

TripLeg

nom obligatoire? description exemple
LegID oui Nunéro courant du Leg

Toujours 1 dans l’implémentation des CFF.

1
TimedLeg oui VDV431 connait différents types de Legs. L’implémentation actuelle n’utilise que TimedLeg.
LegBoard oui Le lieu où se trouve le Leg
StopPointRef oui Numéro Didok 8500320
StopPointName oui Le nom associé au numéro DiDok.

Attention: La langue doit être DE (allemand).

ServiceDeparture oui Une structure heure de départ
TimetabledTime oui L’heure de départ selon l’horaire 20200801T07:19:00Z
EstimatedTime non L’heure de départ selon le pronostic. Pour les étapes dans le passé il s’agit soit du dernier pronostic qui a été calculé, soit de données réelles (Ist-Daten). 20200801T07:19:00Z
EstimatedBay non Nom du secteur de l’halte où on monte ou descend du véhicule. Selon l’état actuel de planification.

Planned Bay non Nom du secteur de l’halte où on monte ou descend du véhicule. Selon le dernier pronostic.

StopSequenceNumber oui Numéro courant du Stop 1
LegIntermediate non Même structure que LegBoard, pour une halte intermédiaire. Contient ServiceDeparture et ServiceArrival comme données temporelles.
LegAlight oui Même structure que LegBoard, pour l’halte d’arrivée. Contient Servicearrival comme seule donnée temporelle.
Service oui Données concernant les services liée au Leg
LegTrack non Description géométrique du trajet en détail.

Service

Pour une description de la structure « Service » veuillez consulter cette page.

Erreurs / problèmes

La réponse fournit une « ErrorMessage » en cas de problème lors de l’exécution de la requête :

Remarques

Important à savoir, surtout pour des développeurs extérieurs :

  • EstimatedBay et PlannedBay contiennent les informations concernant les voies planifiées par les systèmes. Dans ce contexte, les voies « 12 » et « 12A » sont traitées comme deux voies différentes. EstimatedBay pour la gare de Zürich HB peut être « 41/41 » tandis que plus tard, PlannedBay peut être précisé comme «41  ».
  • Pour des raisons techniques, le service ne trouve que des liasons directes.
  • Ne tient pas en compte des métahaltes. Le service trouve un résultat pour la requête Wankdorf à Berne – mais ne trouve pas de résultat pour Wankdorf, Bahnhof àBerne.
  • Des trajets supprimés sont ignorés (contrairement au cas du StopEvent).

Pour en savoir plus