Changes for page positions/get_pos_data.php

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,25 +1,19 @@
1	1	(% class="box" %)
2		-(((
3		-Table of Contents
4		-)))
5		-
	2	+(((Table of Contents)))
6	6	{{toc/}}
7	7
8	8	Return the position data of a single vehicle or vehicle group.
9	9	If no date is given, it will return the current position.
10		-
11	11	= Description =
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|=description|=type|=hint|=mandatory
18		-|company|RTI company key|string| |yes
19		-|vehicle|RTI vehicle key|string| |yes
20		-|start|start of query date range|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
21		-|end|end of query date range|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
22		-|query_date|point of time to get the position for|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
	11	+|company|RTI company key|string||yes
	12	+|vehicle|RTI vehicle key|string|either vehicle or group parameter|(yes)
	13	+|group|RTI group key|string|either vehicle or group parameter|(yes)
	14	+|start|start of query date range|datestring|Format: ISO 8601|no
	15	+|end|end of query date range|datestring|Format: ISO 8601|no
	16	+|query_date|point of time to get the position for|datestring|Format: ISO 8601|no
23	23	|format|output format|string|json (default)|no
24	24	|date_type|Which date is the base for date restriction?|string|'insert' (default) = execution date
25	25	'gps' = date when the messaged was generated|no
...	...	@@ -31,7 +31,7 @@
31	31	* 0 (default) = display messages are being returned
32	32	* 1 = display messages are not being returned
33	33	)))|no
34		-|offset|The request returns 5000 data records at max. Use offset to access the next block.|int| |no
	28	+|offset|The request returns 5000 data records at max. Use offset to access the next block.|int||no
35	35
36	36	(% class="box" %)
37	37	(((
...	...	@@ -43,11 +43,9 @@
43	43	)))
44	44
45	45	= Output =
46		-
47	47	A **string** is being returned. Will return "(% class="error" %)**ERROR:description**(%%)" on error.
48	48
49	49	== Field descriptions ==
50		-
51	51	|=Field|=Description
52	52	|vehicle_sign|vehicle sign
53	53	|rti_ident|RTI ident
...	...	@@ -72,15 +72,11 @@
72	72	|eta_lat|If navigating to a target: latitude of target
73	73	|eta_lon|If navigating to a target: longitude of target
74	74	|eta_desc|If navigating to a target: text address of target
75		-|digital_inputs|(((
76		-status of telemetry inputs
	67	+|digital_inputs|status of telemetry inputs
77	77	nr = number of input (1 to 7)
78	78	name = name of input
79	79	state = status of input as text
80	80	value =  status of input (1 = on, 0 = off)
81		-
82		-ident = technical attribute, can be set via object-specific settings
83		-)))
84	84	|trailer_info|Optional field. Includes information about connected trailer.
85	85	date = date of status
86	86	type = connected to trailer (TRAILER) or towing vehicle (VEHICLE)
...	...	@@ -96,12 +96,10 @@
96	96	value = temperature in °C
97	97
98	98	== JSON ==
99		-
100	100	You can find a JSON schema description for this result set [[here>>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,11 +170,12 @@
170	170	}
171	171	]
172	172	}
173		- ]
174		-}
175		-{{/code}}
	158	+ ]
	159	+}{{/code}}
176	176
177	177	= example calls =
	162	+**Query date range for a group**
	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	**Query fixed date for a vehicle**
180	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}}
...	...	@@ -181,3 +181,4 @@
181	181
182	182	**Query current point of time for a vehicle with RTI ident**
183	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}}
	170	+