Last modified by YellowFox_RD on 2025/04/15 10:42
From version 1.1
edited by YellowFox_RD
on 2024/12/19 10:11
Change comment: Imported from XAR
To version 3.1
edited by YellowFox_RD
on 2025/04/15 10:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,19 +1,26 @@
1 1  (% class="box" %)
2 -(((Table of Contents)))
2 +(((
3 +Table of Contents
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Return the position data of a single vehicle or vehicle group.
6 6  If no date is given, it will return the current position.
10 +
7 7  = Description =
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//
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 +
9 9  = Parameter =
16 +
10 10  |=parameter|=description|=type|=hint|=mandatory
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
18 +|company|RTI company key|string| |yes
19 +|vehicle|RTI vehicle key|string|either vehicle or group parameter| (yes)
20 +|group|RTI group key|string|either vehicle or group parameter| (yes)
21 +|start|start of query date range|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
22 +|end|end of query date range|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
23 +|query_date|point of time to get the position for|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|no
17 17  |format|output format|string|json (default)|no
18 18  |date_type|Which date is the base for date restriction?|string|'insert' (default) = execution date
19 19  'gps' = date when the messaged was generated|no
... ... @@ -25,7 +25,7 @@
25 25  * 0 (default) = display messages are being returned
26 26  * 1 = display messages are not being returned
27 27  )))|no
28 -|offset|The request returns 5000 data records at max. Use offset to access the next block.|int||no
35 +|offset|The request returns 5000 data records at max. Use offset to access the next block.|int| |no
29 29  
30 30  (% class="box" %)
31 31  (((
... ... @@ -37,9 +37,11 @@
37 37  )))
38 38  
39 39  = Output =
47 +
40 40  A **string** is being returned. Will return "(% class="error" %)**ERROR:description**(%%)" on error.
41 41  
42 42  == Field descriptions ==
51 +
43 43  |=Field|=Description
44 44  |vehicle_sign|vehicle sign
45 45  |rti_ident|RTI ident
... ... @@ -64,11 +64,15 @@
64 64  |eta_lat|If navigating to a target: latitude of target
65 65  |eta_lon|If navigating to a target: longitude of target
66 66  |eta_desc|If navigating to a target: text address of target
67 -|digital_inputs|status of telemetry inputs
76 +|digital_inputs|(((
77 +status of telemetry inputs
68 68  nr = number of input (1 to 7)
69 69  name = name of input
70 70  state = status of input as text
71 71  value =  status of input (1 = on, 0 = off)
82 +
83 +ident = technical attribute, can be set via object-specific settings
84 +)))
72 72  |trailer_info|Optional field. Includes information about connected trailer.
73 73  date = date of status
74 74  type = connected to trailer (TRAILER) or towing vehicle (VEHICLE)
... ... @@ -84,10 +84,12 @@
84 84  value = temperature in °C
85 85  
86 86  == JSON ==
100 +
87 87  You can find a JSON schema description for this result set [[here>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
88 88  
89 -{{code language="java"}}{    
90 - "_date" => null,
103 +{{code language="java"}}
104 +{    
105 + "_date" => null,
91 91   "_links" => {
92 92   "next" => {
93 93   "href" => null
... ... @@ -94,7 +94,7 @@
94 94   }
95 95   },
96 96   "has_more" => false,    
97 - "items": [
112 + "items": [
98 98   {
99 99   "vehicle_sign": "FTL YF 123",
100 100   "rti_ident": "",
... ... @@ -127,23 +127,24 @@
127 127   "nr": 2,
128 128   "name": "Sensor 2",
129 129   "state": "",
130 - "value": 0
145 + "value": 0,
146 + "ident": null
131 131   }
132 132   ],
133 - "trailer_info": {
149 + "trailer_info": {
134 134   "date": "2022-09-22T13:18:35+02:00",
135 135   "type": "TRAILER",
136 136   "name": "Trailer 123",
137 - "rti_ident": "TR_ID",
153 + "rti_ident": "TR_ID",
138 138   "state":"CONNECTED"
139 139   },
140 140   "digital_temperature_values": [
141 - {
157 + {
142 142   "nr": 1,
143 143   "value": 13.2,
144 - "set_point": 13.3
160 + "set_point": 13.3
145 145   }
146 - ],
162 + ],
147 147   "analogue_temperature_values": [
148 148   {
149 149   "nr": 1,
... ... @@ -155,16 +155,17 @@
155 155   }
156 156   ]
157 157   }
158 - ]
159 -}{{/code}}
174 + ]
175 +}
176 +{{/code}}
160 160  
161 161  = example calls =
179 +
162 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}}
181 +{{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}}
164 164  
165 165  **Query fixed date for a vehicle**
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}}
184 +{{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}}
167 167  
168 168  **Query current point of time for a vehicle with RTI ident**
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}}
170 -
187 +{{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}}