StopEventService
Le StopEventService sert à élaborer un indicateur des départs ou des arrivées.
Explorateur API
Vous pouvez faire des essais en utilisant vos propres requêtes – lien direct vers l’explorateur de l’API.
Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
<?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>2021-01-09T11:34:25.507Z</RequestTimestamp> <RequestorRef>API-Explorer</RequestorRef> <ojp:OJPStopEventRequest> <RequestTimestamp>2020-01-20T12:00:00Z</RequestTimestamp> <MessageIdentifier>756</MessageIdentifier> <ojp:Location> <ojp:PlaceRef> <ojp:StopPlaceRef>8530813</ojp:StopPlaceRef> <ojp:LocationName> <ojp:Text>Zürich Kreuzplatz</ojp:Text> </ojp:LocationName> </ojp:PlaceRef> <ojp:DepArrTime>2021-01-20T12:00:00Z</ojp:DepArrTime> <ojp:IndividualTransportOptions> <Mode>walk</Mode> <MaxDistance>5000</MaxDistance> <MaxDuration>PT5M</MaxDuration> <MinDistance>0</MinDistance> <MinDuration>PT0M</MinDuration> <Speed>50</Speed> <AdditionalTime>PT10M</AdditionalTime> </ojp:IndividualTransportOptions> </ojp:Location> <ojp:Params> <ojp:StopEventType>both</ojp:StopEventType> <ojp:IncludePreviousCalls>true</ojp:IncludePreviousCalls> <ojp:IncludeOnwardCalls>true</ojp:IncludeOnwardCalls> <ojp:IncludeOperatingDays>true</ojp:IncludeOperatingDays> <ojp:IncludeRealtimeData>true</ojp:IncludeRealtimeData> </ojp:Params> </ojp:OJPStopEventRequest> </ServiceRequest> </OJPRequest> </OJP> |
| É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. |
|
||
| ojp:Location/ojp:PlaceRef | 0:1 | Le mieux est d’utiliser une StopPlaceRef. Le LocationName est ignoré. |
|
||
| ojp:Location/ojp:DepArrTime | 0:1 | Heure à utiliser. De préférence une heure UTC.
“Z” est l’heure zouloue (c’est-à-dire indépendante du fuseau horaire). Pour Z, les secondes doivent également être spécifiées. Si le format est incorrect ou s’il n’y a pas de Z, le système tente d’interpréter l’heure comme l’heure locale. |
|
||
| ojp:Location/ojp:TimeAllowance | 0:1 | Comme alternative à l’élément DepArrTime. Temps requis pour atteindre la Location. xs:Duration. |
|
||
| ojp:Location/ojp:IndividualTransportOptions | 0:* | Options pour atteindre un lieu ou pour en partir. Cf. la rubrique sur les IndividualTransportOptions sous Trip Service.
Modes autorisés: walk, cycle, taxi, self-drive-car, others-drive-car, motorcycle, truck. Actuellement, seuls les modes walk et cycle sont pris en charge. Les distances sont en mètres. La vitesse est indiquée par rapport à la vitesse normale (= 100%). L’AdditionalTime est le temps supplémentaire induit par le mode concerné. |
|
||
| ojp:/Params | 0:1 | Paramètres |
|
Params
| Élément | Cardinalité | Description | Exemple | |||||
| ojp:PtModeFilter | 0:1 | Filtre par mode. L’élément Exclude indique si les modes doivent être inclus ou exclus.
Il est possible d’ajouter 1:* Mode. Cf. PtModeFilter sous Trip Service. |
|
|||||
| ojp:LineFilter | 0:1 | Filtre par ligne. L’élément Exclude indique si les lignes doivent être incluses ou exclues.
Il est possible d’ajouter 1:* Line. |
|
|||||
| ojp:OperatorFilter | Filtre par exploitant. L’élément Exclude indique si les exploitants doivent être inclus ou exclus.
Il est possible d’ajouter 1:* OperatorRef. |
|
||||||
| ojp:NumberOfResults | 0:1 | Nombre de résultats |
|
|||||
| ojp:StopEventType | 0:1 | Type des StopEvents:
|
|
|||||
| ojp:IncludePreviousCalls | 0:1 | Faut-il indiquer pour chaque trajet également la halte précédente? |
|
|||||
| ojp:IncludeOnwardCalls | 0:1 | Faut-il indiquer pour chaque trajet également la halte suivante? |
|
|||||
| ojp:IncludeOperatingDays | 0:1 | Faut-il inclure pour ce StopEvent les informations relatives au jour concerné? |
|
|||||
| ojp:IncludeRealtimeData | 0:1 | Les données en temps réel doivent-elles être utilisées pour le calcul du Trip? |
|
Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
<?xml version="1.0" encoding="UTF-8"?> <siri:OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:siri="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"> <siri:OJPResponse> <siri:ServiceDelivery> <siri:ResponseTimestamp>2020-01-12T22:27:13Z</siri:ResponseTimestamp> <siri:ProducerRef>OJPCH_test</siri:ProducerRef> <siri:Status>true</siri:Status> <ojp:OJPStopEventDelivery> <siri:ResponseTimestamp>2020-01-12T22:27:13Z</siri:ResponseTimestamp> <siri:RequestMessageRef>756</siri:RequestMessageRef> <siri:Status>true</siri:Status> <ojp:CalcTime>310</ojp:CalcTime> <ojp:StopEventResponseContext> <ojp:Places> <ojp:Location> <ojp:StopPlace> <ojp:StopPlaceRef>8530813</ojp:StopPlaceRef> <ojp:StopPlaceName> <ojp:Text>Zürich Kreuzplatz</ojp:Text> </ojp:StopPlaceName> <ojp:TopographicPlaceRef>-1:-1</ojp:TopographicPlaceRef> </ojp:StopPlace> <ojp:LocationName> <ojp:Text xml:lang="de">Zürich Kreuzplatz</ojp:Text> </ojp:LocationName> <ojp:GeoPosition/> </ojp:Location> <ojp:Location> <ojp:StopPoint> <siri:StopPointRef>8530813</siri:StopPointRef> <ojp:StopPointName> <ojp:Text>Zürich Kreuzplatz</ojp:Text> </ojp:StopPointName> <ojp:ParentRef>8530813</ojp:ParentRef> <ojp:TopographicPlaceRef>-1:-1</ojp:TopographicPlaceRef> </ojp:StopPoint> <ojp:LocationName> <ojp:Text xml:lang="de">Zürich Kreuzplatz</ojp:Text> </ojp:LocationName> <ojp:GeoPosition> <siri:Longitude>8.55408</siri:Longitude> <siri:Latitude>47.36488</siri:Latitude> </ojp:GeoPosition> </ojp:Location> <!--- and so on ---> </ojp:Places> </ojp:StopEventResponseContext> <ojp:StopEventResult> <ojp:ResultId>ID-61BB1C56-4F28-410A-9D03-298D9BF9165C</ojp:ResultId> <ojp:StopEvent> <ojp:PreviousCall> <ojp:CallAtStop> <siri:StopPointRef>8591228</siri:StopPointRef> <ojp:StopPointName> <ojp:Text>Zürich, Kienastenwies</ojp:Text> </ojp:StopPointName> <ojp:ServiceDeparture> <ojp:TimetabledTime>2020-01-12T12:42:00Z</ojp:TimetabledTime> </ojp:ServiceDeparture> <ojp:Order>1</ojp:Order> </ojp:CallAtStop> </ojp:PreviousCall> <!--- and so on ---> <ojp:ThisCall> <ojp:CallAtStop> <siri:StopPointRef>8530813</siri:StopPointRef> <ojp:StopPointName> <ojp:Text>Zürich Kreuzplatz</ojp:Text> </ojp:StopPointName> <ojp:ServiceArrival> <ojp:TimetabledTime>2020-01-12T12:56:00Z</ojp:TimetabledTime> </ojp:ServiceArrival> <ojp:Order>14</ojp:Order> </ojp:CallAtStop> </ojp:ThisCall> <ojp:OnwardCall> <ojp:CallAtStop> <siri:StopPointRef>8591375</siri:StopPointRef> <ojp:StopPointName> <ojp:Text>Zürich, Sprecherstrasse</ojp:Text> </ojp:StopPointName> <ojp:ServiceArrival> <ojp:TimetabledTime>2020-01-12T12:56:00Z</ojp:TimetabledTime> </ojp:ServiceArrival> <ojp:ServiceDeparture> <ojp:TimetabledTime>2020-01-12T12:56:00Z</ojp:TimetabledTime> </ojp:ServiceDeparture> <ojp:Order>15</ojp:Order> </ojp:CallAtStop> </ojp:OnwardCall> <!--- and so on ---> <ojp:Service> <ojp:OperatingDayRef></ojp:OperatingDayRef> <ojp:JourneyRef>sbb:92031::R:j20:21060</ojp:JourneyRef> <siri:LineRef>sbb:92031::R</siri:LineRef> <siri:DirectionRef>H</siri:DirectionRef> <ojp:Mode> <ojp:PtMode>bus</ojp:PtMode> <siri:BusSubmode>regionalBus</siri:BusSubmode> <ojp:Name> <ojp:Text xml:lang="de">Bus</ojp:Text> </ojp:Name> </ojp:Mode> <ojp:PublishedLineName> <ojp:Text>31</ojp:Text> </ojp:PublishedLineName> <ojp:OperatorRef>sbb:849:VerkehrsbetriebeZrich</ojp:OperatorRef> <ojp:Attribute> <ojp:Text> <ojp:Text xml:lang="de">Linie 31: Niederflureinstieg</ojp:Text> </ojp:Text> <ojp:Code>30</ojp:Code> <ojp:Mandatory>false</ojp:Mandatory> </ojp:Attribute> <ojp:OriginStopPointRef>8591228</ojp:OriginStopPointRef> <ojp:OriginText> <ojp:Text xml:lang="de">Zürich, Kienastenwies</ojp:Text> </ojp:OriginText> <ojp:DestinationStopPointRef>8591056</ojp:DestinationStopPointRef> <ojp:DestinationText> <ojp:Text xml:lang="de">Zürich Altstetten, Bahnhof</ojp:Text> </ojp:DestinationText> </ojp:Service> </ojp:StopEvent> </ojp:StopEventResult> </ojp:OJPStopEventDelivery> </siri:ServiceDelivery> </siri:OJPResponse> </siri:OJP> |
Il est important de savoir que la réponse comporte parfois toutes les informations relatives au trajet, et pas seulement celles qui concernent la halte sélectionnée. La réponse est contenue dans un élément ojp:OJPStopEventDelivery.
| Élément | Cardinalité | Description | ||||||
| siri:ResponseTimestamp | 1:1 | Timestamp de la réponse. |
|
|||||
| siri:RequesteMessageRef | 0:1 | C’est ici qu’est référencé le message de requête. |
|
|||||
| siri:Status | 1:1 | Statut de la réponse. «true» signifie que la requête a été traitée. |
|
|||||
| ojp:CalcTime | 1:1 | Temps de calcul en millisecondes. |
|
|||||
| ojp:StopEventResponseContext | 1:1 | C’est ici que sont fournies les informations sur les références, telles que les haltes utilisées.
Cf. tableau distinct |
||||||
| ojp:StopEventResult | 1:1 | Résultats effectifs | ||||||
| ojp:StopEventResult/ojp:StopEventResultID | 1:1 | ID du résultat |
|
|||||
| ojp:StopEventResult/ojp:StopEvent | 1:n | Trajets
Cf. tableau distinct |
StopEventResponseContext
Le contexte comporte les éléments suivants:
- Location(s)
- Situation(s): élément pas encore implémenté
| Élément | Cardinalité | Description | Exemple | ||
| ojp:StopPlace | 1:1 | ||||
| ojp:StopPlace/ojp:StopPlaceRef | 1:1 | Référence de la halte. Actuellement, il s’agit du numéro DiDok. Mais ce peut également être le NeTEx-id d’un StopPlace ou, à l’avenir, un Swiss Location id (SLOID). Jusqu’à nouvel ordre, il existe un lien étroit entre ces trois références. |
|
||
| ojp:StopPlace/ojp:StopPlaceName | 1:1 | Nom de la halte. Il n’y a actuellement pas de langue définie pour les haltes. |
|
||
| ojp:StopPlace/ojp:TopographicPlaceRef | 1:1 | Il s’agit d’une référence dans l’arborescence des lieux.
Comme il n’existe pas de publication de l’arborescence des lieux, cet attribut ne peut être utilisé que s’il a été demandé au préalable dans une |
|
||
| ojp:StopPlace/ojp:LocationName | 1:1 | Nom du lieu |
|
||
| ojp:StopPlace/ojp:GeoPosition | 1: | Coordonnées WGS84 |
|
ojp:StopEvent
Le StopEvent se compose des éléments suivants:
- ojp:PreviousCall(s): Le cas échéant, les paramètres
- ojp:ThisCall: La halte actuellement sélectionnée
- ojp:OnwardCall(s): Futures haltes sur le trajet
- ojp:Service: Informations sur le trajet
| Élément | Cardinalité | Description | Exemple | ||
| ojp:PreviousCall | 0:* | Les PreviousCalls sont les haltes précédant celle qui a été demandée. Toutes les informations se trouvent dans un CallAtStop. Cf. la rubrique correspondante. |
|
||
| ojp:ThisCall | 1:1 | Il s’agit de la halte faisant l’objet de la requête.
Toutes les informations se trouvent dans un CallAtStop. Cf. la rubrique correspondante. |
|
||
| ojp:OnwardCall | 0:* | Les OnwardCalls sont les haltes qui se trouvent après la halte ayant été demandée dans la requête.
Toutes les informations se trouvent dans un CallAtStop. Cf. la rubrique correspondante. |
|
||
| ojp:Service | 1:1 | Le Service correspond aux informations relatives à l’ensemble du trajet. |
|
ojp:CallAtStop
| Elment | Kardinalität | Beschreibung | Beispiel | ||
| siri:StopPointRef | 1:1 | Numéro de la halte. Pour l’instant, il s’agit encore d’un numéro DiDok. Mais ce peut être aussi un NeTEx-Id ou un SLOID. |
|
||
| ojp:StopPointName | 1:1 | Nom de la halte |
|
||
| ojp:PlannedQuay | 0:1 | Quai prévu. |
|
||
| ojp:EstimatedQuay | 0:1 | Quai actuel, le cas échéant. |
|
||
| ojp:ServiceArrival | 0:1 | La première halte n’a pas d’Arrival. |
|
||
| ojp:ServiceDeparture | 0:1 |
|
|||
| ojp:Order | 1:1 | Ordre des haltes. |
|
||
| ojp:RequestStop | 0:1 | Arrêt sur demande. Booléen.
Prévu pour une version ultérieure. |
n/a | ||
| ojp:UnplannedStop | 0:1 | Une halte qui n’a pas été planifiée. Booléen.
Prévu pour une version ultérieure. |
n/a | ||
| ojp:NotServicedStop | 0:1 | Contrairement à la planification, la halte n’a pas eu lieu. |
|
||
| ojp:SituationFullRef | 0:1 | Cet attribut n’est pas disponible. |
ojp:Service
| Element | Kardinalität | Beschreibung | Beispiel | ||
| ojp:OperatingDayRef | 1: | Jour concerné. |
|
||
| ojp:JourneyRef | 1:1 | ID du trajet. |
|
||
| siri:LineRef | 1:1 | ID de la ligne: |
|
||
| siri:DirectionRef | 1:1 | ID de la ligne: |
|
||
| ojp:Mode | 1:1 | Mode de transport.
La liste des modes est disponible sur LocationInformationRequest. |
|
||
| ojp:PublishedLineName | 1:1 | Nom publié de la liste. |
|
||
| ojp:OperatorRef | 0:1 | Référence de l’exploitant. |
|
||
| ojp:Attribute | 0:* | Les Attributes se rapportent généralement aux convois. P. ex. véhicule à plancher surbaissé, bar, réservation obligatoire.
ojp:Mandataory est «true» lorsque l’attribut doit être impérativement signalé à l’utilisateur. |
|
||
| ojp:OrginStopPointRef | 0:1 | Numéro DiDok de la halte de destination. |
|
||
| ojp:OriginText | 0:1 | Nom de la halte de départ. |
|
||
| ojp:DestinationStopPointRef | 0:1 | Die DiDok-Nummer der/ Zielhaltestelle. |
|
||
| ojp:DestinationText | 0:1 | nom de la halte de destination. |
|
||
| ojp:Unplanned | 0:1 | Indique s’il s’agit d’un trajet supplémentaire n’ayant pas figuré dans l’horaire. Booléen. |
|
||
| ojp:Cancelled | 0:1 | Indique si le trajet à été supprimé. Booléen. | < pre class=”lang:xhtml decode:true”><ojp:Cancelled>true</ojp:Cancelled> | ||
| ojp:Deviation | 0:1 | Indique si le trajet n’a pas été effectué selon l’horaire.
Prévu pour une version ultérieure. |
n/a | ||
| ojp:BookingArrangements | 0:1 | Cet attribut n’est pas implémenté. | n/a | ||
| ojp:ParticipantRef | 1:1 | Sert à signaler des perturbations ou d’autres évènements extraordinaires.
Prévu pour une version ultérieure. |
n/a | ||
| ojp:SituationNumber | 1:1 | Sert à signaler des perturbations ou d’autres évènements extraordinaires.
Prévu pour une version ultérieure. |
n/a |
Cas spéciaux
Trains-autos tunnel
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
<siri:OJP xmlns="http://www.vdv.de/ojp" xmlns:siri="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:schemaLocation="http://www.vdv.de/ojp" version="1.0"> <siri:OJPRequest> <siri:ServiceRequest> <siri:RequestTimestamp>2024-07-22T10:40:16.970Z</siri:RequestTimestamp> <siri:RequestorRef>OJP_JS_SDK_v0.9.35</siri:RequestorRef> <OJPStopEventRequest> <siri:RequestTimestamp>2024-07-22T10:40:16.970Z</siri:RequestTimestamp> <Location> <PlaceRef> <StopPlaceRef>8519606</StopPlaceRef> <LocationName> <Text/> </LocationName> </PlaceRef> <DepArrTime>2024-07-22T10:40:02.237Z</DepArrTime> </Location> <Params> <NumberOfResults>10</NumberOfResults> <StopEventType>departure</StopEventType> <IncludePreviousCalls>true</IncludePreviousCalls> <IncludeOnwardCalls>true</IncludeOnwardCalls> <IncludeRealtimeData>true</IncludeRealtimeData> </Params> <siri:Extensions> <ParamsExtension> <PrivateModeFilter> <Exclude>false</Exclude> </PrivateModeFilter> </ParamsExtension> </siri:Extensions> </OJPStopEventRequest> </siri:ServiceRequest> </siri:OJPRequest> </siri:OJP> |
Les profils à grande capacité (pour le BLS) sont reconnaissables à l’attribut GF :
|
1 2 3 4 5 6 |
<ojp:Attribute> <ojp:Text> <ojp:Text xml:lang="de">Grossraumprofil</ojp:Text> </ojp:Text> <ojp:Code>A__GF</ojp:Code> </ojp:Attribute> |