Wiki-Quellcode von positions/get_pos_data.php

Version 4.1 von Dominic Lippmann am 2025/03/05 13:47

version	line-number	content
1.1	1	(% class="box" %)
4.1	2	(((
	3	Inhaltsverzeichnis
	4	)))
	5
1.1	6	{{toc/}}
	7
	8	Gibt die Positionsdaten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
	9	Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.
4.1	10
1.1	11	= Beschreibung =
4.1	12
	13	(% class="green mark" %)GET(%%) positions/get_pos_data.php?company=//COMPANY_RTIKEY//&vehicle=//VEHICLE_RTIKEY//&start=//YYYY-MM-DDTHH:MM:SS+HH:mm&end//=//YYYY-MM-DDTHH:MM:SS+HH:mm//
	14
1.1	15	= Parameter =
4.1	16
1.1	17	\|=Parameter\|=Beschreibung\|=Typ\|=Hinweis\|=Pflicht
4.1	18	\|company\|RTI Firmenschlüssel\|string\| \|ja
3.1	19	\|vehicle\|RTI Fahrzeugschlüssel\|string\|entweder vehicle oder group Parameter\| (ja)
	20	\|group\|RTI Gruppenschlüssel\|string\|entweder vehicle oder group Parameter\| (ja)
	21	\|start\|Anfang des Abfragezeitraum\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|nein
	22	\|end\|Ende des Abfragezeitraum\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|nein
	23	\|query_date\|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll\|datestring\|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)\|nein
1.1	24	\|format\|Rückgabeformat\|string\|json (Standard)\|nein
	25	\|date_type\|Welches Datum bildet die Grundlage für die Zeitraumseingrenzung\|string\|'insert' (Standard) = Verarbeitungsdatum
	26	'gps' = Datum an dem die Positionsmeldung stattgefunden hat\|nein
4.1	27	\|additional_data\|Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten\|string[]\|(((
1.1	28	* 'temp' holt die Temperaturwerte der Digitalen Sensoren 1-8 und Analogen Sensoren 1-4
	29	* 'trailer' holt die Trailerinformationen
	30	)))\|nein
4.1	31	\|hide_display\|Blendet Meldungen vom Display aus\|int\|(((
1.1	32	* 0 (Standard) = Displaymeldungen werden mit ausgegeben
	33	* 1 = Displaymeldungen werden nicht mit ausgegeben
	34	)))\|nein
4.1	35	\|offset\|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.\|int\| \|nein
1.1	36
4.1	37	(% class="box info" %)
1.1	38	(((
	39	Hinweis zur Datumseingrenzung
	40	Sie können 3 verschiedene Modi nutzen:
	41	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)
	42	b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
	43	c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug
	44	)))
	45
	46	= Rückgabe =
4.1	47
1.1	48	Es wird ein string zurückgegeben. Im Fehlerfall wird "(% class="error" %)ERROR:Beschreibung(%%)" zurückgegeben.
	49
	50	== Feldbeschreibung ==
4.1	51
1.1	52	\|=Feld\|=Beschreibung
	53	\|vehicle_sign\|Kennzeichen
	54	\|rti_ident\|RTI Ident
	55	\|insert_date\|Wann wurde diese Meldung von YellowFox verarbeitet?
	56	\|gps_date\|Wann wurde diese Meldung von dem Fahrzeug gesendet?
	57	\|lat\|Latitude
	58	\|lon\|Logitude
	59	\|text_position\|Textaddresse der GPS Position
	60	\|customer\|Kundenname (sofern die Adresse zu einem Kunden gehört)
	61	\|direction\|Richtung in Grad
	62	\|satellites\|Anzahl der Satelliten zur Positionsbestimmung
	63	\|speed\|Geschwindigkeit in km/h
	64	\|ignition\|Ist die Zündung an (1) oder aus (0) ?
	65	\|reason\|Warum wurde diese Positionsmeldung generiert?
	66	\|km\|Kilometerstand
	67	\|bszX\|Wert des Betriebsstundenzählers
	68	\|driver_X\|Name des Fahrers
	69	\|driverkey_X\|Personalschlüssel des Fahrers
	70	\|eta_time\|Wenn zu einem Ziel navigiert wird: Planmäßige Ankunft
	71	\|eta_distance\|Wenn zu einem Ziel navigiert wird: verbleibende Distanz
	72	\|eta_duration\|Wenn zu einem Ziel navigiert wird: verbleibende Dauer
	73	\|eta_lat\|Wenn zu einem Ziel navigiert wird: Latitude der Zielposition
	74	\|eta_lon\|Wenn zu einem Ziel navigiert wird: Longitude der Zielposition
	75	\|eta_desc\|Wenn zu einem Ziel navigiert wird: Textadresse der Zielposition
	76	\|digital_inputs\|Status der Telemetrieeingänge
	77	nr = Nummer des Eingangs (1 bis 7)
	78	name = Name des Eingangs
	79	state = Status des Eingangs als Text
	80	value = Status des Eingangs (1 = an, 0 = aus)
	81	\|trailer_info\|Optionales Feld. Beinhaltet Informationen zum Kopplungszustand mit einem Trailer
	82	date = Datum des Status
	83	type = verbunden mit Trailer (TRAILER) oder Zugmaschine (VEHICLE)
	84	name = Name des verbunden Trailers/Zugmaschine
	85	rti_ident = RTI Ident des Trailers
	86	state = Verbindungsstatus (CONNECTED oder DISCONNECTED)
	87	\|digital_temperature_values\|Optionales Feld. Beinhaltet digitale Temperaturdaten.
	88	nr = Nummer des Eingangs
	89	value = Temperatur in °C
	90	set_point = Angestrebter Wert in °C
	91	\|analogue_temperature_values\|Optionales Feld. Beinhaltet analoge Temperaturdaten.
	92	nr = Nummer des Eingangs
	93	value = Temperatur in °C
	94
	95	== JSON ==
4.1	96
1.1	97	Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
	98
4.1	99	{{code language="java"}}
	100	{
	101	"_date" => null,
1.1	102	"_links" => {
	103	"next" => {
	104	"href" => null
	105	}
	106	},
	107	"has_more" => false,
4.1	108	"items": [
1.1	109	{
	110	"vehicle_sign": "FTL YF 123",
	111	"rti_ident": "",
	112	"insert_date": "2022-09-22T13:23:35+02:00",
	113	"gps_date": "2022-09-22T13:23:23+02:00",
	114	"lat": 48.20398,
	115	"lon": 16.22613,
	116	"text_position": "A-1140 Wien (Penzing) Wientalstraße (B1)",
	117	"customer": null,
	118	"direction": 155,
	119	"satellites": 12,
	120	"speed": 0,
	121	"ignition": 0,
	122	"reason": "AnalogMinuteInterval",
	123	"km": 361549,
	124	"bsz1": null,
	125	"bsz2": null,
	126	"driver_1": null,
	127	"driverkey_1": null,
	128	"driver_2": null,
	129	"driverkey_2": null,
	130	"eta_time": null,
	131	"eta_distance": null,
	132	"eta_duration": null,
	133	"eta_lat": null,
	134	"eta_lon": null,
	135	"eta_desc": null,
	136	"digital_inputs": [
	137	{
	138	"nr": 2,
	139	"name": "Sensor 2",
	140	"state": "",
	141	"value": 0
	142	}
	143	],
4.1	144	"trailer_info": {
1.1	145	"date": "2022-09-22T13:18:35+02:00",
	146	"type": "TRAILER",
	147	"name": "Trailer 123",
4.1	148	"rti_ident": "TR_ID",
1.1	149	"state":"CONNECTED"
	150	},
	151	"digital_temperature_values": [
4.1	152	{
1.1	153	"nr": 1,
	154	"value": 13.2,
4.1	155	"set_point": 13.3
1.1	156	}
4.1	157	],
1.1	158	"analogue_temperature_values": [
	159	{
	160	"nr": 1,
	161	"value": 21.56
	162	},
	163	{
	164	"nr": 2,
	165	"value": 11.83
	166	}
	167	]
	168	}
4.1	169	]
	170	}
	171	{{/code}}
1.1	172
	173	= Beispielaufrufe =
4.1	174
1.1	175	Abfrage Zeitraum für eine Gruppe
3.1	176	{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_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&additional_data[]=temp{{/code}}
1.1	177
	178	Abfrage fester Zeitpunkt für ein Fahrzeug
3.1	179	{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&query_date=2022-09-22T13:23:00%2B00:00:00{{/code}}
1.1	180
	181	Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident
3.1	182	{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}