Wiki source code of positions/get_fms_data.php

Last modified by YellowFox_RD on 2025/11/27 08:21

version	line-number	content
3.1	1	{{toc/}}
	2
9.2	3	Returns the FMS values of a vehicle or vehicle group.
3.1	4
9.2	5	If no given date range, the most recent data per vehicle will be returned.
3.1	6
9.2	7	= Description =
	8
3.2	9	(% class="green mark" %)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//
3.1	10
	11	= Parameter =
	12
9.2	13	\|=Parameter\|=Description\|=Type\|=Hint\|=Mandatory
	14	\|company\|RTI company key\|string\| \|yes
	15	\|vehicle\|RTI vehicle key\|string\|(% colspan="1" rowspan="3" %)You need to set one of vehicle, group or import.\|(yes)
	16	\|group\|RTI group key\|string\|(yes)
	17	\|import\|RTI import key\|string\|(yes)
	18	\|start\|Start of query date range\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|no
	19	\|end\|End of query date range\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|no
	20	\|query_date\|(((
	21	Date of dataset
	22	)))\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|no
	23	\|offset\|This query will return 5000 entries at max. Use an offset to get the next block.\|int\| \|no
3.1	24
	25	{{info}}
9.2	26	Note on date restrictions
	27	You can use 3 different modes:
	28	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)
	29	b) You only specify query_date and receive the most recent report for each vehicle at that time
	30	c) You do not specify a date parameter and receive the most recent position for each vehicle
3.1	31
9.2	32	We recommend keeping the number of vehicles as low as possible in order to shorten the execution time, especially when querying historical data.
3.1	33	{{/info}}
	34
9.2	35	= Return value =
3.1	36
9.2	37	A string will be returned. On error "ERROR:Description" will be returned.
3.1	38
9.2	39	== Field description ==
3.1	40
9.2	41	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.
3.1	42
9.2	43	FMS values are transmitted cyclically by the vehicle in a collected message.
3.1	44
9.2	45	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.
3.1	46
9.2	47	=== Header ===
3.1	48
9.2	49	\|=Field\|=Description
	50	\|_date\|set date restriction
	51	\|_links\|(((
	52	If the query result exceeds the data limit, this is the link to next part of result.
	53	)))
	54	\|has_more\|Flag if there is more data
	55
3.1	56	=== Items ===
	57
9.2	58	==== Static values ====
3.5	59
9.2	60	These field are always available.
3.5	61
	62
9.2	63	(% style="background-color:#ffffff" %)
	64	\|=Field\|=Description
3.2	65	\|unit\|Fahrzeug mit Kennzeichen und RTI Ident
3.5	66
9.2	67	==== FMS values ====
3.5	68
9.2	69	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. Values are raw data according to officiall FMS interface. It might be necessary to interpret or format values after request.
3.5	70
9.2	71	\|=Field\|=Description
3.2	72	\|(((
	73	acceleratorPedalPosition
9.2	74	)))\|accelerator pedal positions in percent
3.2	75	\|(((
	76	adblueLevel
9.2	77	)))\|AdBlue level in percent
3.2	78	\|(((
	79	ambientAirTemperature
9.2	80	)))\|ambient air temperature in °C
3.2	81	\|(((
	82	atLeastOnePtoActive
9.2	83	)))\|Is at least one auxiliary drive active?
3.2	84	\|(((
	85	axleWeight
9.2	86	)))\|axle weight
3.2	87	\|(((
	88	brakeSwitch
9.2	89	)))\|Brake applied since last report
3.2	90	\|(((
	91	clutchSwitch
9.2	92	)))\|Clutch applied since last report
3.2	93	\|(((
	94	cruiseControlActive
9.2	95	)))\|Is cruise control active?
3.2	96	\|(((
	97	directionIndicator
9.2	98	)))\|direction of vehicle
3.2	99	\|(((
	100	engineCoolantTemp
9.2	101	)))\|engine temperature in °C
3.2	102	\|(((
	103	enginePercentLoad
9.2	104	)))\|engine torque in percent
3.2	105	\|(((
	106	enginePercentTorque
9.2	107	)))\|engine torque
3.2	108	\|(((
	109	engineSpeed
9.2	110	)))\|engine speed
3.2	111	\|(((
	112	fuelLevel1
9.2	113	)))\|fuel level 1 in percent
3.2	114	\|(((
	115	fuelLevel2
9.2	116	)))\|fuel level 2 in percent
3.2	117	\|(((
	118	fuelLiter
3.5	119	)))\|(((
9.2	120	fuel level in liter
3.5	121	)))
3.2	122	\|(((
	123	fuelRate
9.2	124	)))\|fuel consumption per hour
3.2	125	\|(((
	126	instantaneousFuelEconomy
9.2	127	)))\|fuel consumption in kilometres per liter
3.2	128	\|(((
	129	overspeed
9.2	130	)))\|overspeed warning
3.2	131	\|(((
	132	ptoState
9.2	133	)))\|Status of auxiliary drive
3.2	134	\|(((
	135	serviceBrakeAirPressure1
9.2	136	)))\|air pressure service brake 1
3.2	137	\|(((
	138	serviceBrakeAirPressure2
9.2	139	)))\|air pressure service brake 2
3.2	140	\|(((
	141	serviceDistanceKm
9.2	142	)))\|kilometres till next service
3.2	143	\|(((
	144	serviceIntervalDays
9.2	145	)))\|days till next service
3.2	146	\|(((
	147	serviceIntervalKm
9.2	148	)))\|kilometre interval service
3.2	149	\|(((
	150	tachoUnitSpeed
9.2	151	)))\|speed
3.2	152	\|(((
	153	totalEngineHours
9.2	154	)))\|total engine hours
3.2	155	\|(((
	156	totalFuelUsed
9.2	157	)))\|total used fuel in liter
3.2	158	\|(((
	159	totalGasUsed
9.2	160	)))\|total used gas
3.2	161	\|(((
	162	vehicleDistance
9.2	163	)))\|total milage
3.2	164	\|(((
	165	vehicleMotionDetect
9.2	166	)))\|(((
	167	Is the vehicle moving?
	168	)))
7.1	169	\|(((
	170	ignitionStatus
9.2	171	)))\|Is ignition on?
7.1	172	\|(((
	173	batteryVoltage
	174	)))\|(((
9.2	175	battery voltage in Volt
7.1	176	)))
	177	\|(((
	178	batteryWarning
9.2	179	)))\|Is there a battery warning?
7.1	180	\|(((
	181	batteryStatus
9.2	182	)))\|battery status
7.1	183	\|(((
	184	drivingEcoScoreFreewheel
9.2	185	)))\|Eco-Score freewheel in percent
7.1	186	\|(((
	187	drivingEcoScoreConstancy
9.2	188	)))\|Eco-Score constancy in percent
7.1	189	\|(((
	190	drivingEcoScoreBonusRange
9.2	191	)))\|Eco-Score bonus range in percent
7.1	192	\|(((
	193	drivingEcoScoreAcceleration
9.2	194	)))\|Eco-Score acceleration in percent
7.1	195	\|(((
	196	drivingConsumptionElectricalSinceReset
9.2	197	)))\|E-consumption since reset in kWh/100km
7.1	198	\|(((
	199	drivingConsumptionElectricalSinceStart
9.2	200	)))\|E-consumption since start in kWh/100km
7.1	201	\|(((
	202	drivingConsumptionFuelSinceReset
9.2	203	)))\|fuel usage since reset in l/100km
7.1	204	\|(((
	205	drivingRangeElectrical
9.2	206	)))\|E-driving range in km
7.1	207	\|(((
	208	drivingRangeElectricalMax
9.2	209	)))\|max E-driving range in km
7.1	210	\|(((
	211	drivingRangeFuel
9.2	212	)))\|fuel drinving range in km
7.1	213	\|(((
	214	fuelLevelWarning
9.2	215	)))\|Is there a fuel warning?
7.1	216	\|(((
	217	drivingRangeAdblue
9.2	218	)))\|AdBlue driving range in km
7.1	219	\|(((
	220	drivingConsumptionFuelSinceStart
9.2	221	)))\|fuel consumption since start in l/100km
7.1	222	\|(((
	223	drivingRangeFuelWarning
9.2	224	)))\|Is there a warning about fuel?
7.1	225	\|(((
	226	brakeFluidWarning
9.2	227	)))\|Is there a warning about brake fluid?
7.1	228	\|(((
	229	washWaterLevelWarning
9.2	230	)))\|Is there a warning about washing water?
7.1	231	\|(((
	232	brakePadsWarning
9.2	233	)))\|Is there a warning about brake pads?
7.1	234	\|(((
	235	engineCoolantWarning
9.2	236	)))\|Is there a warning about engine coolant?
7.1	237	\|(((
	238	brakePadsPrewarning
9.2	239	)))\|Is there a prewarning about brake pads?
7.1	240	\|(((
	241	engineLimpModeActive
9.2	242	)))\|Is there a warning about engine?
7.1	243	\|(((
	244	engineOilLevel
9.2	245	)))\|engine iol level in percent
7.1	246	\|(((
	247	engineOilLevelWarning
9.2	248	)))\|Is there a warning about engine oil?
7.1	249	\|(((
	250	drivingDistanceZeroEmissionsSinceReset
9.2	251	)))\|(((
	252	driven distance since reset without emissions
	253	)))
7.1	254	\|(((
	255	drivingDistanceZeroEmissionsSinceStart
9.2	256	)))\|driven distance since start without emissions
7.1	257	\|(((
	258	drivingTimeSinceStart
9.2	259	)))\|driving time since start in minutes
7.1	260	\|(((
	261	drivingDistanceElectricalSinceReset
9.2	262	)))\|driven kilometers by electrical power since reset
7.1	263	\|(((
	264	drivingDistanceElectricalSinceStart
9.2	265	)))\|driven kilometers by electrical power since start
7.1	266	\|(((
	267	drivingDistanceFuelSinceReset
9.2	268	)))\|driven kilometers by fuel since reset
7.1	269	\|(((
	270	drivingDistanceFuelSinceStart
9.2	271	)))\|(((
	272	driven kilometers by fuel since start
	273	)))
7.1	274	\|(((
	275	parkingBrakeIsEngaged
9.2	276	)))\|Is parking brake active?
7.1	277	\|(((
	278	lightsInteriorFrontOn
9.2	279	)))\|Is front interior light on?
7.1	280	\|(((
	281	lightsInteriorReadingLampFrontLeftOn
9.2	282	)))\|Is front left interior light on?
7.1	283	\|(((
	284	lightsInteriorReadingLampFrontRightOn
9.2	285	)))\|Is front right interior light on?
7.1	286	\|(((
	287	lightsInteriorRearOn
9.2	288	)))\|(((
	289	Is rear interior light on?
	290	)))
7.1	291	\|(((
	292	lightsLightSwitchStatus
9.2	293	)))\|light mode
7.1	294	\|(((
	295	electricalDriveChargingActive
9.2	296	)))\|Is electrival charging active?
7.1	297	\|(((
	298	electricalDriveChargingPower
9.2	299	)))\|E-charging power in kW
7.1	300	\|(((
	301	electricalDriveChargingStatus
9.2	302	)))\|E-chartging status
7.1	303	\|(((
	304	highVoltageBatteryStateOfCharge
9.2	305	)))\|E-charge level in percent
7.1	306	\|(((
	307	drivingStateOfChargeDeparture
9.2	308	)))\|E-charge level at departure in percent
7.1	309	\|(((
	310	electricalDriveChargingEndOfChargingTime
9.2	311	)))\|E-charging time in minutes
7.1	312	\|(((
	313	chargingEndOfChargingTimeWeekday
9.2	314	)))\|E-charging till
7.1	315	\|(((
	316	chargingSmartChargingStatus
9.2	317	)))\|state Smart-Charging
7.1	318	\|(((
	319	batteryChargeLevel
9.2	320	)))\|battery charage level in percent
7.1	321	\|(((
	322	drivingElectrical
9.2	323	)))\|Is the vehicle currently driving electrical?
7.1	324	\|(((
	325	batteryPowerConsumptionTotal
9.2	326	)))\|total E-consumption in kWh
7.1	327	\|(((
	328	batteryPowerRecupTotal
9.2	329	)))\|E-Power by recup in kWh
7.1	330	\|(((
	331	batteryPowerUsed
9.2	332	)))\|battery consumption in kW
7.1	333	\|(((
8.1	334	tyrePressureIso
	335	)))\|(((
9.2	336	tyre pressure as described in ISO 11992
3.1	337
9.2	338	This norm displays tyres asa coordinate system. The key of the result object is the coordinate of the tyre.
7.1	339
9.2	340	Example:
7.1	341
8.1	342	{
7.1	343
8.1	344	"17": { "gpsDate": [...], "value": 4.3},
7.1	345
8.1	346	"29": { "gpsDate": [...], "value": 4.2},
	347
	348	[...]
	349
	350	}
	351	)))
9.2	352	\|mainPowerVoltage\|main power voltage in Volt
7.1	353
9.2	354	==== Windows and doors ====
7.1	355
9.2	356	\|=Feld\|=Beschreibung
	357	\|(((
7.1	358	windowsFrontLeftOpen
9.2	359	)))\|Is front left window opened?
	360	\|(((
7.1	361	windowsFrontRightOpen
9.2	362	)))\|Is front right window opened?
	363	\|(((
7.1	364	windowsRearLeftOpen
9.2	365	)))\|Is rear left window opened?
	366	\|(((
7.1	367	windowsRearRightOpen
9.2	368	)))\|Is rear right window opened?
	369	\|(((
7.1	370	doorsFrontLeftLocked
9.2	371	)))\|Is front left door locked?
	372	\|(((
7.1	373	doorsFrontLeftOpen
9.2	374	)))\|Is front left door opened?
	375	\|(((
7.1	376	doorsFrontRightLocked
9.2	377	)))\|Is front right door locked?
	378	\|(((
7.1	379	doorsFrontRightOpen
9.2	380	)))\|Is front right door opened?
	381	\|(((
7.1	382	doorsRearLeftLocked
9.2	383	)))\|Is rear left door locked?
	384	\|(((
7.1	385	doorsRearLeftOpen
9.2	386	)))\|Is rear left door opened?
	387	\|(((
7.1	388	doorsRearRightLocked
9.2	389	)))\|Is rear right door locked?
	390	\|(((
7.1	391	doorsRearRightOpen
9.2	392	)))\|Is rear right door opened?
	393	\|(((
7.1	394	doorsTrunkLocked
9.2	395	)))\|Is trunk locked?
	396	\|(((
7.1	397	doorsTrunkOpen
9.2	398	)))\|Is trunk opened?
	399	\|(((
7.1	400	doorsSunroofStatus
9.2	401	)))\|state sunroof
	402	\|(((
7.1	403	doorsTankCapOpen
9.2	404	)))\|Is tank cap opened?
	405	\|(((
7.1	406	doorsVehicleLocked
9.2	407	)))\|Are all doors locked?
7.1	408
9.2	409	==== Values EBS ====
7.1	410
9.2	411	\|=(((
7.1	412	Feld
9.2	413	)))\|=(((
7.1	414	Beschreibung
	415	)))
9.2	416	\|(((
7.1	417	ebsAxleLoadSum
9.2	418	)))\|sum axle load in kg
	419	\|(((
7.1	420	ebsLoaded
9.2	421	)))\|Is the truck loaded?
	422	\|(((
7.1	423	ebsRedWarningSignal
9.2	424	)))\|Is there a red warning signal?
	425	\|(((
7.1	426	ebsAmberSignal
9.2	427	)))\|Is there a yellow warning signal?
	428	\|(((
7.1	429	ebsOverload
9.2	430	)))\|Is the truck overloaded?
7.1	431
9.2	432	==== Values ECT pumps ====
3.2	433
9.2	434	\|=Field\|=Description
3.2	435	\|(((
	436	ectAvgCellTemperature
9.2	437	)))\|average cell temperature
3.2	438	\|(((
	439	ectAvgCellVoltage
9.2	440	)))\|average cell voltage
3.2	441	\|(((
	442	ectBatteryManagementAmperage
9.2	443	)))\|Current consumption/output of the BMS
3.2	444	\|(((
	445	ectErrorCodeCount
9.2	446	)))\|number of errors
3.2	447	\|(((
	448	ectGeneratorActiveDuration
9.2	449	)))\|duration active state of generator
3.2	450	\|(((
	451	ectGeneratorControllerTemperature
9.2	452	)))\|temperature generator controller
3.2	453	\|(((
	454	ectGeneratorRuntime
9.2	455	)))\|runtime generator
3.2	456	\|(((
	457	ectGeneratorTemperature
9.2	458	)))\|temperature generator
3.2	459	\|(((
	460	ectHighPressurePumpControllerTemperature
9.2	461	)))\|(((
	462	temperature high pressure pump controller
	463	)))
3.2	464	\|(((
	465	ectHighPressurePumpDuration
9.2	466	)))\|(((
	467	duration active state of high pressure pump
	468	)))
3.2	469	\|(((
	470	ectHighPressurePumpEngineTemperature
9.2	471	)))\|(((
	472	temperature high pressure pump engine
	473	)))
3.2	474	\|(((
	475	ectHighPressurePumpRuntime
9.2	476	)))\|runtime high pressure pump
3.2	477	\|(((
	478	ectHighestCellTemperature
9.2	479	)))\|highest cell temperature
3.2	480	\|(((
	481	ectHighestCellVoltage
9.2	482	)))\|highest cell voltage
3.2	483	\|(((
	484	ectLastErrorCode
9.2	485	)))\|last error code
3.2	486	\|(((
	487	ectLowestCellTemperature
9.2	488	)))\|lowest cell temperature
3.2	489	\|(((
	490	ectLowestCellVoltage
9.2	491	)))\|lowest cell voltage
3.2	492	\|(((
	493	ectPumpSystemReadyDuration
9.2	494	)))\|(((
	495	duration ready state of pump system
	496	)))
3.2	497	\|(((
	498	ectStateOfCharge
9.2	499	)))\|state of charge
3.2	500	\|(((
	501	ectTotalBatteryVoltage
9.2	502	)))\|total battery voltage
3.2	503	\|(((
	504	ectVacuumPumpControllerTemperature
9.2	505	)))\|temperature vacuum pump controller
3.2	506	\|(((
	507	ectVacuumPumpDuration
9.2	508	)))\|(((
	509	duration active state of vacuum pump
	510	)))
3.2	511	\|(((
	512	ectVacuumPumpEngineTemperature
9.2	513	)))\|temperature vacuum pump engine
3.2	514	\|(((
	515	ectVacuumPumpRuntime
9.2	516	)))\|vacuum pump runtime
3.2	517
3.1	518	== JSON ==
	519
	520	{{code language="json"}}
	521	{
	522	"_date": {
	523	"query_date": "2025-11-07T13:07:23+01:00"
	524	},
	525	"_links": {
	526	"next": {
	527	"href": null
	528	}
	529	},
	530	"has_more": false,
	531	"items": [
	532	{
	533	"unit": {
	534	"licensePlate": "FTL YF 123",
	535	"rtiIdent": null
	536	},
	537	"engineCoolantTemp": {
	538	"gpsDate": "2025-11-07T11:55:40+01:00",
	539	"value": 79
	540	},
	541	"totalFuelUsed": {
	542	"gpsDate": "2025-11-07T11:55:40+01:00",
	543	"value": 44105
	544	},
	545	"tachoUnitSpeed": {
	546	"gpsDate": "2025-11-07T11:55:40+01:00",
	547	"value": 0
	548	},
	549	"cruiseControlActive": {
	550	"gpsDate": "2025-11-07T11:55:40+01:00",
	551	"value": 0
	552	},
	553	"vehicleDistance": {
	554	"gpsDate": "2025-11-07T11:55:40+01:00",
	555	"value": 158169
	556	},
	557	"fuelLevel1": {
	558	"gpsDate": "2025-11-07T11:55:40+01:00",
	559	"value": 46
	560	},
	561	"engineSpeed": {
	562	"gpsDate": "2025-11-07T11:55:40+01:00",
	563	"value": 598
	564	},
	565	"ptoState": {
	566	"gpsDate": null,
	567	"value": null
	568	},
	569	"vehicleMotionDetect": {
	570	"gpsDate": "2025-11-07T11:55:40+01:00",
	571	"value": 0
	572	},
	573	"acceleratorPedalPosition": {
	574	"gpsDate": "2025-11-07T11:55:40+01:00",
	575	"value": 0
	576	},
	577	"totalEngineHours": {
	578	"gpsDate": "2025-11-07T11:55:40+01:00",
	579	"value": 2674
	580	},
	581	"overspeed": {
	582	"gpsDate": "2025-11-07T11:55:40+01:00",
	583	"value": 0
	584	},
	585	"axleWeight": {
	586	"gpsDate": "2025-11-07T11:45:33+01:00",
	587	"value": 14680
	588	},
	589	"serviceDistanceKm": {
	590	"gpsDate": "2025-11-07T11:55:40+01:00",
	591	"value": 136490
	592	},
	593	"directionIndicator": {
	594	"gpsDate": "2025-11-07T11:55:40+01:00",
	595	"value": 1
	596	},
	597	"fuelLevel2": {
	598	"gpsDate": null,
	599	"value": null
	600	},
	601	"enginePercentTorque": {
	602	"gpsDate": "2025-11-07T11:55:40+01:00",
	603	"value": 11
	604	}
	605	}
	606	]}
	607	{{/code}}
	608
9.2	609	= Example cals =
3.1	610
9.2	611	Date range for a group
3.1	612	{{code language="java"}}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{{/code}}
	613
9.2	614	Query date for vehicle
3.1	615	{{code language="java"}}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{{/code}}
	616
9.2	617	Latest data for vehicle by RTI Ident
3.1	618	{{code language="java"}}https://map.yellowfox.de/rti/positions/get_fms_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}