Ä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,341 @@
	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	+==== Statische Werte ====
	55	+
	56	+Diese Felder sind immer enthalten.
	57	+
	58	+
	59	+|=Feld|=Beschreibung
	60	+|unit|Fahrzeug mit Kennzeichen und RTI Ident
	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
	67	+|(((
	68	+acceleratorPedalPosition
	69	+)))|Gaspedalposition in Prozent
	70	+|(((
	71	+adblueLevel
	72	+)))|AdBlue Füllstand in Prozent
	73	+|(((
	74	+ambientAirTemperature
	75	+)))|Außentemperatur in °C
	76	+|(((
	77	+atLeastOnePtoActive
	78	+)))|Ist wenigstens ein Nebenantrieb aktiv?
	79	+|(((
	80	+axleWeight
	81	+)))|Achslast
	82	+|(((
	83	+brakeSwitch
	84	+)))|Bremse betätigt seit der letzten Meldung
	85	+|(((
	86	+clutchSwitch
	87	+)))|Kupplung betätigt seit der letzten Meldung
	88	+|(((
	89	+cruiseControlActive
	90	+)))|Ist der Tempomat an?
	91	+|(((
	92	+directionIndicator
	93	+)))|Richtung des Fahrzeuges
	94	+|(((
	95	+engineCoolantTemp
	96	+)))|Temperatur Motor in °C
	97	+|(((
	98	+enginePercentLoad
	99	+)))|Motordrehmoment in Prozent
	100	+|(((
	101	+enginePercentTorque
	102	+)))|Drehmoment
	103	+|(((
	104	+engineSpeed
	105	+)))|Motorumdrehungen
	106	+|(((
	107	+fuelLevel1
	108	+)))|Tankfüllstand 1 in Prozent
	109	+|(((
	110	+fuelLevel2
	111	+)))|Tankfüllstand 2 in Prozent
	112	+|(((
	113	+fuelLiter
	114	+)))|(((
	115	+Tankinhalt in Litern
	116	+)))
	117	+|(((
	118	+fuelRate
	119	+)))|Kraftstoffverbauch pro Stunde
	120	+|(((
	121	+instantaneousFuelEconomy
	122	+)))|Kraftstoffverbrauch in Kilometern pro Liter
	123	+|(((
	124	+overspeed
	125	+)))|Übergeschwindigkeitswarnung
	126	+|(((
	127	+ptoState
	128	+)))|Status Nebenantrieb
	129	+|(((
	130	+serviceBrakeAirPressure1
	131	+)))|Luftdruck Betriebsbremse 1
	132	+|(((
	133	+serviceBrakeAirPressure2
	134	+)))|Luftdruck Betriebsbremse 2
	135	+|(((
	136	+serviceDistanceKm
	137	+)))|Kilometer bis zum nächsten Service
	138	+|(((
	139	+serviceIntervalDays
	140	+)))|Tage bis zum nächsten Service
	141	+|(((
	142	+serviceIntervalKm
	143	+)))|Kilometerintervall Service
	144	+|(((
	145	+tachoUnitSpeed
	146	+)))|Geschwindigkeit
	147	+|(((
	148	+totalEngineHours
	149	+)))|Gesamtlaufleistung
	150	+|(((
	151	+totalFuelUsed
	152	+)))|Gesamtmenge des verbauchten Treibstoffs in Litern
	153	+|(((
	154	+totalGasUsed
	155	+)))|Gesamtmenge des verbrauchten Gas
	156	+|(((
	157	+vehicleDistance
	158	+)))|Gesamtmenge der zurückgelegten Kilometer
	159	+|(((
	160	+vehicleMotionDetect
	161	+)))|Ist das Fahrzeug in Bewegung?
	162	+
	163	+==== Werte ECT Pumpen ====
	164	+
	165	+|=Feld|=Beschreibung
	166	+|(((
	167	+ectAvgCellTemperature
	168	+)))|Durchschnittliche Zelltemperatur
	169	+|(((
	170	+ectAvgCellVoltage
	171	+)))|Durchschnittliche Zellspannung
	172	+|(((
	173	+ectBatteryManagementAmperage
	174	+)))|Stromaufnahme/-abgabe des BMS
	175	+|(((
	176	+ectErrorCodeCount
	177	+)))|Anzahl der Fehlercodes
	178	+|(((
	179	+ectGeneratorActiveDuration
	180	+)))|Dauer des Active-Status des Generators
	181	+|(((
	182	+ectGeneratorControllerTemperature
	183	+)))|Temperatur des Generator-Controllers
	184	+|(((
	185	+ectGeneratorRuntime
	186	+)))|Laufzeit des Generators
	187	+|(((
	188	+ectGeneratorTemperature
	189	+)))|Temperatur des Generators
	190	+|(((
	191	+ectHighPressurePumpControllerTemperature
	192	+)))|Temperatur des Controllers der Hochdruckpumpe
	193	+|(((
	194	+ectHighPressurePumpDuration
	195	+)))|Dauer des Active-Status der Hochdruckpumpe
	196	+|(((
	197	+ectHighPressurePumpEngineTemperature
	198	+)))|Temperatur des Hochdruckpumpenmotors
	199	+|(((
	200	+ectHighPressurePumpRuntime
	201	+)))|Laufzeit der Hochdruckpumpe
	202	+|(((
	203	+ectHighestCellTemperature
	204	+)))|Höchste Zelltemperatur
	205	+|(((
	206	+ectHighestCellVoltage
	207	+)))|Höchste Zellspannung
	208	+|(((
	209	+ectLastErrorCode
	210	+)))|Letzter Fehlercode
	211	+|(((
	212	+ectLowestCellTemperature
	213	+)))|Niedrigste Zelltemperatur
	214	+|(((
	215	+ectLowestCellVoltage
	216	+)))|Niedrigste Zellspannung
	217	+|(((
	218	+ectPumpSystemReadyDuration
	219	+)))|Dauer des Ready-Status des Pumpensystems
	220	+|(((
	221	+ectStateOfCharge
	222	+)))|Ladezustand des Akkus
	223	+|(((
	224	+ectTotalBatteryVoltage
	225	+)))|Gesamtspannung des Akkus
	226	+|(((
	227	+ectVacuumPumpControllerTemperature
	228	+)))|Temperatur des Controllers der Vakuumpumpe
	229	+|(((
	230	+ectVacuumPumpDuration
	231	+)))|Dauer des Active-Status der Vakuumpumpe
	232	+|(((
	233	+ectVacuumPumpEngineTemperature
	234	+)))|Temperatur des Vakuumpumpenmotors
	235	+|(((
	236	+ectVacuumPumpRuntime
	237	+)))|Laufzeit der Vakuumpumpe
	238	+
	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}}