get_fms.php
Table of Contents
Returns FMS data for a vehicle.
Description
GET get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&format=csv
Parameter
Parameter | Description | Type | Note | Mandatory |
---|---|---|---|---|
company | RTI company key | string | yes | |
vehicle | RTI vehicle key | string | yes | |
start | start of interval | datestring | format: YYYYMMDDHHMMSS | no |
end | end of interval | datestring | format: YYYYMMDDHHMMSS Max. 24 hours between start and end of interval | no |
format | return format | string | csv (standard), xml or json | no |
Return
Return a string. In case of error "ERROR:Description" will be returned.
CSV format
Meta data
Delimiter | semicolon( ; ) |
---|---|
Text delimiter | double quote ( " ) |
Line end | 0x0D 0x0A (CarriageReturn LineFeed) |
Header | first line |
Columns
Column | Description | |
---|---|---|
VEHICLE | license plate | |
DATE | gps date when measurement was created | format: YYYY-MM-DD HH:MM:SS |
LAT | latitude | example.: 51.03659 |
LON | longitude | example.: 13.59967 |
PTO_STATE | secondary engine on/ off | 0 = off, 1 = on |
ENGINE_SPEED | engine speed in rpm | |
TACHOGRAPH_VEHICLE_SPEED | tachograph speed in km/h | |
CLUTCH_SWITCH | clutch usage within measurement interval | |
BRAKE_SWITCH | breake usage within measurement interval | |
CRUISE_CONTROL_ACTIVE | cruise control on/ off | 0 = off, 1 = on |
OVERSPEED | overspeed warning on/ off | 0 = off, 1 = on |
ACCELATOR_PEDAL_POSITION | position of accelator pedal in % | |
AXLE_WEIGHT | axle weight in kg | |
FUEL_LEVEL | fuel level in % | |
ENGINE_COOLANT_TEMP | engin coolant temperature in °C | |
TOTAL_FUEL_USED | total fuel used in liter | |
TOTAL_ENGINE_HOURS | total engine hours in h | |
VEHICLE_DISTANCE | total vehicle distance in km | |
RTI_IDENT | RTI Ident | |
ADBLUE_LEVEL | AdBlue fuel level in % | |
TOTAL_LPG_USED | total LPG(gas) used in kg |
Example
CSV format
return in csv
"VEHICLE";"DATE";"LAT";"LON";"PTO_STATE";"ENGINE_SPEED";"TACHOGRAPH_VEHICLE_SPEED";"CLUTCH_SWITCH";"BRAKE_SWITCH";"CRUISE_CONTROL_ACTIVE";"OVERSPEED";"ACCELATOR_PEDAL_POSITION";"AXLE_WEIGHT";"FUEL_LEVEL";"ENGINE_COOLANT_TEMP";"TOTAL_FUEL_USED";"TOTAL_ENGINE_HOURS";"VEHICLE_DISTANCE";"RTI_IDENT";"ADBLUE_LEVEL";"TOTAL_LPG_USED"
"DD-YF 2015";"2015-10-20 16:58:25";"52.5317";"11.71469";"0";"1093";"17";"11";"2";"0";"0";"44";"0";"98";"82";"89843";"5563";"333941";"Ident1";"81";"4280"
XML format
return in xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE yf_fms SYSTEM "http://map.yellowfox.de/rti/dtd/yf_fms.dtd">
<yf_fms>
<ENTRY>
<VEHICLE>DD-YF 2015</VEHICLE>
<DATE>2015-10-20 16:24:57</DATE>
<LAT>52.5718</LAT>
<LON>11.21184</LON>
<PTO_STATE>0</PTO_STATE>
<ENGINE_SPEED>1208</ENGINE_SPEED>
<TACHOGRAPH_VEHICLE_SPEED>83</TACHOGRAPH_VEHICLE_SPEED>
<CLUTCH_SWITCH>0</CLUTCH_SWITCH>
<BRAKE_SWITCH>0</BRAKE_SWITCH>
<CRUISE_CONTROL_ACTIVE>1</CRUISE_CONTROL_ACTIVE>
<OVERSPEED>0</OVERSPEED>
<ACCELATOR_PEDAL_POSITION>0</ACCELATOR_PEDAL_POSITION>
<AXLE_WEIGHT>0</AXLE_WEIGHT>
<FUEL_LEVEL>100</FUEL_LEVEL>
<ENGINE_COOLANT_TEMP>82</ENGINE_COOLANT_TEMP>
<TOTAL_FUEL_USED>89833</TOTAL_FUEL_USED>
<TOTAL_ENGINE_HOURS>5563</TOTAL_ENGINE_HOURS>
<VEHICLE_DISTANCE>333903</VEHICLE_DISTANCE>
<RTI_IDENT>Ident1</RTI_IDENT>
<ADBLUE_LEVEL>81</ADBLUE_LEVEL>
<TOTAL_LPG_USED>4280</TOTAL_LPG_USED>
</ENTRY>
</yf_fms>
JSON format
return json
[{
"VEHICLE":"DD-YF 2015",
"DATE":"2015-10-20 16:29:00",
"LAT":52.5496,
"LON":11.13903,
"PTO_STATE":0,
"ENGINE_SPEED":1196,
"TACHOGRAPH_VEHICLE_SPEED":"83",
"CLUTCH_SWITCH":0,
"BRAKE_SWITCH":0,
"CRUISE_CONTROL_ACTIVE":1,
"OVERSPEED":0,
"ACCELATOR_PEDAL_POSITION":"0",
"AXLE_WEIGHT":"0",
"FUEL_LEVEL":"99",
"ENGINE_COOLANT_TEMP":"82",
"TOTAL_FUEL_USED":"89834",
"TOTAL_ENGINE_HOURS":"5563",
"VEHICLE_DISTANCE":"333909",
"RTI_IDENT":"Ident1",
"ADBLUE_LEVEL":"81",
"TOTAL_LPG_USED":"4280"
}]
Example calls
most current FMS data of a vehicle in CSV format
https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}
FMS data of a vehicle within a certain time range in XML format
https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20210401000000&end=20210401235959&format=xml
https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20210401000000&end=20210401235959&format=xml
FMS data of a vehicle within a certain time range in XML format
https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20210401000000&end=20210401235959&format=json
https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20210401000000&end=20210401235959&format=json