Aller au contenu

OJPTripInfoRequest

OJPTripInfoRequest

La TripInfoRequest permet de demander des informations supplémentaires sur un «Journey» (convoi).

Explorateur API

Vous pouvez faire des essais en utilisant vos propres requêtes – lien direct vers l’explorateur de l’API.

Request

L’information centrale pour la TripInfoRequest est une ojp:JourneyRef avec ojp:OperatingDayRef – c’est-à-dire une référence sur un Journey précis à une date donnée. La JourneyRef figure dans la Response à une autre requête (p. ex. TripRequest ou StopEventRequest).

Élément Cardinalité Description Exemple
RequestTimestamp 1:1 Timestamp de la requête. De préférence en heure UTC.
MessageIdentifier 0:1 Identifiant du message. De préférence en ordre croissant.
JourneyRef 0:1 Référence du trajet.

La référence peut être déterminée via une TripRequest ou une StopEventRequest.

 

OperatingDayRef 0:1 Au format AAAA-MM-JJ

 

siri:VehicleRef 0:1 n.d.

Cet attribut n’est pas disponible.

n.d.
TimeOfOperation 0:1 n.d.

Cet attribut n’est pas disponible.

n.d.
Params 0:1 Autres paramètres pour la requête.
Params/UseTimetableDataOnly 0:1 Faut-il renoncer aux données en temps réel? La valeur par défaut est «false».
Params/IncludeCalls 0:1 Les «Calls» (arrêts intermédiaires) doivent-ils être intégrés? La valeur par défaut est «true».
Params/IncludePosition 0:1 La position actuelle du train doit-elle être intégrée?
Cet attribut n’est pas disponible.
n.d.
Params/IncludeService 0:1 La Service-Information doit-elle être intégrée (LineRef, Mode, OperatorRef,..)? La valeur par défaut est «true».
Params/IncludeTrackSections 0:1 Les informations géographiques sur l’itinéraire doivent-elles être intégrées? La valeur par défaut est «false».
Params/IncludeTrackProjection 0:1 Les projections de coordonnées doivent-elles être communiquées?
Cet attribut est envisagé.

Response

Tout en haut du contenu à proprement parler, on peut lire le TripInfoResponseContext; il s’agit principalement d’informations sur les «Places» (lieux) utilisés – pour une description détaillée, cf. OJPTripRequest.

TripInfoResult

Attention: les éléments ci-dessous peuvent figurer ou non dans la réponse, en fonction des paramètres définis. Il est donc conseillé de vérifier les paramètres de la requête pour obtenir (ou non) les différents éléments.

Exemple de réponse complète: TripInfoRequest_example_response

Après le contexte apparaît le Journey lui-même: d’abord toutes les haltes avec les PreviousCalls (haltes précédentes) et les OnwardCalls (haltes suivantes). Il est possible qu’il y ait plus de haltes que dans la TripRequest émise en vue de la détermination de la JourneyRef, car la TripInfoRequest fournit toujours la totalité du convoi.

Si, dans la Request, les données en temps réel n’ont pas été exclues au moyen de l’élément UseTimetableDataOnly=true, les informations en temps réel (EstimatedTime, EstimatedQuay) disponibles sont fournies en plus de l’heure et de la voie indiquées dans l’horaire pour le départ et l’arrivée (TimetabledTime, Planned Quay).

Exemple: pour une TripRequest de Berne à Zurich, la TripInfoRequest correspondante pourrait proposer un convoi de Genève à Saint-Gall, puisque celui-ci inclut le tronçon Berne – Zurich.

Viennent ensuite les informations sur le Service: LineRef, Mode (type de transport), OperatorRef, etc.

Puis le JourneyTrack (paramètre dans la requête: IncludeTrackSections) donne des informations géographiques sur le Journey.

Enfin, la réponse se termine par une extension qui comporte actuellement comme seule information le numéro publié (dans l’exemple, «319», car il s’agit de l’EC 319).