Indice della materia

Ricerca nella pagina

OJPTripInfoRequest

OJPTripInfoRequest

La TripInfoRequest può essere utilizzata per richiedere ulteriori dettagli su un viaggio (“Journey”).

API-Explorer

È possibile provare le proprie richieste – link diretto all’API Explorer.

Request

L’informazione centrale della TripInfoRequest è un ojp:JourneyRef con ojp:OperatingDayRef, cioè un riferimento a un viaggio specifico in un giorno di calendario. Il JourneyRef deve essere preso dalla risposta a un’altra richiesta (ad esempio, TripRequest o 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>
Elemento Cardinalità Descrizione Esempio
RequestTimestamp 1:1 Data e ora della richiesta. Preferibilmente in tempo Zulu. 
<RequestTimestamp>2020-01-20T12:00:00Z</RequestTimestamp>
MessageIdentifier 0:1 L’identificatore del messaggio. Preferibilmente in costante aumento. 
<MessageIdentifier>756</MessageIdentifier>
JourneyRef 0:1 Riferimento al viaggio.

Il riferimento può essere determinato tramite una TripRequest o una StopEventRequest.

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

 
OperatingDayRef 0:1 Nel formato YYYY-MM-DD 
<ojp:OperatingDayRef>2020-01-20</ojp:OperatingDayRef>

 
siri:VehicleRef 0:1 n/a

Questa funzione non è disponibile.

 n/a
TimeOfOperation 0:1 n/a

Questa funzione non è disponibile.

 n/a
Params 0:1 Ulteriori parametri per la richiesta di informazioni
Params/UseTimetableDataOnly 0:1 Dovremmo fare a meno del tempo reale? L’impostazione predefinita è false.
Params/IncludeCalls 0:1 Le “calls/chiamate” (fermate intermedie) devono essere inserite? L’impostazione predefinita è true.
Params/IncludePosition 0:1 Si deve inserire la posizione attuale del treno?

Questa funzione non è disponibile.

 n/a
Params/IncludeService 0:1 Le informazioni sul servizio devono essere inserite (LineRef, Mode, OperatorRef,…)? L’impostazione predefinita è true.
Params/IncludeTrackSections 0:1 È necessario aggiungere informazioni geografiche al percorso? L’impostazione predefinita è false.
Params/IncludeTrackProjection 0:1 Devono essere trasmesse anche le proiezioni coordinate?

Questa funzione è prevista.

Response

TripInfoResponseContext è consegnato in cima (al contenuto effettivo), principalmente informazioni sui “Places/Luoghi” utilizzati – si veda la descrizione più dettagliata in 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>

TripInfoResult

Nota bene: a seconda dei parametri impostati, le parti elencate di seguito possono comparire o meno nella risposta. Pertanto, se necessario, controllare i parametri della richiesta per (non) ricevere determinate parti.

Esempio di risposta completa: TripInfoRequest_example_response

Dopo il contesto viene il viaggio vero e proprio; prima tutte le fermate con PreviousCalls (fermate precedenti) e OnwardCalls (fermate successive). Questo può contenere più tappe rispetto alla TripRequest, che è stata fatta per determinare il JourneyRef, dato che l’intero viaggio viene fornito nella TripInfoRequest.

Se il tempo reale non è stato escluso nella richiesta con UseTimetableDataOnly=true, vengono forniti anche i dati in tempo reale (EstimatedTime, EstimatedQuay) (se disponibili) oltre all’orario e alla traccia di partenza/arrivo previsti (TimetabledTime, Planned Quay).

Esempio: per TripRequest (una richiesta di viaggio) da Berna a Zurigo, un viaggio da Ginevra a San Gallo potrebbe essere fornito nella corrispondente richiesta TripInfo, di cui la sezione Berna – Zurigo è un sottoinsieme.

<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>

Poi le informazioni sul servizio: LineRef, Mode (mezzo di trasporto), OperatorRef, ecc.

<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>

Le informazioni geografiche sul viaggio (Journey) vengono quindi fornite in JourneyTrack (parametro della richiesta: IncludeTrackSections).

<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>

Infine, l’unica informazione (Info) attualmente disponibile nell’estensione (Extension) è il numero pubblicato (nell’esempio seguente “319”, perché si tratta di 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>