Versions Compared

Old Version 29

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version 30

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageen

Returns FMS data for a vehicle.

Description

Status
colourGreen
titleGET
 get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&format=csv

Parameter

ParameterDescriptionTypeNoteMandatory
companyRTI company keystring
yes
vehicleRTI vehicle keystring
yes
startstart of intervaldatestring

format: YYYYMMDDHHMMSS

no

endend of interval
datestring

format: YYYYMMDDHHMMSS

Max. 24 hours between start and end of interval

no
formatreturn formatstringcsv (standard), xml or jsonno

Return

Return a string. In case of error "ERROR:Description" will be returned.

CSV format

Meta data

Delimitersemicolon( ; )
Text delimiterdouble quote ( " )
Line end0x0D 0x0A (CarriageReturn LineFeed)
Headerfirst line

Columns

ColumnDescription
VEHICLElicense plate
DATEgps date when measurement was createdformat: YYYY-MM-DD HH:MM:SS
LATlatitudeexample.: 51.03659
LONlongitudeexample.: 13.59967
PTO_STATE

secondary engine on/ off

0 = off, 1 = on
ENGINE_SPEEDengine speed in rpm
TACHOGRAPH_VEHICLE_SPEEDtachograph speed in km/h
CLUTCH_SWITCHclutch usage within measurement interval
BRAKE_SWITCHbreake usage within measurement interval
CRUISE_CONTROL_ACTIVEcruise control on/ off0 = off, 1 = on
OVERSPEEDoverspeed warning on/ off0 = off, 1 = on
ACCELATOR_PEDAL_POSITIONposition of accelator pedal in %
AXLE_WEIGHT

axle weight in kg


FUEL_LEVEL

fuel level in %   


ENGINE_COOLANT_TEMPengin coolant temperature in °C
TOTAL_FUEL_USEDtotal fuel used in liter
TOTAL_ENGINE_HOURStotal engine hours in h
VEHICLE_DISTANCE

total vehicle distance in km


RTI_IDENTRTI Ident

Example

CSV format

Code Block
titlereturn 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"
"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"

XML format

Code Block
titlereturn 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>
    </ENTRY>
</yf_fms>

JSON format

Code Block
titlereturn 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"
}]


Example calls

Code Block
titlemost 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"}


Code Block
title 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


Code Block
titleFMS 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
Code Block
titleFMS data of a vehicle within a certain time range in XML format
json

https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY{"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20210401000000&end=20210401235959&format=json