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

Summary

Details

Page properties
Content
... ... @@ -1,26 +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|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
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
24 24  |format|output format|string|json (default)|no
25 25  |date_type|Which date is the base for date restriction?|string|'insert' (default) = execution date
26 26  'gps' = date when the messaged was generated|no
... ... @@ -32,7 +32,7 @@
32 32  * 0 (default) = display messages are being returned
33 33  * 1 = display messages are not being returned
34 34  )))|no
35 -|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
36 36  
37 37  (% class="box" %)
38 38  (((
... ... @@ -44,11 +44,9 @@
44 44  )))
45 45  
46 46  = Output =
47 -
48 48  A **string** is being returned. Will return "(% class="error" %)**ERROR:description**(%%)" on error.
49 49  
50 50  == Field descriptions ==
51 -
52 52  |=Field|=Description
53 53  |vehicle_sign|vehicle sign
54 54  |rti_ident|RTI ident
... ... @@ -73,15 +73,11 @@
73 73  |eta_lat|If navigating to a target: latitude of target
74 74  |eta_lon|If navigating to a target: longitude of target
75 75  |eta_desc|If navigating to a target: text address of target
76 -|digital_inputs|(((
77 -status of telemetry inputs
67 +|digital_inputs|status of telemetry inputs
78 78  nr = number of input (1 to 7)
79 79  name = name of input
80 80  state = status of input as text
81 81  value =  status of input (1 = on, 0 = off)
82 -
83 -ident = technical attribute, can be set via object-specific settings
84 -)))
85 85  |trailer_info|Optional field. Includes information about connected trailer.
86 86  date = date of status
87 87  type = connected to trailer (TRAILER) or towing vehicle (VEHICLE)
... ... @@ -97,12 +97,10 @@
97 97  value = temperature in °C
98 98  
99 99  == JSON ==
100 -
101 101  You can find a JSON schema description for this result set [[here>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
102 102  
103 -{{code language="java"}}
104 -{    
105 - "_date" => null,
89 +{{code language="java"}}{    
90 + "_date" => null,
106 106   "_links" => {
107 107   "next" => {
108 108   "href" => null
... ... @@ -109,7 +109,7 @@
109 109   }
110 110   },
111 111   "has_more" => false,    
112 - "items": [
97 + "items": [
113 113   {
114 114   "vehicle_sign": "FTL YF 123",
115 115   "rti_ident": "",
... ... @@ -142,24 +142,23 @@
142 142   "nr": 2,
143 143   "name": "Sensor 2",
144 144   "state": "",
145 - "value": 0,
146 - "ident": null
130 + "value": 0
147 147   }
148 148   ],
149 - "trailer_info": {
133 + "trailer_info": {
150 150   "date": "2022-09-22T13:18:35+02:00",
151 151   "type": "TRAILER",
152 152   "name": "Trailer 123",
153 - "rti_ident": "TR_ID",
137 + "rti_ident": "TR_ID",
154 154   "state":"CONNECTED"
155 155   },
156 156   "digital_temperature_values": [
157 - {
141 + {
158 158   "nr": 1,
159 159   "value": 13.2,
160 - "set_point": 13.3
144 + "set_point": 13.3
161 161   }
162 - ],
146 + ],
163 163   "analogue_temperature_values": [
164 164   {
165 165   "nr": 1,
... ... @@ -171,17 +171,16 @@
171 171   }
172 172   ]
173 173   }
174 - ]
175 -}
176 -{{/code}}
158 + ]
159 +}{{/code}}
177 177  
178 178  = example calls =
179 -
180 180  **Query date range for a group**
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}}
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}}
182 182  
183 183  **Query fixed date for a vehicle**
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}}
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}}
185 185  
186 186  **Query current point of time for a vehicle with RTI ident**
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}}
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 +