Änderungen von Dokument positions/get_fms_data.php

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,0 +1,330 @@
	1	+Inhaltsverzeichnis
	2	+
	3	+{{toc/}}
	4	+
	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.
	7	+
	8	+= Beschreibung =
	9	+
	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//**
	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	+
	45	+=== Kopfdaten ===
	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	+
	54	+|=Feld|=Beschreibung
	55	+|unit|Fahrzeug mit Kennzeichen und RTI Ident
	56	+|(((
	57	+acceleratorPedalPosition
	58	+)))|
	59	+|(((
	60	+adblueLevel
	61	+)))|
	62	+|(((
	63	+ambientAirTemperature
	64	+)))|
	65	+|(((
	66	+atLeastOnePtoActive
	67	+)))|
	68	+|(((
	69	+axleWeight
	70	+)))|
	71	+|(((
	72	+brakeSwitch
	73	+)))|
	74	+|(((
	75	+clutchSwitch
	76	+)))|
	77	+|(((
	78	+cruiseControlActive
	79	+)))|
	80	+|(((
	81	+directionIndicator
	82	+)))|
	83	+|(((
	84	+engineCoolantTemp
	85	+)))|
	86	+|(((
	87	+enginePercentLoad
	88	+)))|
	89	+|(((
	90	+enginePercentTorque
	91	+)))|
	92	+|(((
	93	+engineSpeed
	94	+)))|
	95	+|(((
	96	+fuelLevel1
	97	+)))|
	98	+|(((
	99	+fuelLevel2
	100	+)))|
	101	+|(((
	102	+fuelLiter
	103	+)))|
	104	+|(((
	105	+fuelRate
	106	+)))|
	107	+|(((
	108	+instantaneousFuelEconomy
	109	+)))|
	110	+|(((
	111	+overspeed
	112	+)))|
	113	+|(((
	114	+ptoState
	115	+)))|
	116	+|(((
	117	+serviceBrakeAirPressure1
	118	+)))|
	119	+|(((
	120	+serviceBrakeAirPressure2
	121	+)))|
	122	+|(((
	123	+serviceDistanceKm
	124	+)))|
	125	+|(((
	126	+serviceIntervalDays
	127	+)))|
	128	+|(((
	129	+serviceIntervalKm
	130	+)))|
	131	+|(((
	132	+tachoUnitSpeed
	133	+)))|
	134	+|(((
	135	+totalEngineHours
	136	+)))|
	137	+|(((
	138	+totalFuelUsed
	139	+)))|
	140	+|(((
	141	+totalGasUsed
	142	+)))|
	143	+|(((
	144	+vehicleDistance
	145	+)))|
	146	+|(((
	147	+vehicleMotionDetect
	148	+)))|
	149	+
	150	+
	151	+
	152	+==== Werte ECT Pumpen ====
	153	+
	154	+|=Feld|=Beschreibung
	155	+|(((
	156	+ectAvgCellTemperature
	157	+)))|Durchschnittliche Zelltemperatur
	158	+|(((
	159	+ectAvgCellVoltage
	160	+)))|Durchschnittliche Zellspannung
	161	+|(((
	162	+ectBatteryManagementAmperage
	163	+)))|Stromaufnahme/-abgabe des BMS
	164	+|(((
	165	+ectErrorCodeCount
	166	+)))|Anzahl der Fehlercodes
	167	+|(((
	168	+ectGeneratorActiveDuration
	169	+)))|Dauer des Active-Status des Generators
	170	+|(((
	171	+ectGeneratorControllerTemperature
	172	+)))|Temperatur des Generator-Controllers
	173	+|(((
	174	+ectGeneratorRuntime
	175	+)))|Laufzeit des Generators
	176	+|(((
	177	+ectGeneratorTemperature
	178	+)))|Temperatur des Generators
	179	+|(((
	180	+ectHighPressurePumpControllerTemperature
	181	+)))|Temperatur des Controllers der Hochdruckpumpe
	182	+|(((
	183	+ectHighPressurePumpDuration
	184	+)))|Dauer des Active-Status der Hochdruckpumpe
	185	+|(((
	186	+ectHighPressurePumpEngineTemperature
	187	+)))|Temperatur des Hochdruckpumpenmotors
	188	+|(((
	189	+ectHighPressurePumpRuntime
	190	+)))|Laufzeit der Hochdruckpumpe
	191	+|(((
	192	+ectHighestCellTemperature
	193	+)))|Höchste Zelltemperatur
	194	+|(((
	195	+ectHighestCellVoltage
	196	+)))|Höchste Zellspannung
	197	+|(((
	198	+ectLastErrorCode
	199	+)))|Letzter Fehlercode
	200	+|(((
	201	+ectLowestCellTemperature
	202	+)))|Niedrigste Zelltemperatur
	203	+|(((
	204	+ectLowestCellVoltage
	205	+)))|Niedrigste Zellspannung
	206	+|(((
	207	+ectPumpSystemReadyDuration
	208	+)))|Dauer des Ready-Status des Pumpensystems
	209	+|(((
	210	+ectStateOfCharge
	211	+)))|Ladezustand des Akkus
	212	+|(((
	213	+ectTotalBatteryVoltage
	214	+)))|Gesamtspannung des Akkus
	215	+|(((
	216	+ectVacuumPumpControllerTemperature
	217	+)))|Temperatur des Controllers der Vakuumpumpe
	218	+|(((
	219	+ectVacuumPumpDuration
	220	+)))|Dauer des Active-Status der Vakuumpumpe
	221	+|(((
	222	+ectVacuumPumpEngineTemperature
	223	+)))|Temperatur des Vakuumpumpenmotors
	224	+|(((
	225	+ectVacuumPumpRuntime
	226	+)))|Laufzeit der Vakuumpumpe
	227	+
	228	+== JSON ==
	229	+
	230	+Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
	231	+
	232	+{{code language="json"}}
	233	+{
	234	+ "_date": {
	235	+ "query_date": "2025-11-07T13:07:23+01:00"
	236	+ },
	237	+ "_links": {
	238	+ "next": {
	239	+ "href": null
	240	+ }
	241	+ },
	242	+ "has_more": false,
	243	+ "items": [
	244	+ {
	245	+ "unit": {
	246	+ "licensePlate": "FTL YF 123",
	247	+ "rtiIdent": null
	248	+ },
	249	+ "engineCoolantTemp": {
	250	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	251	+ "value": 79
	252	+ },
	253	+ "totalFuelUsed": {
	254	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	255	+ "value": 44105
	256	+ },
	257	+ "tachoUnitSpeed": {
	258	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	259	+ "value": 0
	260	+ },
	261	+ "cruiseControlActive": {
	262	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	263	+ "value": 0
	264	+ },
	265	+ "vehicleDistance": {
	266	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	267	+ "value": 158169
	268	+ },
	269	+ "fuelLevel1": {
	270	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	271	+ "value": 46
	272	+ },
	273	+ "engineSpeed": {
	274	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	275	+ "value": 598
	276	+ },
	277	+ "ptoState": {
	278	+ "gpsDate": null,
	279	+ "value": null
	280	+ },
	281	+ "vehicleMotionDetect": {
	282	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	283	+ "value": 0
	284	+ },
	285	+ "acceleratorPedalPosition": {
	286	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	287	+ "value": 0
	288	+ },
	289	+ "totalEngineHours": {
	290	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	291	+ "value": 2674
	292	+ },
	293	+ "overspeed": {
	294	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	295	+ "value": 0
	296	+ },
	297	+ "axleWeight": {
	298	+ "gpsDate": "2025-11-07T11:45:33+01:00",
	299	+ "value": 14680
	300	+ },
	301	+ "serviceDistanceKm": {
	302	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	303	+ "value": 136490
	304	+ },
	305	+ "directionIndicator": {
	306	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	307	+ "value": 1
	308	+ },
	309	+ "fuelLevel2": {
	310	+ "gpsDate": null,
	311	+ "value": null
	312	+ },
	313	+ "enginePercentTorque": {
	314	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	315	+ "value": 11
	316	+ }
	317	+ }
	318	+]}
	319	+{{/code}}
	320	+
	321	+= Beispielaufrufe =
	322	+
	323	+**Abfrage Zeitraum für eine Gruppe**
	324	+{{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}}
	325	+
	326	+**Abfrage fester Zeitpunkt für ein Fahrzeug**
	327	+{{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}}
	328	+
	329	+**Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
	330	+{{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}}