Änderungen von Dokument positions/get_pos_data.php

Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-XWiki.YellowFox_RD
	1	+XWiki.yf-dominic

Inhalt

...	...	@@ -1,22 +1,16 @@
1	1	(% class="box" %)
2		-(((
3		-Inhaltsverzeichnis
4		-)))
5		-
	2	+(((Inhaltsverzeichnis)))
6	6	{{toc/}}
7	7
8	8	Gibt die Positionsdaten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
9	9	Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.
10		-
11	11	= Beschreibung =
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		-
	8	+**(% 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//
15	15	= Parameter =
16		-
17	17	|=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
18		-|company|RTI Firmenschlüssel|string| |ja
19		-|vehicle|RTI Fahrzeugschlüssel|string| | ja
	11	+|company|RTI Firmenschlüssel|string||ja
	12	+|vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group Parameter| (ja)
	13	+|group|RTI Gruppenschlüssel|string|entweder vehicle oder group Parameter| (ja)
20	20	|start|Anfang des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
21	21	|end|Ende des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
22	22	|query_date|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
...	...	@@ -23,17 +23,17 @@
23	23	|format|Rückgabeformat|string|json (Standard)|nein
24	24	|date_type|Welches Datum bildet die Grundlage für die Zeitraumseingrenzung|string|'insert' (Standard) = Verarbeitungsdatum
25	25	'gps' = Datum an dem die Positionsmeldung stattgefunden hat|nein
26		-|additional_data|Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten|string[]|(((
	20	+|additional_data|Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten|string[]| (((
27	27	* 'temp' holt die Temperaturwerte der Digitalen Sensoren 1-8 und Analogen Sensoren 1-4
28	28	* 'trailer' holt die Trailerinformationen
29	29	)))|nein
30		-|hide_display|Blendet Meldungen vom Display aus|int|(((
	24	+|hide_display|Blendet Meldungen vom Display aus|int| (((
31	31	* 0 (Standard) = Displaymeldungen werden mit ausgegeben
32	32	* 1 = Displaymeldungen werden nicht mit ausgegeben
33	33	)))|nein
34		-|offset|Die Anfrage liefert maximal 1000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int| |nein
	28	+|offset|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int||nein
35	35
36		-(% class="box info" %)
	30	+(% class="box" %)
37	37	(((
38	38	**Hinweis zur Datumseingrenzung**
39	39	Sie können 3 verschiedene Modi nutzen:
...	...	@@ -43,11 +43,9 @@
43	43	)))
44	44
45	45	= Rückgabe =
46		-
47	47	Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
48	48
49	49	== Feldbeschreibung ==
50		-
51	51	|=Feld|=Beschreibung
52	52	|vehicle_sign|Kennzeichen
53	53	|rti_ident|RTI Ident
...	...	@@ -72,15 +72,11 @@
72	72	|eta_lat|Wenn zu einem Ziel navigiert wird: Latitude der Zielposition
73	73	|eta_lon|Wenn zu einem Ziel navigiert wird: Longitude der Zielposition
74	74	|eta_desc|Wenn zu einem Ziel navigiert wird: Textadresse der Zielposition
75		-|digital_inputs|(((
76		-Status der Telemetrieeingänge
	67	+|digital_inputs|Status der Telemetrieeingänge
77	77	nr = Nummer des Eingangs (1 bis 7)
78	78	name = Name des Eingangs
79	79	state = Status des Eingangs als Text
80	80	value =  Status des Eingangs (1 = an, 0 = aus)
81		-
82		-ident = technisches Identifikationsmerkmal, kann in den fahrzeugbezogenen Einstellungen festgelegt werden
83		-)))
84	84	|trailer_info|Optionales Feld. Beinhaltet Informationen zum Kopplungszustand mit einem Trailer
85	85	date = Datum des Status
86	86	type = verbunden mit Trailer (TRAILER) oder Zugmaschine (VEHICLE)
...	...	@@ -96,12 +96,10 @@
96	96	value = Temperatur in °C
97	97
98	98	== JSON ==
99		-
100	100	Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
101	101
102		-{{code language="java"}}
103		-{
104		- "_date" => null,
	89	+{{code language="java"}}{
	90	+ "_date" => null,
105	105	"_links" => {
106	106	"next" => {
107	107	"href" => null
...	...	@@ -108,7 +108,7 @@
108	108	}
109	109	},
110	110	"has_more" => false,
111		- "items": [
	97	+ "items": [
112	112	{
113	113	"vehicle_sign": "FTL YF 123",
114	114	"rti_ident": "",
...	...	@@ -141,24 +141,23 @@
141	141	"nr": 2,
142	142	"name": "Sensor 2",
143	143	"state": "",
144		- "value": 0,
145		- "ident": null
	130	+ "value": 0
146	146	}
147	147	],
148		- "trailer_info": {
	133	+ "trailer_info": {
149	149	"date": "2022-09-22T13:18:35+02:00",
150	150	"type": "TRAILER",
151	151	"name": "Trailer 123",
152		- "rti_ident": "TR_ID",
	137	+ "rti_ident": "TR_ID",
153	153	"state":"CONNECTED"
154	154	},
155	155	"digital_temperature_values": [
156		- {
	141	+ {
157	157	"nr": 1,
158	158	"value": 13.2,
159		- "set_point": 13.3
	144	+ "set_point": 13.3
160	160	}
161		- ],
	146	+ ],
162	162	"analogue_temperature_values": [
163	163	{
164	164	"nr": 1,
...	...	@@ -170,14 +170,15 @@
170	170	}
171	171	]
172	172	}
173		- ]
174		-}
175		-{{/code}}
	158	+ ]
	159	+}{{/code}}
176	176
177	177	= Beispielaufrufe =
	162	+**Abfrage Zeitraum für eine Gruppe**
	163	+{{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}}
178	178
179	179	**Abfrage fester Zeitpunkt für ein Fahrzeug**
180		-{{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}}
	166	+{{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}}
181	181
182	182	**Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
183		-{{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}}
	169	+{{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}}