Zum Inhalt springen

Wiki-Quellcode von positions/get_fms_data.php

Version 3.2 von YellowFox_RD am 2025/11/07 13:52
Verstecke letzte Bearbeiter
YellowFox_RD 3.1 1 Inhaltsverzeichnis
2
3 {{toc/}}
4
YellowFox_RD 3.2 5 Gibt die FMS Daten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
6 Wird keine Zeitraumsbegrenzung mitgegeben, wird der aktuellste Datensatz pro Fahrzeug zurück geliefert.
YellowFox_RD 3.1 7
8 = Beschreibung =
9
YellowFox_RD 3.2 10 (% class="green mark" %)**GET**(%%)** ** positions/get_fms_data.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYY-MM-DDTHH:MM:SS+HH:mm//**//&end//**=//YYYY-MM-DDTHH:MM:SS+HH:mm//**
YellowFox_RD 3.1 11
12 = Parameter =
13
14 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
15 |company|RTI Firmenschlüssel|string| |ja
16 |vehicle|RTI Fahrzeugschlüssel|string|(% colspan="1" rowspan="3" %)Es muss entweder vehicle, group oder import angegeben werden.| (ja)
17 |group|RTI Gruppenschlüssel|string| (ja)
18 |import|RTI Importschlüssel|string|(ja)
19 |start|Anfang des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
20 |end|Ende des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
21 |query_date|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
22 |offset|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int| |nein
23
24 {{info}}
25 **Hinweis zur Datumseingrenzung**
26 Sie können 3 verschiedene Modi nutzen:
27 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)
28 b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
29 c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug
30
31
32 Wir empfehlen zu Gunsten einer verkürzten Ausfrührungszeit ins besondere bei der Abfrage historischer Daten die Anzahl der Fahrzeuge möglichst gering zu halten.
33 {{/info}}
34
35 = Rückgabe =
36
37 Es wird ein **string** zurückgegeben. Im Fehlerfall wird "**ERROR:Beschreibung**" zurückgegeben.
38
39 == Feldbeschreibung ==
40
41 Diese Funktion setzt sich dynamisch zusammen. Sie gibt nur die FMS Werte zurück, die für mindestens eines Ihrer abgefragten Fahrzeuge existieren. Das bedeutet, dass möglicherweise nicht alle dokumentierten Schlüssel in Ihrer Rückgabe vorhanden sind. Welche FMS Werte für Sie verfügbar sind, hängt an Ihrem Fahrzeug, der Art der eingebauten Telematikbox und Ihrem gebuchten Fahrzeugtarif. Sollten Sie einen Wert für Ihr Fahrzeug vermissen, kontaktieren Sie gern unseren Support.
42
43 FMS Werte werden zyklisch vom Fahrzeug in einer gesammelten Meldung übertragen. Diese Meldungen können Sie mit dieser Funktion abfragen. Bei einigen Werten kann es vorkommen, dass diese nicht in jeder Meldung vorhanden sind. Wenn Sie historische Daten abfragen (d.h. Sie haben ein konkretes Datum übergeben) können Datensätze daher auch NULL Werte enthalten. Wenn Sie ohne Datum anfragen erhalten Sie den aktuellen Stand der Fahrzeuge. Hier erhalten Sie pro FMS Wert den aktuellsten bekannten Wert. Die einzelnen Werte sind aber möglicherweise unterschiedlich alt. Daher enthält die Rückgabe dieser Funktion für jeden einzelnen FMS Wert einen eigenen Zeitstempel.
44
YellowFox_RD 3.2 45 === Kopfdaten ===
YellowFox_RD 3.1 46
47 |=Feld|=Beschreibung
48 |_date|Gesetzte Datumseinschränkung
49 |_links|Sollte Ihre Anfrage das Limit übersteigen, finden Sie hier einen Link zum nächsten Teil der Ergebnismenge.
50 |has_more|Flag ob es noch mehr Daten zu holen gibt.
51
52 === Items ===
53
54 |=Feld|=Beschreibung
YellowFox_RD 3.2 55 |unit|Fahrzeug mit Kennzeichen und RTI Ident
56 |(((
57 acceleratorPedalPosition
58 )))|
59 |(((
60 adblueLevel
61 )))|
62 |(((
63 ambientAirTemperature
64 )))|
65 |(((
66 atLeastOnePtoActive
67 )))|
68 |(((
69 axleWeight
70 )))|
71 |(((
72 brakeSwitch
73 )))|
74 |(((
75 clutchSwitch
76 )))|
77 |(((
78 cruiseControlActive
79 )))|
80 |(((
81 directionIndicator
82 )))|
83 |(((
84 engineCoolantTemp
85 )))|
86 |(((
87 enginePercentLoad
88 )))|
89 |(((
90 enginePercentTorque
91 )))|
92 |(((
93 engineSpeed
94 )))|
95 |(((
96 fuelLevel1
97 )))|
98 |(((
99 fuelLevel2
100 )))|
101 |(((
102 fuelLiter
103 )))|
104 |(((
105 fuelRate
106 )))|
107 |(((
108 instantaneousFuelEconomy
109 )))|
110 |(((
111 overspeed
112 )))|
113 |(((
114 ptoState
115 )))|
116 |(((
117 serviceBrakeAirPressure1
118 )))|
119 |(((
120 serviceBrakeAirPressure2
121 )))|
122 |(((
123 serviceDistanceKm
124 )))|
125 |(((
126 serviceIntervalDays
127 )))|
128 |(((
129 serviceIntervalKm
130 )))|
131 |(((
132 tachoUnitSpeed
133 )))|
134 |(((
135 totalEngineHours
136 )))|
137 |(((
138 totalFuelUsed
139 )))|
140 |(((
141 totalGasUsed
142 )))|
143 |(((
144 vehicleDistance
145 )))|
146 |(((
147 vehicleMotionDetect
148 )))|
YellowFox_RD 3.1 149
YellowFox_RD 3.2 150
151
152 ==== Werte ECT Pumpen ====
153
154 |(((
155 ectAvgCellTemperature
156 )))|
157 |(((
158 ectAvgCellVoltage
159 )))|Durchschnittliche Zellspannung
160 |(((
161 ectBatteryManagementAmperage
162 )))|
163 |(((
164 ectErrorCodeCount
165 )))|
166 |(((
167 ectGeneratorActiveDuration
168 )))|
169 |(((
170 ectGeneratorControllerTemperature
171 )))|
172 |(((
173 ectGeneratorRuntime
174 )))|
175 |(((
176 ectGeneratorTemperature
177 )))|
178 |(((
179 ectHighPressurePumpControllerTemperature
180 )))|
181 |(((
182 ectHighPressurePumpDuration
183 )))|
184 |(((
185 ectHighPressurePumpEngineTemperature
186 )))|
187 |(((
188 ectHighPressurePumpRuntime
189 )))|
190 |(((
191 ectHighestCellTemperature
192 )))|
193 |(((
194 ectHighestCellVoltage
195 )))|Höchste Zellspannung
196 |(((
197 ectLastErrorCode
198 )))|
199 |(((
200 ectLowestCellTemperature
201 )))|
202 |(((
203 ectLowestCellVoltage
204 )))|Niedrigste Zellspannung
205 |(((
206 ectPumpSystemReadyDuration
207 )))|
208 |(((
209 ectStateOfCharge
210 )))|
211 |(((
212 ectTotalBatteryVoltage
213 )))|Gesamtspannung des Akkus
214 |(((
215 ectVacuumPumpControllerTemperature
216 )))|
217 |(((
218 ectVacuumPumpDuration
219 )))|
220 |(((
221 ectVacuumPumpEngineTemperature
222 )))|
223 |(((
224 ectVacuumPumpRuntime
225 )))|
226
YellowFox_RD 3.1 227 == JSON ==
228
229 Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
230
231 {{code language="json"}}
232 {
233 "_date": {
234 "query_date": "2025-11-07T13:07:23+01:00"
235 },
236 "_links": {
237 "next": {
238 "href": null
239 }
240 },
241 "has_more": false,
242 "items": [
243 {
244 "unit": {
245 "licensePlate": "FTL YF 123",
246 "rtiIdent": null
247 },
248 "engineCoolantTemp": {
249 "gpsDate": "2025-11-07T11:55:40+01:00",
250 "value": 79
251 },
252 "totalFuelUsed": {
253 "gpsDate": "2025-11-07T11:55:40+01:00",
254 "value": 44105
255 },
256 "tachoUnitSpeed": {
257 "gpsDate": "2025-11-07T11:55:40+01:00",
258 "value": 0
259 },
260 "cruiseControlActive": {
261 "gpsDate": "2025-11-07T11:55:40+01:00",
262 "value": 0
263 },
264 "vehicleDistance": {
265 "gpsDate": "2025-11-07T11:55:40+01:00",
266 "value": 158169
267 },
268 "fuelLevel1": {
269 "gpsDate": "2025-11-07T11:55:40+01:00",
270 "value": 46
271 },
272 "engineSpeed": {
273 "gpsDate": "2025-11-07T11:55:40+01:00",
274 "value": 598
275 },
276 "ptoState": {
277 "gpsDate": null,
278 "value": null
279 },
280 "vehicleMotionDetect": {
281 "gpsDate": "2025-11-07T11:55:40+01:00",
282 "value": 0
283 },
284 "acceleratorPedalPosition": {
285 "gpsDate": "2025-11-07T11:55:40+01:00",
286 "value": 0
287 },
288 "totalEngineHours": {
289 "gpsDate": "2025-11-07T11:55:40+01:00",
290 "value": 2674
291 },
292 "overspeed": {
293 "gpsDate": "2025-11-07T11:55:40+01:00",
294 "value": 0
295 },
296 "axleWeight": {
297 "gpsDate": "2025-11-07T11:45:33+01:00",
298 "value": 14680
299 },
300 "serviceDistanceKm": {
301 "gpsDate": "2025-11-07T11:55:40+01:00",
302 "value": 136490
303 },
304 "directionIndicator": {
305 "gpsDate": "2025-11-07T11:55:40+01:00",
306 "value": 1
307 },
308 "fuelLevel2": {
309 "gpsDate": null,
310 "value": null
311 },
312 "enginePercentTorque": {
313 "gpsDate": "2025-11-07T11:55:40+01:00",
314 "value": 11
315 }
316 }
317 ]}
318 {{/code}}
319
320 = Beispielaufrufe =
321
322 **Abfrage Zeitraum für eine Gruppe**
323 {{code language="java"}}https://map.yellowfox.de/rti/positions/get_fms_data.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&start=2022-09-22T13:23:00%2B00:00:00&end=2022-09-22T14:23:00%2B00:00:00{{/code}}
324
325 **Abfrage fester Zeitpunkt für ein Fahrzeug**
326 {{code language="java"}}https://map.yellowfox.de/rti/positions/get_fms_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&query_date=2022-09-22T13:23:00%2B00:00:00{{/code}}
327
328 **Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
329 {{code language="java"}}https://map.yellowfox.de/rti/positions/get_fms_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}