Zum Inhalt springen

Wiki-Quellcode von positions/get_pos_data.php

Version 12.1 von YellowFox_RD am 2026/04/09 08:21
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((
3 Inhaltsverzeichnis
4 )))
5
6 {{toc/}}
7
8 Gibt die Positionsdaten eines Fahrzeuges zurück.
9 Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.
10
11 = Beschreibung =
12
13 (% class="green mark" %)**GET**(%%)** positions/get_pos_data.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYY-MM-DDTHH:MM:SS+HH:mm**&end**//=//YYYY-MM-DDTHH:MM:SS+HH:mm//
14
15 = Parameter =
16
17 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
18 |company|RTI Firmenschlüssel|string| |ja
19 |vehicle|RTI Fahrzeugschlüssel|string| | ja
20 |start|Anfang des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
21 |end|Ende des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
22 |query_date|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
23 |format|Rückgabeformat|string|json (Standard)|nein
24 |date_type|Welches Datum bildet die Grundlage für die Zeitraumseingrenzung|string|'insert' (Standard) = Verarbeitungsdatum
25 'gps' = Datum an dem die Positionsmeldung stattgefunden hat|nein
26 |additional_data|Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten|string[]|(((
27 * 'temp' holt die Temperaturwerte der Digitalen Sensoren 1-8 und Analogen Sensoren 1-4
28 * 'trailer' holt die Trailerinformationen
29 )))|nein
30 |hide_display|Blendet Meldungen vom Display aus|int|(((
31 * 0 (Standard) = Displaymeldungen werden mit ausgegeben
32 * 1 = Displaymeldungen werden nicht mit ausgegeben
33 )))|nein
34 |offset|Die Anfrage liefert maximal 1000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int| |nein
35
36 (% class="box info" %)
37 (((
38 **Hinweis zur Datumseingrenzung**
39 Sie können 3 verschiedene Modi nutzen:
40 a) Sie geben start und end an und erhalten damit alle Positionen innerhalb dieser Zeitspanne (diese beiden Zeitangaben dürfen maximal 24 Stunden auseinander liegen)
41 b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
42 c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug
43 )))
44
45 = Rückgabe =
46
47 Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
48
49 == Feldbeschreibung ==
50
51 |=Feld|=Beschreibung
52 |vehicle_sign|Kennzeichen
53 |rti_ident|RTI Ident
54 |insert_date|Wann wurde diese Meldung von YellowFox verarbeitet?
55 |gps_date|Wann wurde diese Meldung von dem Fahrzeug gesendet?
56 |lat|Latitude
57 |lon|Logitude
58 |text_position|Textaddresse der GPS Position
59 |customer|Kundenname (sofern die Adresse zu einem Kunden gehört)
60 |direction|Richtung in Grad
61 |satellites|Anzahl der Satelliten zur Positionsbestimmung
62 |speed|Geschwindigkeit in km/h
63 |ignition|Ist die Zündung an (1) oder aus (0) ?
64 |reason|Warum wurde diese Positionsmeldung generiert?
65 |km|Kilometerstand
66 |bszX|Wert des Betriebsstundenzählers
67 |driver_X|Name des Fahrers
68 |driverkey_X|Personalschlüssel des Fahrers
69 |eta_time|Wenn zu einem Ziel navigiert wird: Planmäßige Ankunft
70 |eta_distance|Wenn zu einem Ziel navigiert wird: verbleibende Distanz
71 |eta_duration|Wenn zu einem Ziel navigiert wird: verbleibende Dauer
72 |eta_lat|Wenn zu einem Ziel navigiert wird: Latitude der Zielposition
73 |eta_lon|Wenn zu einem Ziel navigiert wird: Longitude der Zielposition
74 |eta_desc|Wenn zu einem Ziel navigiert wird: Textadresse der Zielposition
75 |digital_inputs|(((
76 Status der Telemetrieeingänge
77 nr = Nummer des Eingangs (1 bis 7)
78 name = Name des Eingangs
79 state = Status des Eingangs als Text
80 value =  Status des Eingangs (1 = an, 0 = aus)
81
82 ident = technisches Identifikationsmerkmal, kann in den fahrzeugbezogenen Einstellungen festgelegt werden
83 )))
84 |trailer_info|Optionales Feld. Beinhaltet Informationen zum Kopplungszustand mit einem Trailer
85 date = Datum des Status
86 type = verbunden mit Trailer (TRAILER) oder Zugmaschine (VEHICLE)
87 name = Name des verbunden Trailers/Zugmaschine
88 rti_ident = RTI Ident des Trailers
89 state = Verbindungsstatus (CONNECTED oder DISCONNECTED)
90 |digital_temperature_values|Optionales Feld. Beinhaltet digitale Temperaturdaten.
91 nr = Nummer des Eingangs 
92 value = Temperatur in °C
93 set_point = Angestrebter Wert in °C
94 |analogue_temperature_values|Optionales Feld. Beinhaltet analoge Temperaturdaten.
95 nr = Nummer des Eingangs 
96 value = Temperatur in °C
97
98 == JSON ==
99
100 Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
101
102 {{code language="java"}}
103 {
104 "_date" => null,
105 "_links" => {
106 "next" => {
107 "href" => null
108 }
109 },
110 "has_more" => false,
111 "items": [
112 {
113 "vehicle_sign": "FTL YF 123",
114 "rti_ident": "",
115 "insert_date": "2022-09-22T13:23:35+02:00",
116 "gps_date": "2022-09-22T13:23:23+02:00",
117 "lat": 48.20398,
118 "lon": 16.22613,
119 "text_position": "A-1140 Wien (Penzing) Wientalstraße (B1)",
120 "customer": null,
121 "direction": 155,
122 "satellites": 12,
123 "speed": 0,
124 "ignition": 0,
125 "reason": "AnalogMinuteInterval",
126 "km": 361549,
127 "bsz1": null,
128 "bsz2": null,
129 "driver_1": null,
130 "driverkey_1": null,
131 "driver_2": null,
132 "driverkey_2": null,
133 "eta_time": null,
134 "eta_distance": null,
135 "eta_duration": null,
136 "eta_lat": null,
137 "eta_lon": null,
138 "eta_desc": null,
139 "digital_inputs": [
140 {
141 "nr": 2,
142 "name": "Sensor 2",
143 "state": "",
144 "value": 0,
145 "ident": null
146 }
147 ],
148 "trailer_info": {
149 "date": "2022-09-22T13:18:35+02:00",
150 "type": "TRAILER",
151 "name": "Trailer 123",
152 "rti_ident": "TR_ID",
153 "state":"CONNECTED"
154 },
155 "digital_temperature_values": [
156 {
157 "nr": 1,
158 "value": 13.2,
159 "set_point": 13.3
160 }
161 ],
162 "analogue_temperature_values": [
163 {
164 "nr": 1,
165 "value": 21.56
166 },
167 {
168 "nr": 2,
169 "value": 11.83
170 }
171 ]
172 }
173 ]
174 }
175 {{/code}}
176
177 = Beispielaufrufe =
178
179 **Abfrage fester Zeitpunkt für ein Fahrzeug**
180 {{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&query_date=2022-09-22T13:23:00%2B00:00:00{{/code}}
181
182 **Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
183 {{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}