LocationInformationRequest (TRIAS 2020)

(TRIAS LocationInformationRequest)

Attention : sera supprimé fin 2024. Commencez à migrer vers OJP 2.0 à partir de la mi-2024.

Description technique
Détails techniques

Description technique

Location Information Request
Location Information Request fournit plusieurs Locations comme réponse. Les valeurs d’entrée principales sont:

un texte spécifiant le nom
les types d’objets recherchés
des restrictions géographiques
d’autres restrictions supplémentaires

La réponse consiste en une liste d’objets avec leurs noms, leurs positions géographiques, leurs attributs ainsi qu’une probabilité.

Attention: Lorsqu’on appelle LocationInformationRequest avec GeoPosition, Circle ou Rectangle au lieu de LocationName, on est obligé de choisir type=“stop“. Si en plus on spécifie GeoPosition avec type=“address“, la réponse fournit une adresse postale précise (rue et numéro).

Détails techniques

Le LocationInformationRequest (LIR) de l’API TRIAS est principalement un réplique du LIR de l’API OpenJourneyPlanners (OJP). Une différence syntactique: les éléments OJP sont souvent précédés de “ojp:“. Une description approfondie du LIR se trouve sur la page LIR OJP du cookbook. On y trouve les descriptions de tous les éléments et paramètres.

L’API Explorer pour TRIAS permet d’explorer des différentes possibilités.

API Explorer

Attention: choisissez le template d’abord (Location Information Request)

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

Exemples de requêtes

Recherche en utlisant un nom :

<?xml version="1.0" encoding="UTF-8"?>
<Trias version="1.1" xmlns="http://www.vdv.de/trias" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vdv.de/trias ../trias-xsd-v1.1/Trias.xsd">
	<ServiceRequest>
		<siri:RequestorRef>TRIAS-Test</siri:RequestorRef>
		<siri:MessageIdentifier>9999</siri:MessageIdentifier>
		<RequestPayload>
			<LocationInformationRequest>
				<InitialInput>
					<LocationName>Chäs und Brot</LocationName>
				</InitialInput>
				<Restrictions>
					<Type>stop</Type>
				</Restrictions>
			</LocationInformationRequest>
		</RequestPayload>
	</ServiceRequest>
</Trias>

<?xml version="1.0" encoding="UTF-8"?>

<siri:RequestorRef>TRIAS-Test</siri:RequestorRef>

<siri:MessageIdentifier>9999</siri:MessageIdentifier>

</InitialInput>

</Restrictions>

</LocationInformationRequest>

</RequestPayload>

</ServiceRequest>

</Trias>

Recherche en utilisant des coordonnées géographiques :

<?xml version="1.0" encoding="UTF-8"?>
<Trias version="1.1" xmlns="http://www.vdv.de/trias" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vdv.de/trias ../trias-xsd-v1.1/Trias.xsd">
    <ServiceRequest>
        <siri:RequestTimestamp>2020-01-28T12:00:00Z</siri:RequestTimestamp>
        <siri:RequestorRef>TRIAS-Test</siri:RequestorRef>
        <siri:MessageIdentifier>9999</siri:MessageIdentifier>
        <RequestPayload>
            <LocationInformationRequest>
                <InitialInput>
                    <GeoPosition>
                        <Longitude>8.5545</Longitude>
                        <Latitude>47.365</Latitude>
                    </GeoPosition>
                </InitialInput>
                <Restrictions>
                    <Type>stop</Type>
                </Restrictions>
            </LocationInformationRequest>
        </RequestPayload>
    </ServiceRequest>
</Trias>

<?xml version="1.0" encoding="UTF-8"?>

<siri:RequestTimestamp>2020-01-28T12:00:00Z</siri:RequestTimestamp>

<siri:RequestorRef>TRIAS-Test</siri:RequestorRef>

<siri:MessageIdentifier>9999</siri:MessageIdentifier>

</GeoPosition>

</InitialInput>

</Restrictions>

</LocationInformationRequest>

</RequestPayload>

</ServiceRequest>

</Trias>

Recherche d’une ou plusieurs haltes dans un périmètre défini :

<?xml version="1.0" encoding="UTF-8"?>
<Trias version="1.1" xmlns="http://www.vdv.de/trias" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vdv.de/trias ../trias-xsd-v1.1/Trias.xsd">
    <ServiceRequest>
        <siri:RequestTimestamp>2020-04-24T12:00:00Z</siri:RequestTimestamp>
        <siri:RequestorRef>TRIAS-Test</siri:RequestorRef>
        <siri:MessageIdentifier>9999</siri:MessageIdentifier>
        <RequestPayload>
            <LocationInformationRequest>
                <InitialInput>
                    <GeoRestriction>
                        <Circle>
                            <Center>
                                <Longitude>8.5545</Longitude>
                                <Latitude>47.365</Latitude>
                            </Center>
                            <Radius>500</Radius>
                        </Circle>
                    </GeoRestriction>
                </InitialInput>
                <Restrictions>
                    <Type>stop</Type>
                 </Restrictions>
            </LocationInformationRequest>
        </RequestPayload>
    </ServiceRequest>
</Trias>

<?xml version="1.0" encoding="UTF-8"?>

<siri:RequestTimestamp>2020-04-24T12:00:00Z</siri:RequestTimestamp>

<siri:RequestorRef>TRIAS-Test</siri:RequestorRef>

<siri:MessageIdentifier>9999</siri:MessageIdentifier>

</Center>

</Circle>

</GeoRestriction>

</InitialInput>

</Restrictions>

</LocationInformationRequest>

</RequestPayload>

</ServiceRequest>

</Trias>

Réponse

<?xml version="1.0" encoding="UTF-8"?>
<trias:Trias xmlns:siri="http://www.siri.org.uk/siri" xmlns:trias="http://www.vdv.de/trias" xmlns:acsb="http://www.ifopt.org.uk/acsb" xmlns:ifopt="http://www.ifopt.org.uk/ifopt" xmlns:datex2="http://datex2.eu/schema/1_0/1_0" version="1.1">
    <trias:ServiceDelivery>
        <siri:ResponseTimestamp>2020-09-10T07:25:17Z</siri:ResponseTimestamp>
        <siri:ProducerRef>EFAController10.4.6.43-OJP-EFA01-P</siri:ProducerRef>
        <siri:Status>true</siri:Status>
        <trias:Language>de</trias:Language>
        <trias:CalcTime>39</trias:CalcTime>
        <trias:DeliveryPayload>
            <trias:LocationInformationResponse>
                <trias:Location>
                    <trias:Location>
                        <trias:StopPoint>
                            <trias:StopPointRef>8571439</trias:StopPointRef>
                            <trias:StopPointName>
                                <trias:Text>Oberbottigen, Chäs und Brot</trias:Text>
                                <trias:Language>de</trias:Language>
                            </trias:StopPointName>
                            <trias:LocalityRef>23006351:1</trias:LocalityRef>
                        </trias:StopPoint>
                        <trias:LocationName>
                            <trias:Text>Bern</trias:Text>
                            <trias:Language>de</trias:Language>
                        </trias:LocationName>
                        <trias:GeoPosition>
                            <trias:Longitude>7.35537</trias:Longitude>
                            <trias:Latitude>46.93565</trias:Latitude>
                        </trias:GeoPosition>
                    </trias:Location>
                    <trias:Complete>true</trias:Complete>
                    <trias:Probability>0.958999991</trias:Probability>
                </trias:Location>
            </trias:LocationInformationResponse>
        </trias:DeliveryPayload>
    </trias:ServiceDelivery>
</trias:Trias>

<?xml version="1.0" encoding="UTF-8"?>

<trias:Trias xmlns:siri="http://www.siri.org.uk/siri" xmlns:trias="http://www.vdv.de/trias" xmlns:acsb="http://www.ifopt.org.uk/acsb" xmlns:ifopt="http://www.ifopt.org.uk/ifopt" xmlns:datex2="http://datex2.eu/schema/1_0/1_0" version="1.1">

<trias:ServiceDelivery>

<siri:ResponseTimestamp>2020-09-10T07:25:17Z</siri:ResponseTimestamp>

<siri:ProducerRef>EFAController10.4.6.43-OJP-EFA01-P</siri:ProducerRef>

<siri:Status>true</siri:Status>

<trias:Language>de</trias:Language>

<trias:CalcTime>39</trias:CalcTime>

<trias:DeliveryPayload>

<trias:LocationInformationResponse>

<trias:Location>

<trias:StopPoint>

<trias:StopPointRef>8571439</trias:StopPointRef>

<trias:StopPointName>

<trias:Text>Oberbottigen, Chäs und Brot</trias:Text>

<trias:Language>de</trias:Language>

</trias:StopPointName>

<trias:LocalityRef>23006351:1</trias:LocalityRef>

</trias:StopPoint>

<trias:LocationName>

<trias:Text>Bern</trias:Text>

<trias:Language>de</trias:Language>

</trias:LocationName>

<trias:GeoPosition>

<trias:Longitude>7.35537</trias:Longitude>

<trias:Latitude>46.93565</trias:Latitude>

</trias:GeoPosition>

</trias:Location>

<trias:Complete>true</trias:Complete>

<trias:Probability>0.958999991</trias:Probability>

</trias:Location>

</trias:LocationInformationResponse>

</trias:DeliveryPayload>

</trias:ServiceDelivery>

</trias:Trias>

Pour des explications supplémentaires et plus détaillées, veuillez consulter la page LIR du OpenJourneyPlanner(OJP) dans le cookbook.