Wiki-Quellcode von positions/get_fms_data.php

Version 3.5 von YellowFox_RD am 2025/11/07 14:12

version	line-number	content
3.1	1	Inhaltsverzeichnis
	2
	3	{{toc/}}
	4
3.2	5	Gibt die FMS Daten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
	6	Wird keine Zeitraumsbegrenzung mitgegeben, wird der aktuellste Datensatz pro Fahrzeug zurück geliefert.
3.1	7
	8	= Beschreibung =
	9
3.2	10	(% 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	11
	12	= Parameter =
	13
	14	\|=Parameter\|=Beschreibung\|=Typ\|=Hinweis\|=Pflicht
	15	\|company\|RTI Firmenschlüssel\|string\| \|ja
	16	\|vehicle\|RTI Fahrzeugschlüssel\|string\|(% colspan="1" rowspan="3" %)Es muss entweder vehicle, group oder import angegeben werden.\| (ja)
	17	\|group\|RTI Gruppenschlüssel\|string\| (ja)
	18	\|import\|RTI Importschlüssel\|string\|(ja)
	19	\|start\|Anfang des Abfragezeitraum\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|nein
	20	\|end\|Ende des Abfragezeitraum\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|nein
	21	\|query_date\|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|nein
	22	\|offset\|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.\|int\| \|nein
	23
	24	{{info}}
	25	Hinweis zur Datumseingrenzung
	26	Sie können 3 verschiedene Modi nutzen:
	27	a) Sie geben start und end an und erhalten damit alle Positionen innerhalb dieser Zeitspanne (diese beiden Zeitangaben dürfen maximal 24 Stunden auseinander liegen)
	28	b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
	29	c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug
	30
	31
	32	Wir empfehlen zu Gunsten einer verkürzten Ausfrührungszeit ins besondere bei der Abfrage historischer Daten die Anzahl der Fahrzeuge möglichst gering zu halten.
	33	{{/info}}
	34
	35	= Rückgabe =
	36
	37	Es wird ein string zurückgegeben. Im Fehlerfall wird "ERROR:Beschreibung" zurückgegeben.
	38
	39	== Feldbeschreibung ==
	40
	41	Diese Funktion setzt sich dynamisch zusammen. Sie gibt nur die FMS Werte zurück, die für mindestens eines Ihrer abgefragten Fahrzeuge existieren. Das bedeutet, dass möglicherweise nicht alle dokumentierten Schlüssel in Ihrer Rückgabe vorhanden sind. Welche FMS Werte für Sie verfügbar sind, hängt an Ihrem Fahrzeug, der Art der eingebauten Telematikbox und Ihrem gebuchten Fahrzeugtarif. Sollten Sie einen Wert für Ihr Fahrzeug vermissen, kontaktieren Sie gern unseren Support.
	42
	43	FMS Werte werden zyklisch vom Fahrzeug in einer gesammelten Meldung übertragen. Diese Meldungen können Sie mit dieser Funktion abfragen. Bei einigen Werten kann es vorkommen, dass diese nicht in jeder Meldung vorhanden sind. Wenn Sie historische Daten abfragen (d.h. Sie haben ein konkretes Datum übergeben) können Datensätze daher auch NULL Werte enthalten. Wenn Sie ohne Datum anfragen erhalten Sie den aktuellen Stand der Fahrzeuge. Hier erhalten Sie pro FMS Wert den aktuellsten bekannten Wert. Die einzelnen Werte sind aber möglicherweise unterschiedlich alt. Daher enthält die Rückgabe dieser Funktion für jeden einzelnen FMS Wert einen eigenen Zeitstempel.
	44
3.2	45	=== Kopfdaten ===
3.1	46
	47	\|=Feld\|=Beschreibung
	48	\|_date\|Gesetzte Datumseinschränkung
	49	\|_links\|Sollte Ihre Anfrage das Limit übersteigen, finden Sie hier einen Link zum nächsten Teil der Ergebnismenge.
	50	\|has_more\|Flag ob es noch mehr Daten zu holen gibt.
	51
	52	=== Items ===
	53
3.5	54	==== Statische Werte ====
	55
	56	Diese Felder sind immer enthalten.
	57
	58
3.1	59	\|=Feld\|=Beschreibung
3.2	60	\|unit\|Fahrzeug mit Kennzeichen und RTI Ident
3.5	61
	62	==== FMS Werte ====
	63
	64	FMS Werte sind immer ein Objekt aus value und gpsDate. Value und gpsDate können jedoch NULL sein wenn das Fahrzeug diesen Wert nicht unterstützt oder nicht sendet.
	65
	66	\|=Feld\|=Beschreibung
3.2	67	\|(((
	68	acceleratorPedalPosition
3.5	69	)))\|Gaspedalposition in Prozent
3.2	70	\|(((
	71	adblueLevel
3.5	72	)))\|AdBlue Füllstand in Prozent
3.2	73	\|(((
	74	ambientAirTemperature
3.5	75	)))\|Außentemperatur in °C
3.2	76	\|(((
	77	atLeastOnePtoActive
3.5	78	)))\|Ist wenigstens ein Nebenantrieb aktiv?
3.2	79	\|(((
	80	axleWeight
3.5	81	)))\|Achslast
3.2	82	\|(((
	83	brakeSwitch
3.5	84	)))\|Bremse betätigt seit der letzten Meldung
3.2	85	\|(((
	86	clutchSwitch
3.5	87	)))\|Kupplung betätigt seit der letzten Meldung
3.2	88	\|(((
	89	cruiseControlActive
3.5	90	)))\|Ist der Tempomat an?
3.2	91	\|(((
	92	directionIndicator
3.5	93	)))\|Richtung des Fahrzeuges
3.2	94	\|(((
	95	engineCoolantTemp
3.5	96	)))\|Temperatur Motor in °C
3.2	97	\|(((
	98	enginePercentLoad
3.5	99	)))\|Motordrehmoment in Prozent
3.2	100	\|(((
	101	enginePercentTorque
3.5	102	)))\|Drehmoment
3.2	103	\|(((
	104	engineSpeed
3.5	105	)))\|Motorumdrehungen
3.2	106	\|(((
	107	fuelLevel1
3.5	108	)))\|Tankfüllstand 1 in Prozent
3.2	109	\|(((
	110	fuelLevel2
3.5	111	)))\|Tankfüllstand 2 in Prozent
3.2	112	\|(((
	113	fuelLiter
3.5	114	)))\|(((
	115	Tankinhalt in Litern
	116	)))
3.2	117	\|(((
	118	fuelRate
3.5	119	)))\|Kraftstoffverbauch pro Stunde
3.2	120	\|(((
	121	instantaneousFuelEconomy
3.5	122	)))\|Kraftstoffverbrauch in Kilometern pro Liter
3.2	123	\|(((
	124	overspeed
3.5	125	)))\|Übergeschwindigkeitswarnung
3.2	126	\|(((
	127	ptoState
3.5	128	)))\|Status Nebenantrieb
3.2	129	\|(((
	130	serviceBrakeAirPressure1
3.5	131	)))\|Luftdruck Betriebsbremse 1
3.2	132	\|(((
	133	serviceBrakeAirPressure2
3.5	134	)))\|Luftdruck Betriebsbremse 2
3.2	135	\|(((
	136	serviceDistanceKm
3.5	137	)))\|Kilometer bis zum nächsten Service
3.2	138	\|(((
	139	serviceIntervalDays
3.5	140	)))\|Tage bis zum nächsten Service
3.2	141	\|(((
	142	serviceIntervalKm
3.5	143	)))\|Kilometerintervall Service
3.2	144	\|(((
	145	tachoUnitSpeed
3.5	146	)))\|Geschwindigkeit
3.2	147	\|(((
	148	totalEngineHours
3.5	149	)))\|Gesamtlaufleistung
3.2	150	\|(((
	151	totalFuelUsed
3.5	152	)))\|Gesamtmenge des verbauchten Treibstoffs in Litern
3.2	153	\|(((
	154	totalGasUsed
3.5	155	)))\|Gesamtmenge des verbrauchten Gas
3.2	156	\|(((
	157	vehicleDistance
3.5	158	)))\|Gesamtmenge der zurückgelegten Kilometer
3.2	159	\|(((
	160	vehicleMotionDetect
3.5	161	)))\|Ist das Fahrzeug in Bewegung?
3.1	162
3.2	163	==== Werte ECT Pumpen ====
	164
3.4	165	\|=Feld\|=Beschreibung
3.2	166	\|(((
	167	ectAvgCellTemperature
3.3	168	)))\|Durchschnittliche Zelltemperatur
3.2	169	\|(((
	170	ectAvgCellVoltage
	171	)))\|Durchschnittliche Zellspannung
	172	\|(((
	173	ectBatteryManagementAmperage
3.3	174	)))\|Stromaufnahme/-abgabe des BMS
3.2	175	\|(((
	176	ectErrorCodeCount
3.3	177	)))\|Anzahl der Fehlercodes
3.2	178	\|(((
	179	ectGeneratorActiveDuration
3.3	180	)))\|Dauer des Active-Status des Generators
3.2	181	\|(((
	182	ectGeneratorControllerTemperature
3.3	183	)))\|Temperatur des Generator-Controllers
3.2	184	\|(((
	185	ectGeneratorRuntime
3.3	186	)))\|Laufzeit des Generators
3.2	187	\|(((
	188	ectGeneratorTemperature
3.3	189	)))\|Temperatur des Generators
3.2	190	\|(((
	191	ectHighPressurePumpControllerTemperature
3.3	192	)))\|Temperatur des Controllers der Hochdruckpumpe
3.2	193	\|(((
	194	ectHighPressurePumpDuration
3.3	195	)))\|Dauer des Active-Status der Hochdruckpumpe
3.2	196	\|(((
	197	ectHighPressurePumpEngineTemperature
3.3	198	)))\|Temperatur des Hochdruckpumpenmotors
3.2	199	\|(((
	200	ectHighPressurePumpRuntime
3.3	201	)))\|Laufzeit der Hochdruckpumpe
3.2	202	\|(((
	203	ectHighestCellTemperature
3.3	204	)))\|Höchste Zelltemperatur
3.2	205	\|(((
	206	ectHighestCellVoltage
	207	)))\|Höchste Zellspannung
	208	\|(((
	209	ectLastErrorCode
3.3	210	)))\|Letzter Fehlercode
3.2	211	\|(((
	212	ectLowestCellTemperature
3.3	213	)))\|Niedrigste Zelltemperatur
3.2	214	\|(((
	215	ectLowestCellVoltage
	216	)))\|Niedrigste Zellspannung
	217	\|(((
	218	ectPumpSystemReadyDuration
3.3	219	)))\|Dauer des Ready-Status des Pumpensystems
3.2	220	\|(((
	221	ectStateOfCharge
3.3	222	)))\|Ladezustand des Akkus
3.2	223	\|(((
	224	ectTotalBatteryVoltage
	225	)))\|Gesamtspannung des Akkus
	226	\|(((
	227	ectVacuumPumpControllerTemperature
3.3	228	)))\|Temperatur des Controllers der Vakuumpumpe
3.2	229	\|(((
	230	ectVacuumPumpDuration
3.3	231	)))\|Dauer des Active-Status der Vakuumpumpe
3.2	232	\|(((
	233	ectVacuumPumpEngineTemperature
3.3	234	)))\|Temperatur des Vakuumpumpenmotors
3.2	235	\|(((
	236	ectVacuumPumpRuntime
3.3	237	)))\|Laufzeit der Vakuumpumpe
3.2	238
3.1	239	== JSON ==
	240
	241	Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
	242
	243	{{code language="json"}}
	244	{
	245	"_date": {
	246	"query_date": "2025-11-07T13:07:23+01:00"
	247	},
	248	"_links": {
	249	"next": {
	250	"href": null
	251	}
	252	},
	253	"has_more": false,
	254	"items": [
	255	{
	256	"unit": {
	257	"licensePlate": "FTL YF 123",
	258	"rtiIdent": null
	259	},
	260	"engineCoolantTemp": {
	261	"gpsDate": "2025-11-07T11:55:40+01:00",
	262	"value": 79
	263	},
	264	"totalFuelUsed": {
	265	"gpsDate": "2025-11-07T11:55:40+01:00",
	266	"value": 44105
	267	},
	268	"tachoUnitSpeed": {
	269	"gpsDate": "2025-11-07T11:55:40+01:00",
	270	"value": 0
	271	},
	272	"cruiseControlActive": {
	273	"gpsDate": "2025-11-07T11:55:40+01:00",
	274	"value": 0
	275	},
	276	"vehicleDistance": {
	277	"gpsDate": "2025-11-07T11:55:40+01:00",
	278	"value": 158169
	279	},
	280	"fuelLevel1": {
	281	"gpsDate": "2025-11-07T11:55:40+01:00",
	282	"value": 46
	283	},
	284	"engineSpeed": {
	285	"gpsDate": "2025-11-07T11:55:40+01:00",
	286	"value": 598
	287	},
	288	"ptoState": {
	289	"gpsDate": null,
	290	"value": null
	291	},
	292	"vehicleMotionDetect": {
	293	"gpsDate": "2025-11-07T11:55:40+01:00",
	294	"value": 0
	295	},
	296	"acceleratorPedalPosition": {
	297	"gpsDate": "2025-11-07T11:55:40+01:00",
	298	"value": 0
	299	},
	300	"totalEngineHours": {
	301	"gpsDate": "2025-11-07T11:55:40+01:00",
	302	"value": 2674
	303	},
	304	"overspeed": {
	305	"gpsDate": "2025-11-07T11:55:40+01:00",
	306	"value": 0
	307	},
	308	"axleWeight": {
	309	"gpsDate": "2025-11-07T11:45:33+01:00",
	310	"value": 14680
	311	},
	312	"serviceDistanceKm": {
	313	"gpsDate": "2025-11-07T11:55:40+01:00",
	314	"value": 136490
	315	},
	316	"directionIndicator": {
	317	"gpsDate": "2025-11-07T11:55:40+01:00",
	318	"value": 1
	319	},
	320	"fuelLevel2": {
	321	"gpsDate": null,
	322	"value": null
	323	},
	324	"enginePercentTorque": {
	325	"gpsDate": "2025-11-07T11:55:40+01:00",
	326	"value": 11
	327	}
	328	}
	329	]}
	330	{{/code}}
	331
	332	= Beispielaufrufe =
	333
	334	Abfrage Zeitraum für eine Gruppe
	335	{{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}}
	336
	337	Abfrage fester Zeitpunkt für ein Fahrzeug
	338	{{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}}
	339
	340	Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident
	341	{{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}}