positions/get_fms_data.php

Version 6.1 von YellowFox_RD am 2025/11/10 09:04

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
- Feldbeschreibung
  - Kopfdaten
  - Items
- JSON
Beispielaufrufe

Gibt die FMS Daten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
Wird keine Zeitraumsbegrenzung mitgegeben, wird der aktuellste Datensatz pro Fahrzeug zurück geliefert.

Beschreibung

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

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
vehicle	RTI Fahrzeugschlüssel	string	Es muss entweder vehicle, group oder import angegeben werden.	(ja)
group	RTI Gruppenschlüssel	string		(ja)
import	RTI Importschlüssel	string		(ja)
start	Anfang des Abfragezeitraum	datestring	Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS+HH:mm)	nein
end	Ende des Abfragezeitraum	datestring	Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS+HH:mm)	nein
query_date	Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll	datestring	Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS+HH:mm)	nein
offset	Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.	int		nein

Hinweis zur Datumseingrenzung
Sie können 3 verschiedene Modi nutzen:
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)
b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug

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.

Rückgabe

Es wird ein string zurückgegeben. Im Fehlerfall wird "ERROR:Beschreibung" zurückgegeben.

Feldbeschreibung

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.

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.

Kopfdaten

Feld	Beschreibung
_date	Gesetzte Datumseinschränkung
_links	Sollte Ihre Anfrage das Limit übersteigen, finden Sie hier einen Link zum nächsten Teil der Ergebnismenge.
has_more	Flag ob es noch mehr Daten zu holen gibt.

Items

Statische Werte

Diese Felder sind immer enthalten.

Feld	Beschreibung
unit	Fahrzeug mit Kennzeichen und RTI Ident

FMS Werte

FMS Werte sind immer ein Objekt aus value und gpsDate. Value und gpsDate können jedoch NULL sein wenn das Fahrzeug diesen Wert nicht unterstützt oder nicht sendet. Bei den Werten handelt es sich um Rohdaten aus der offiziellen FMS Schnittstelle. Es kann daher nötig sein, die Werte nach Abruf zu interpretieren und zu formatieren.

Feld	Beschreibung
acceleratorPedalPosition	Gaspedalposition in Prozent
adblueLevel	AdBlue Füllstand in Prozent
ambientAirTemperature	Außentemperatur in °C
atLeastOnePtoActive	Ist wenigstens ein Nebenantrieb aktiv?
axleWeight	Achslast
brakeSwitch	Bremse betätigt seit der letzten Meldung
clutchSwitch	Kupplung betätigt seit der letzten Meldung
cruiseControlActive	Ist der Tempomat an?
directionIndicator	Richtung des Fahrzeuges
engineCoolantTemp	Temperatur Motor in °C
enginePercentLoad	Motordrehmoment in Prozent
enginePercentTorque	Drehmoment
engineSpeed	Motorumdrehungen
fuelLevel1	Tankfüllstand 1 in Prozent
fuelLevel2	Tankfüllstand 2 in Prozent
fuelLiter	Tankinhalt in Litern
fuelRate	Kraftstoffverbauch pro Stunde
instantaneousFuelEconomy	Kraftstoffverbrauch in Kilometern pro Liter
overspeed	Übergeschwindigkeitswarnung
ptoState	Status Nebenantrieb
serviceBrakeAirPressure1	Luftdruck Betriebsbremse 1
serviceBrakeAirPressure2	Luftdruck Betriebsbremse 2
serviceDistanceKm	Kilometer bis zum nächsten Service
serviceIntervalDays	Tage bis zum nächsten Service
serviceIntervalKm	Kilometerintervall Service
tachoUnitSpeed	Geschwindigkeit
totalEngineHours	Gesamtlaufleistung
totalFuelUsed	Gesamtmenge des verbauchten Treibstoffs in Litern
totalGasUsed	Gesamtmenge des verbrauchten Gas
vehicleDistance	Gesamtmenge der zurückgelegten Kilometer
vehicleMotionDetect	Ist das Fahrzeug in Bewegung?

Werte ECT Pumpen

Feld	Beschreibung
ectAvgCellTemperature	Durchschnittliche Zelltemperatur
ectAvgCellVoltage	Durchschnittliche Zellspannung
ectBatteryManagementAmperage	Stromaufnahme/-abgabe des BMS
ectErrorCodeCount	Anzahl der Fehlercodes
ectGeneratorActiveDuration	Dauer des Active-Status des Generators
ectGeneratorControllerTemperature	Temperatur des Generator-Controllers
ectGeneratorRuntime	Laufzeit des Generators
ectGeneratorTemperature	Temperatur des Generators
ectHighPressurePumpControllerTemperature	Temperatur des Controllers der Hochdruckpumpe
ectHighPressurePumpDuration	Dauer des Active-Status der Hochdruckpumpe
ectHighPressurePumpEngineTemperature	Temperatur des Hochdruckpumpenmotors
ectHighPressurePumpRuntime	Laufzeit der Hochdruckpumpe
ectHighestCellTemperature	Höchste Zelltemperatur
ectHighestCellVoltage	Höchste Zellspannung
ectLastErrorCode	Letzter Fehlercode
ectLowestCellTemperature	Niedrigste Zelltemperatur
ectLowestCellVoltage	Niedrigste Zellspannung
ectPumpSystemReadyDuration	Dauer des Ready-Status des Pumpensystems
ectStateOfCharge	Ladezustand des Akkus
ectTotalBatteryVoltage	Gesamtspannung des Akkus
ectVacuumPumpControllerTemperature	Temperatur des Controllers der Vakuumpumpe
ectVacuumPumpDuration	Dauer des Active-Status der Vakuumpumpe
ectVacuumPumpEngineTemperature	Temperatur des Vakuumpumpenmotors
ectVacuumPumpRuntime	Laufzeit der Vakuumpumpe

JSON

{
   "_date": {
       "query_date": "2025-11-07T13:07:23+01:00"
    },
   "_links": {
       "next": {
           "href": null
        }
    },
   "has_more": false,
   "items": [
        {
           "unit": {
               "licensePlate": "FTL YF 123",
               "rtiIdent": null
            },
           "engineCoolantTemp": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 79
            },
           "totalFuelUsed": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 44105
            },
           "tachoUnitSpeed": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 0
            },
           "cruiseControlActive": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 0
            },
           "vehicleDistance": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 158169
            },
           "fuelLevel1": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 46
            },
           "engineSpeed": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 598
            },
           "ptoState": {
               "gpsDate": null,
               "value": null
            },
           "vehicleMotionDetect": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 0
            },
           "acceleratorPedalPosition": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 0
            },
           "totalEngineHours": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 2674
            },
           "overspeed": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 0
            },
           "axleWeight": {
               "gpsDate": "2025-11-07T11:45:33+01:00",
               "value": 14680
            },
           "serviceDistanceKm": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 136490
            },
           "directionIndicator": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 1
            },
           "fuelLevel2": {
               "gpsDate": null,
               "value": null
            },
           "enginePercentTorque": {
               "gpsDate": "2025-11-07T11:55:40+01:00",
               "value": 11
            }
        }
]}

Beispielaufrufe

Abfrage Zeitraum für eine Gruppe
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

Abfrage fester Zeitpunkt für ein Fahrzeug
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

Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident
https://map.yellowfox.de/rti/positions/get_fms_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}