positions/get_fms_data.php

Last modified by YellowFox_RD on 2025/11/10 08:40

Description
Parameter
Return value
- Field description
  - Header
  - Items
- JSON
Example cals

Returns the FMS values of a vehicle or vehicle group.

If no given date range, the most recent data per vehicle will be returned.

Description

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	Description	Type	Hint	Mandatory
company	RTI company key	string		yes
vehicle	RTI vehicle key	string	You need to set one of vehicle, group or import.	(yes)
group	RTI group key	string		(yes)
import	RTI import key	string		(yes)
start	Start of query date range	datestring	Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS+HH:mm)	no
end	End of query date range	datestring	Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS+HH:mm)	no
query_date	Date of dataset	datestring	Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS+HH:mm)	no
offset	This query will return 5000 entries at max. Use an offset to get the next block.	int		no

Note on date restrictions
You can use 3 different modes:
a) You specify start and end and receive all positions within this time period (these two times may be no more than 24 hours apart)
b) You only specify query_date and receive the most recent report for each vehicle at that time
c) You do not specify a date parameter and receive the most recent position for each vehicle

We recommend keeping the number of vehicles as low as possible in order to shorten the execution time, especially when querying historical data.

Return value

A string will be returned. On error "ERROR:Description" will be returned.

Field description

This functions result builds dynamically. It will only return fms values which are available for at least one of your requested vehicles. This means you might not get all documented result keys. Which FMS values are available, depends on your vehicle, the type of installed telematic box and the booked tariff. If you are missing a value, please contact our support.

FMS values are transmitted cyclically by the vehicle in a collected message.

You can use this function to query these messages. Some values may not be present in every message. If you query historical data (i.e., you have entered a specific date), data records may therefore also contain NULL values. If you query without a date, you will receive the current status of the vehicles. Here you will receive the latest known value for each FMS value. However, the individual values may be of different ages. Therefore, the return value of this function contains a separate timestamp for each individual FMS value.

Header

Field	Description
_date	set date restriction
_links	If the query result exceeds the data limit, this is the link to next part of result.
has_more	Flag if there is more data

Items

Static values

These field are always available.

Field	Description
unit	Fahrzeug mit Kennzeichen und RTI Ident

FMS values

FMS values are always an object of value and gpsDate. They both might be NULL if the vehicle does not support or send a value.

Field	Description
acceleratorPedalPosition	accelerator pedal positions in percent
adblueLevel	AdBlue level in percent
ambientAirTemperature	ambient air temperature in °C
atLeastOnePtoActive	Is at least one auxiliary drive active?
axleWeight	axle weight
brakeSwitch	Brake applied since last report
clutchSwitch	Clutch applied since last report
cruiseControlActive	Is cruise control active?
directionIndicator	direction of vehicle
engineCoolantTemp	engine temperature in °C
enginePercentLoad	engine torque in percent
enginePercentTorque	engine torque
engineSpeed	engine speed
fuelLevel1	fuel level 1 in percent
fuelLevel2	fuel level 2 in percent
fuelLiter	fuel level in liter
fuelRate	fuel consumption per hour
instantaneousFuelEconomy	fuel consumption in kilometres per liter
overspeed	overspeed warning
ptoState	Status of auxiliary drive
serviceBrakeAirPressure1	air pressure service brake 1
serviceBrakeAirPressure2	air pressure service brake 2
serviceDistanceKm	kilometres till next service
serviceIntervalDays	days till next service
serviceIntervalKm	kilometre interval service
tachoUnitSpeed	speed
totalEngineHours	total engine hours
totalFuelUsed	total used fuel in liter
totalGasUsed	total used gas
vehicleDistance	total milage
vehicleMotionDetect	Is the vehicle moving?

Values ECT pumps

Field	Description
ectAvgCellTemperature	average cell temperature
ectAvgCellVoltage	average cell voltage
ectBatteryManagementAmperage	Current consumption/output of the BMS
ectErrorCodeCount	number of errors
ectGeneratorActiveDuration	duration active state of generator
ectGeneratorControllerTemperature	temperature generator controller
ectGeneratorRuntime	runtime generator
ectGeneratorTemperature	temperature generator
ectHighPressurePumpControllerTemperature	temperature high pressure pump controller
ectHighPressurePumpDuration	duration active state of high pressure pump
ectHighPressurePumpEngineTemperature	temperature high pressure pump engine
ectHighPressurePumpRuntime	runtime high pressure pump
ectHighestCellTemperature	highest cell temperature
ectHighestCellVoltage	highest cell voltage
ectLastErrorCode	last error code
ectLowestCellTemperature	lowest cell temperature
ectLowestCellVoltage	lowest cell voltage
ectPumpSystemReadyDuration	duration ready state of pump system
ectStateOfCharge	state of charge
ectTotalBatteryVoltage	total battery voltage
ectVacuumPumpControllerTemperature	temperature vacuum pump controller
ectVacuumPumpDuration	duration active state of vacuum pump
ectVacuumPumpEngineTemperature	temperature vacuum pump engine
ectVacuumPumpRuntime	vacuum pump runtime

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
            }
        }
]}

Example cals

Date range for a group
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

Query date for vehicle
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

Latest data for vehicle by 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"}