Ä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,158 @@
	1	+Inhaltsverzeichnis
	2	+
	3	+{{toc/}}
	4	+
	5	+Gibt die Positionsdaten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
	6	+Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.
	7	+
	8	+= Beschreibung =
	9	+
	10	+**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	+
	56	+== JSON ==
	57	+
	58	+Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
	59	+
	60	+{{code language="json"}}
	61	+{
	62	+ "_date": {
	63	+ "query_date": "2025-11-07T13:07:23+01:00"
	64	+ },
	65	+ "_links": {
	66	+ "next": {
	67	+ "href": null
	68	+ }
	69	+ },
	70	+ "has_more": false,
	71	+ "items": [
	72	+ {
	73	+ "unit": {
	74	+ "licensePlate": "FTL YF 123",
	75	+ "rtiIdent": null
	76	+ },
	77	+ "engineCoolantTemp": {
	78	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	79	+ "value": 79
	80	+ },
	81	+ "totalFuelUsed": {
	82	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	83	+ "value": 44105
	84	+ },
	85	+ "tachoUnitSpeed": {
	86	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	87	+ "value": 0
	88	+ },
	89	+ "cruiseControlActive": {
	90	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	91	+ "value": 0
	92	+ },
	93	+ "vehicleDistance": {
	94	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	95	+ "value": 158169
	96	+ },
	97	+ "fuelLevel1": {
	98	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	99	+ "value": 46
	100	+ },
	101	+ "engineSpeed": {
	102	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	103	+ "value": 598
	104	+ },
	105	+ "ptoState": {
	106	+ "gpsDate": null,
	107	+ "value": null
	108	+ },
	109	+ "vehicleMotionDetect": {
	110	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	111	+ "value": 0
	112	+ },
	113	+ "acceleratorPedalPosition": {
	114	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	115	+ "value": 0
	116	+ },
	117	+ "totalEngineHours": {
	118	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	119	+ "value": 2674
	120	+ },
	121	+ "overspeed": {
	122	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	123	+ "value": 0
	124	+ },
	125	+ "axleWeight": {
	126	+ "gpsDate": "2025-11-07T11:45:33+01:00",
	127	+ "value": 14680
	128	+ },
	129	+ "serviceDistanceKm": {
	130	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	131	+ "value": 136490
	132	+ },
	133	+ "directionIndicator": {
	134	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	135	+ "value": 1
	136	+ },
	137	+ "fuelLevel2": {
	138	+ "gpsDate": null,
	139	+ "value": null
	140	+ },
	141	+ "enginePercentTorque": {
	142	+ "gpsDate": "2025-11-07T11:55:40+01:00",
	143	+ "value": 11
	144	+ }
	145	+ }
	146	+]}
	147	+{{/code}}
	148	+
	149	+= Beispielaufrufe =
	150	+
	151	+**Abfrage Zeitraum für eine Gruppe**
	152	+{{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}}
	153	+
	154	+**Abfrage fester Zeitpunkt für ein Fahrzeug**
	155	+{{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}}
	156	+
	157	+**Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
	158	+{{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}}