Wiki source code of get_fms.php

Last modified by YellowFox_RD on 2025/03/12 14:22

version	line-number	content
1.1	1	(% class="box" %)
3.1	2	(((
4.1	3	Table of Contents
3.1	4	)))
	5
1.1	6	{{toc/}}
	7
4.1	8	Returns FMS data for a vehicle.
3.1	9
4.1	10	= Description =
3.1	11
	12	(% class="green mark" %)GET(%%) get_fms.php?company=//COMPANY_RTIKEY//&vehicle=//VEHICLE_RTIKEY//&start=//YYYYMMDDHHMMSS//&end=//YYYYMMDDHHMMSS&format=csv//
	13
1.1	14	= Parameter =
3.1	15
4.1	16	\|=Parameter\|=Description\|=Type\|=Note\|=Mandatory
	17	\|company\|RTI company key\|string\| \|yes
	18	\|vehicle\|RTI vehicle key\|string\| \|yes
	19	\|start\|start of interval\|datestring\|format: YYYYMMDDHHMMSS\|no
	20	\|end\|end of interval\|datestring\|format: YYYYMMDDHHMMSS
	21	Max. 24 hours between start and end of interval\|no
	22	\|format\|return format\|string\|csv (standard), xml or json\|no
1.1	23
4.1	24	= Return =
3.1	25
4.1	26	Return a string. In case of error "(% class="error" %)ERROR:Description(%%)" will be returned.
3.1	27
4.1	28	== CSV format ==
3.1	29
4.1	30	=== Meta data ===
3.1	31
4.1	32	\|=Delimiter\|semicolon( ; )
	33	\|=Text delimiter\|double quote ( " )
	34	\|=Line end\|0x0D 0x0A (CarriageReturn LineFeed)
	35	\|=Header\|first line
1.1	36
4.1	37	=== Columns ===
3.1	38
4.1	39	\|=Column\|=Description\|=
	40	\|VEHICLE\|license plate\|
	41	\|DATE\|gps date when measurement was created\|format: YYYY-MM-DD HH:MM:SS
	42	\|LAT\|latitude\|example.: 51.03659
	43	\|LON\|longitude\|example.: 13.59967
	44	\|PTO_STATE\|secondary engine on/ off\|0 = off, 1 = on
	45	\|ENGINE_SPEED\|engine speed in rpm\|
	46	\|TACHOGRAPH_VEHICLE_SPEED\|tachograph speed in km/h\|
	47	\|CLUTCH_SWITCH\|clutch usage within measurement interval\|
	48	\|BRAKE_SWITCH\|breake usage within measurement interval\|
	49	\|CRUISE_CONTROL_ACTIVE\|cruise control on/ off\|0 = off, 1 = on
	50	\|OVERSPEED\|overspeed warning on/ off\|0 = off, 1 = on
	51	\|ACCELATOR_PEDAL_POSITION\|position of accelator pedal in %\|
	52	\|AXLE_WEIGHT\|axle weight in kg\|
	53	\|FUEL_LEVEL\|fuel level in %\|
	54	\|ENGINE_COOLANT_TEMP\|engin coolant temperature in °C\|
	55	\|TOTAL_FUEL_USED\|total fuel used in liter\|
	56	\|TOTAL_ENGINE_HOURS\|total engine hours in h\|
	57	\|VEHICLE_DISTANCE\|total vehicle distance in km\|
	58	\|RTI_IDENT\|RTI Ident\|
	59	\|ADBLUE_LEVEL\|AdBlue fuel level in %\|
	60	\|TOTAL_LPG_USED\|total LPG(gas) used in kg\|
1.1	61
4.1	62	=== Example ===
3.1	63
4.1	64	== CSV format ==
3.1	65
4.1	66	return in csv
3.1	67	{{code language="java"}}"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"
4.1	68	"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"{{/code}}
1.1	69
4.1	70	== XML format ==
3.1	71
4.1	72	return in xml
1.1	73	{{code language="java"}}<?xml version="1.0" encoding="ISO-8859-1"?>
	74	<!DOCTYPE yf_fms SYSTEM "http://map.yellowfox.de/rti/dtd/yf_fms.dtd">
	75	<yf_fms>
	76	<ENTRY>
	77	<VEHICLE>DD-YF 2015</VEHICLE>
	78	<DATE>2015-10-20 16:24:57</DATE>
	79	<LAT>52.5718</LAT>
	80	<LON>11.21184</LON>
	81	<PTO_STATE>0</PTO_STATE>
	82	<ENGINE_SPEED>1208</ENGINE_SPEED>
	83	<TACHOGRAPH_VEHICLE_SPEED>83</TACHOGRAPH_VEHICLE_SPEED>
	84	<CLUTCH_SWITCH>0</CLUTCH_SWITCH>
	85	<BRAKE_SWITCH>0</BRAKE_SWITCH>
	86	<CRUISE_CONTROL_ACTIVE>1</CRUISE_CONTROL_ACTIVE>
	87	<OVERSPEED>0</OVERSPEED>
	88	<ACCELATOR_PEDAL_POSITION>0</ACCELATOR_PEDAL_POSITION>
	89	<AXLE_WEIGHT>0</AXLE_WEIGHT>
	90	<FUEL_LEVEL>100</FUEL_LEVEL>
	91	<ENGINE_COOLANT_TEMP>82</ENGINE_COOLANT_TEMP>
	92	<TOTAL_FUEL_USED>89833</TOTAL_FUEL_USED>
	93	<TOTAL_ENGINE_HOURS>5563</TOTAL_ENGINE_HOURS>
	94	<VEHICLE_DISTANCE>333903</VEHICLE_DISTANCE>
3.1	95	<RTI_IDENT>Ident1</RTI_IDENT>
	96	<ADBLUE_LEVEL>81</ADBLUE_LEVEL>
4.1	97	<TOTAL_LPG_USED>4280</TOTAL_LPG_USED>
	98	</ENTRY>
1.1	99	</yf_fms>{{/code}}
	100
4.1	101	== JSON format ==
3.1	102
4.1	103	return json
1.1	104	{{code language="java"}}[{
	105	"VEHICLE":"DD-YF 2015",
	106	"DATE":"2015-10-20 16:29:00",
	107	"LAT":52.5496,
	108	"LON":11.13903,
	109	"PTO_STATE":0,
	110	"ENGINE_SPEED":1196,
	111	"TACHOGRAPH_VEHICLE_SPEED":"83",
	112	"CLUTCH_SWITCH":0,
	113	"BRAKE_SWITCH":0,
	114	"CRUISE_CONTROL_ACTIVE":1,
	115	"OVERSPEED":0,
	116	"ACCELATOR_PEDAL_POSITION":"0",
	117	"AXLE_WEIGHT":"0",
	118	"FUEL_LEVEL":"99",
	119	"ENGINE_COOLANT_TEMP":"82",
	120	"TOTAL_FUEL_USED":"89834",
	121	"TOTAL_ENGINE_HOURS":"5563",
	122	"VEHICLE_DISTANCE":"333909",
4.1	123	"RTI_IDENT":"Ident1",
	124	"ADBLUE_LEVEL":"81",
	125	"TOTAL_LPG_USED":"4280"
1.1	126	}]{{/code}}
	127
4.1	128	= Example calls =
3.1	129
4.1	130	most current FMS data of a vehicle in CSV format
1.1	131	{{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
	132
	133	https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}
	134
4.1	135	FMS data of a vehicle within a certain time range in XML format
1.1	136	{{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20210401000000&end=20210401235959&format=xml
	137
	138	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}}
	139
4.1	140	FMS data of a vehicle within a certain time range in XML format
1.1	141	{{code language="java"}}https://map.yellowfox.de/rti/get_fms.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20210401000000&end=20210401235959&format=json
	142
	143	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{{/code}}
	144