OJPTripRefineRequest 2.0

#AutoTranslate

Description rapide

La TripRefineRequest permet d’actualiser un Trip qui a été précédemment trouvé via une TripRequest. Il est possible de mettre à jour l’intégralité du Trip ou seulement certaines «Legs» du Trip. La TripRefineRequest est notamment utilisée pour consulter des heures de départ et d’arrivée en évolution.

Description technique

Explorateur de l’API

Vous pouvez personnaliser les requêtes selon vos souhaits et essayer les modèles dans l’API ouverte – lien direct vers l’explorateur d’API.

TripRefineRequest

Les informations centrales pour envoyer une TripRefineRequest sont le Trip-ID, TimetabledTime et siri:StopPointRef ainsi que d’autres champs détaillés ci-dessous. De plus amples informations sur la structure d’une TripRefineRequest peuvent être consultées dans la description du TripRefineRequests au niveau du VDV ci-dessous. Exemple de TripRefineRequest conforme à la norme XSD:

<?xml version="1.0" encoding="UTF-8"?>
<OJP xmlns="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" version="2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vdv.de/ojp OJP_changes_for_v1.1/OJP.xsd">
	<OJPRequest>
		<siri:ServiceRequest>
			<siri:RequestTimestamp>2025-01-16T15:32:24.500Z</siri:RequestTimestamp>
			<siri:RequestorRef>SKIPlusRegTests</siri:RequestorRef>
			<OJPTripRefineRequest xmlns="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vdv.de/ojp OJP_changes_for_v1.1/OJP.xsd">
				<siri:RequestTimestamp>2025-01-16T15:32:24.500Z</siri:RequestTimestamp>
				<siri:MessageIdentifier>TRR-1</siri:MessageIdentifier>
				<RefineParams>
					<RefineLegRef/>
					<IncludeIntermediateStops>true</IncludeIntermediateStops>
				</RefineParams>
				<TripResult>
					<Id>ID-6F1F1CE3-AD63-44EA-82D7-72B1B5A1A9FA</Id>
					<Trip>
						<Id>ID-6F1F1CE3-AD63-44EA-82D7-72B1B5A1A9FA</Id>
						<Duration>PT55M6S</Duration>
						<StartTime>2025-04-15T05:26:30Z</StartTime>
						<EndTime>2025-04-15T06:21:36Z</EndTime>
						<Transfers>0</Transfers>
						<Leg>
							<Id>1</Id>
							<TimedLeg>
								<LegBoard>
									<siri:StopPointRef>ch:1:sloid:6208:2:3</siri:StopPointRef>
									<StopPointName>
										<Text xml:lang="de">Uzwil</Text>
									</StopPointName>
									<ServiceDeparture>
										<TimetabledTime>2025-04-15T05:25:00Z</TimetabledTime>
									</ServiceDeparture>
								</LegBoard>
								<LegAlight>
									<siri:StopPointRef>ch:1:sloid:3000:500:32</siri:StopPointRef>
									<StopPointName>
										<Text xml:lang="de">Zürich</Text>
									</StopPointName>
									<ServiceArrival>
										<TimetabledTime>2025-04-15T06:21:00Z</TimetabledTime>
									</ServiceArrival>
								</LegAlight>
								<Service>
									<OperatingDayRef>2025-04-15</OperatingDayRef>
									<JourneyRef>ch:1:sjyid:100001:710-001</JourneyRef>
									<siri:LineRef>ojp:91001:D</siri:LineRef>
									<siri:DirectionRef>H</siri:DirectionRef>
									<Mode>
										<PtMode>rail</PtMode>
									</Mode>
									<ProductCategory>
										<ProductCategoryRef>23</ProductCategoryRef>
									</ProductCategory>
									<PublishedServiceName>
										<Text>IC1</Text>
									</PublishedServiceName>
								</Service>
							</TimedLeg>
						</Leg>
					</Trip>
				</TripResult>
			</OJPTripRefineRequest>
		</siri:ServiceRequest>
	</OJPRequest>
</OJP>

Le système peut déjà affecter correctement un Trip avec un peu moins d’informations. Voici un exemple: TripRefineRequest, qui n’est pas conforme à la norme XSD, mais qui fonctionne également:

<?xml version="1.0" encoding="UTF-8"?>
<OJP xmlns="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" version="2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vdv.de/ojp OJP_changes_for_v1.1/OJP.xsd">
	<OJPRequest>
		<siri:ServiceRequest>
			<siri:RequestTimestamp>2025-01-16T15:32:24.500Z</siri:RequestTimestamp>
			<siri:RequestorRef>SKIPlusRegTests</siri:RequestorRef>
			<OJPTripRefineRequest xmlns="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vdv.de/ojp OJP_changes_for_v1.1/OJP.xsd">
				<siri:RequestTimestamp>2025-01-16T15:32:24.500Z</siri:RequestTimestamp>
				<siri:MessageIdentifier>TRR-1</siri:MessageIdentifier>
				<TripResult>
					<Trip>
						<Id>ID-6F1F1CE3-AD63-44EA-82D7-72B1B5A1A9FA</Id>
						<Leg>
							<Id>1</Id>
							<TimedLeg>
								<LegBoard>
									<siri:StopPointRef>ch:1:sloid:6208:2:3</siri:StopPointRef>
									<ServiceDeparture>
										<TimetabledTime>2025-04-15T05:25:00Z</TimetabledTime>
									</ServiceDeparture>
								</LegBoard>
								<LegAlight>
									<siri:StopPointRef>ch:1:sloid:3000:500:32</siri:StopPointRef>
									<ServiceArrival>
										<TimetabledTime>2025-04-15T06:21:00Z</TimetabledTime>
									</ServiceArrival>
								</LegAlight>
								<Service>
									<OperatingDayRef>2025-04-15</OperatingDayRef>
									<JourneyRef>ch:1:sjyid:100001:710-001</JourneyRef>
									<siri:LineRef>ojp:91001:D</siri:LineRef>
									<siri:DirectionRef>H</siri:DirectionRef>
									<Mode/>
									<ProductCategory>
										<ProductCategoryRef>23</ProductCategoryRef>
									</ProductCategory>
								</Service>
							</TimedLeg>
						</Leg>
					</Trip>
				</TripResult>
			</OJPTripRefineRequest>
		</siri:ServiceRequest>
	</OJPRequest>
</OJP>

Dans le deuxième exemple, les paramètres suivants n’ont pas été utilisés: Tous les «RefineParams», «Duration», «StartTime», «EndTime», «Transfers», tous les «StopPointName», «PublishedServiceName» et le paramètre «Mode» peuvent également être vides. Tous ces paramètres ne sont pas utilisés pour trouver le bon Trip permettant d’interroger les données actuelles.

Description des paramètres

Les éléments des OJPTripRefineRequestStructure:

Élément	Cardinalité	Description	Exemple
`siri:RequestTimestamp`	1:1	Timestamp de la requête. De préférence en heure UTC.	<siri:RequestTimestamp>2025-02-18T15:41:28.717Z</siri:RequestTimestamp>
`siri:MessageIdentifier`	0:1	Identifiant de l’annonce. De préférence en ordre croissant.	<siri:MessageIdentifier>SER-1a</siri:MessageIdentifier>
`RefineParams`	0:1	Options permettant de contrôler l’actualisation.	`<RefineParams>`
`TripResult`	1:1	Trip qui doit être actualisé (refined).	Voir l’exemple ci-dessus!
`TripResponseContext`	0:1	Contexte contenant les objets référencés dans la réponse.
`RefineParams/ RefineLegRef`	0:*	Fait référence aux legs que le serveur doit affiner. Si aucune n’est spécifiée, toutes les legs sont affinées (si le système peut les affiner).
`RefineParams/ UseRealtimeData`	0:1	Détermine comment le Realtime est pris en compte, full = tout; explanatory = également les retards et les suppressions de relations (variante la plus détaillée); none = uniquement selon l’horaire.	`<UseRealtimeData>explanatory</UseRealtimeData>`
`RefineParams/ IncludePlacesContext`	0:1	Fournit le contexte du lieu. La valeur par défaut est «true», mais «false» permet d’affiner la réponse.	`<IncludePlacesContext>false</InlcudePlacesContext>`
`RefineParams/ IncludeLegProjection`	0:1	Si le résultat doit inclure une projection géographique (coordonnées) des différents parcours partiels.	`<IncludeLegProjection>true</IncludeLegProjection>`
`RefineParams/ IncludeIntermediateStops`	0:1	Si le résultat doit inclure les arrêts intermédiaires, entre les arrêts de montée et de descente.	`<IncludeIntermediateStops>true</IncludeIntermediateStops>`
`RefineParams/ IncludeAllRestrictedLines`	0:1	Il peut y avoir des lignes soumises à des restrictions particulières qui ne sont pas accessibles au grand public. Par exemple, les bus scolaires ou les navettes d’entreprises. Si cette option est activée, le routeur prend également en compte les lignes restreintes.	`<IncludeAllRestrictedLines>true</IncludeAllRestrictedLines>`
`RefineParams/ IncludeTurnDescription`	0:1	Une description détaillée de l’itinéraire avec PathGuidance est émise pour chaque marche et, le cas échéant, pour les legs de transfert.	`<IncludeTurnDescription>true</IncludeTurnDescription>`

D’autres paramètres ayant un effet restrictif sur le moyen de transport ou l’itinéraire n’ont pas été implémentés. Seul le voyage demandé est mis à jour. Par conséquent, les autres paramètres non mentionnés ici sont sans effet.

TripRefineResponse

Les détails des différents paramètres peuvent être consultés Trip Request sont prélevés, qui TripRefineDelivery est majoritairement identique à la Trip Delivery.

Table des matières

Rechercher sur le site