Table des matières

Rechercher sur le site

OJPTripInfoRequest

#AutoTranslate

Description rapide

La TripInfoRequest permet de demander des informations complémentaires sur un «Journey».

Description technique

Explorateur de l’API

Vous pouvez essayer 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 à un Journey défini sur un jour civil. La JourneyRef doit être reprise de la Response à une autre requête (p. ex. TripRequest ou StopEventRequest).

<?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-20T12:00:00Z</RequestTimestamp>
			<RequestorRef>IRMA</RequestorRef>
			<ojp:OJPTripInfoRequest>
				<RequestTimestamp>2020-01-20T12:00:00Z</RequestTimestamp>
				<MessageIdentifier>756</MessageIdentifier>
				<ojp:JourneyRef>qv1:91011::H:j20:500</ojp:JourneyRef>
				<ojp:OperatingDayRef>2020-01-20</ojp:OperatingDayRef>
				<ojp:Params>
					<ojp:IncludeCalls>true</ojp:IncludeCalls>
					<ojp:IncludePosition>false</ojp:IncludePosition>
					<ojp:IncludeService>true</ojp:IncludeService>
					<ojp:IncludeTrackSections>true</ojp:IncludeTrackSections>
					<ojp:IncludeTrackProjection>true</ojp:IncludeTrackProjection>
				</ojp:Params>
			</ojp:OJPTripInfoRequest>
		</ServiceRequest>
	</OJPRequest>
</OJP>

Élément Cardinalité Description Exemple
RequestTimestamp 1:1 Horodatage de la demande. De préférence, heure UTC. 
<RequestTimestamp>2020-01-20T12:00:00Z</RequestTimestamp>
MessageIdentifier 0:1 Identifiant de l’annonce. De préférence en hausse constante. 
<MessageIdentifier>756</MessageIdentifier>
JourneyRef 0:1 Référence à la course.

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

 
<ojp:JourneyRef>qv1:91011::H:j20:500</ojp:JourneyRef>

 
OperatingDayRef 0:1 Au format AAAA-MM-JJ 
<ojp:OperatingDayRef>2020-01-20</ojp:OperatingDayRef>

 
siri:VehicleRef 0:1 n. a.

Cette fonctionnalité n’est pas disponible.

 n. a.
TimeOfOperation 0:1 n. a.

Cette fonctionnalité n’est pas disponible.

 n. a.
Params 0:1 Autres paramètres pour la demande
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 ajoutés? La valeur par défaut est true.
Params/IncludePosition 0:1 Voulez-vous insérer la position actuelle du train?

Cette fonctionnalité n’est pas disponible.

 n. a.
Params/IncludeService 0:1 La Service-Information doit-elle être insérée (LineRef, Mode, OperatorRef,..)? La valeur par défaut est true.
Params/IncludeTrackSections 0:1 Faut-il ajouter des informations géographiques sur l’itinéraire? La valeur par défaut est «false».
Params/IncludeTrackProjection 0:1 Les projections de coordonnées doivent-elles également être transmises?

Cette fonctionnalité est à l’étude.

Réponse

Tout en haut (du contenu à proprement parler) TripInfoResponseContext fourni, en particulier des informations sur les «lieux» utilisés – voir description plus détaillée dans OJPTripRequest

<ojp:TripInfoResponseContext>
    <ojp:Places>
        <ojp:Location>
            <ojp:StopPlace>
                <ojp:StopPlaceRef>8503000</ojp:StopPlaceRef>
                <ojp:StopPlaceName>
                    <ojp:Text>Zürich HB</ojp:Text>
                </ojp:StopPlaceName>
                <ojp:PrivateCode>
                    <ojp:System>EFA</ojp:System>
                    <ojp:Value>104014:0:8</ojp:Value>
                </ojp:PrivateCode>
                <ojp:TopographicPlaceRef>23026261:27</ojp:TopographicPlaceRef>
            </ojp:StopPlace>
            <ojp:LocationName>
                <ojp:Text xml:lang="de">Zürich HB</ojp:Text>
            </ojp:LocationName>
            <ojp:GeoPosition>
                <siri:Longitude>8.54021</siri:Longitude>
                <siri:Latitude>47.37818</siri:Latitude>
            </ojp:GeoPosition>
        </ojp:Location>
<!-- ... -->
    </ojp:Places>
</ojp:TripInfoResponseContext>

TripInfoRésultat

Attention: Selon les paramètres définis, les éléments énumérés ci-dessous apparaissent ou non dans la réponse. Il est donc nécessaire de vérifier les paramètres dans la requête afin d’obtenir (ou non) certaines parties.

Exemple de réponse complète: TripInfoRequest_example_response

Après le contexte apparaît le Journey lui-même; d’abord tous les arrêts avec Visioconférences préalables (arrêts précédents) et Onward Call (arrêts suivants). Il peut y avoir plus d’arrêts que dans la TripRequest utilisée pour déterminer la JourneyRef, car la TripInfoRequest fournit à chaque fois le convoi complet.

Si les données en temps réel n’ont pas été exclues dans la requête avec UseTimetableDataOnly=true, des données en temps réel (EstimatedTime, EstimatedQuay) sont fournies (si disponibles) en plus de l’heure et de la voie de départ/d’arrivée prévues dans l’horaire (TimetabledTime, Planned Quay).

Exemple: Dans le cas d’une TripRequest de Berne à Zurich, la TripInfoRequest correspondante pourrait fournir un convoi de Genève à Saint-Gall, dont le tronçon Berne–Zurich constitue un sous-ensemble.

<ojp:TripInfoResult>
    <ojp:PreviousCall>
        <siri:StopPointRef>8503000</siri:StopPointRef>
        <ojp:StopPointName>
            <ojp:Text>Zürich HB</ojp:Text>
        </ojp:StopPointName>
        <ojp:PlannedQuay>
            <ojp:Text xml:lang="de">8</ojp:Text>
        </ojp:PlannedQuay>
        <ojp:EstimatedQuay>
            <ojp:Text xml:lang="de">9</ojp:Text>
        </ojp:EstimatedQuay>
        <ojp:ServiceDeparture>
            <ojp:TimetabledTime>2020-07-13T13:32:00Z</ojp:TimetabledTime>
            <ojp:EstimatedTime>2020-07-13T13:32:00Z</ojp:EstimatedTime>
        </ojp:ServiceDeparture>
        <ojp:Order>1</ojp:Order>
    </ojp:PreviousCall>
    <ojp:PreviousCall>
        <siri:StopPointRef>8502204</siri:StopPointRef>
        <ojp:StopPointName>
            <ojp:Text>Zug</ojp:Text>
        </ojp:StopPointName>
        <ojp:PlannedQuay>
            <ojp:Text xml:lang="de">4</ojp:Text>
        </ojp:PlannedQuay>
        <ojp:ServiceArrival>
            <ojp:TimetabledTime>2020-07-13T13:56:00Z</ojp:TimetabledTime>
            <ojp:EstimatedTime>2020-07-13T13:57:00Z</ojp:EstimatedTime>
        </ojp:ServiceArrival>
        <ojp:ServiceDeparture>
            <ojp:TimetabledTime>2020-07-13T13:58:00Z</ojp:TimetabledTime>
            <ojp:EstimatedTime>2020-07-13T13:59:00Z</ojp:EstimatedTime>
        </ojp:ServiceDeparture>
        <ojp:Order>2</ojp:Order>
    </ojp:PreviousCall>
<!-- ... -->
    <ojp:OnwardCall>
        <siri:StopPointRef>8505300</siri:StopPointRef>
        <ojp:StopPointName>
            <ojp:Text>Lugano</ojp:Text>
        </ojp:StopPointName>
        <ojp:PlannedQuay>
            <ojp:Text xml:lang="de">3</ojp:Text>
        </ojp:PlannedQuay>
        <ojp:ServiceArrival>
            <ojp:TimetabledTime>2020-07-13T15:56:00Z</ojp:TimetabledTime>
            <ojp:EstimatedTime>2020-07-13T15:52:00Z</ojp:EstimatedTime>
        </ojp:ServiceArrival>
        <ojp:Order>8</ojp:Order>
    </ojp:OnwardCall>
<!-- ... -->
</ojp:TripInfoResult>
+

Ensuite, les informations sur Service: LineRef, Mode (type d’acheminement), OperatorRef, etc.

<ojp:TripInfoResult>
<!-- ... -->
    <ojp:Service>
        <ojp:OperatingDayRef>2020-07-13</ojp:OperatingDayRef>
        <ojp:JourneyRef>ojp:91002:F:R:j20:205</ojp:JourneyRef>
        <siri:LineRef>ojp:91002:F</siri:LineRef>
        <siri:DirectionRef>R</siri:DirectionRef>
        <ojp:Mode>
            <ojp:PtMode>rail</ojp:PtMode>
            <siri:RailSubmode>local</siri:RailSubmode>
            <ojp:Name>
                <ojp:Text xml:lang="de">Zug</ojp:Text>
            </ojp:Name>
            <ojp:ShortName>
                <ojp:Text xml:lang="de">IC</ojp:Text>
            </ojp:ShortName>
        </ojp:Mode>
        <ojp:PublishedLineName>
            <ojp:Text>2</ojp:Text>
        </ojp:PublishedLineName>
        <ojp:OperatorRef>ojp:11</ojp:OperatorRef>
        <ojp:OriginStopPointRef>8503000</ojp:OriginStopPointRef>
        <ojp:OriginText>
            <ojp:Text xml:lang="de">Zürich HB</ojp:Text>
        </ojp:OriginText>
        <ojp:DestinationStopPointRef>8505300</ojp:DestinationStopPointRef>
        <ojp:DestinationText>
            <ojp:Text xml:lang="de">Lugano</ojp:Text>
        </ojp:DestinationText>
    </ojp:Service>
<!-- ... -->
</ojp:TripInfoResult>

Ensuite, cliquer sur JourneyTrack (paramètre dans la requête: IncludeTrackSections) informations géographiques sur le Journey.

<ojp:TripInfoResult>
<!-- ... --> 
	<ojp:JourneyTrack>
		<ojp:TrackSection>
			<ojp:TrackStart>
				<siri:StopPointRef>8503000</siri:StopPointRef>
				<ojp:LocationName>
					<ojp:Text xml:lang="de">Zürich HB</ojp:Text>
				</ojp:LocationName>
			</ojp:TrackStart>
			<ojp:TrackEnd>
				<siri:StopPointRef>8505307</siri:StopPointRef>
				<ojp:LocationName>
					<ojp:Text xml:lang="de">Chiasso</ojp:Text>
				</ojp:LocationName>
			</ojp:TrackEnd>
			<ojp:Length>220041</ojp:Length>
		</ojp:TrackSection>
	</ojp:JourneyTrack>
</ojp:TripInfoResult>

La dernière information de l’extension est actuellement le numéro publié (dans l’exemple ci-dessous, «319», car il s’agit de l’EC 319).

<ojp:TripInfoResult>
<!-- ... -->
    <ojp:Extension>
        <ojp:TransportTypeName>
            <ojp:Text xml:lang="de"></ojp:Text>
        </ojp:TransportTypeName>
        <ojp:PublishedJourneyNumber>
            <ojp:Text xml:lang="de">319</ojp:Text>
        </ojp:PublishedJourneyNumber>
    </ojp:Extension>
</ojp:TripInfoResult>