Wiki source code of get_custom_form_data.php

Last modified by YellowFox_RD on 2025/01/23 09:59
Show last authors
1 (% class="box" %)
2 (((
3 Table of Contents
4 )))
5
6 {{toc/}}
7
8 Shows all form data received by selected vehicles during a defined date range.
9
10 = Description =
11
12 (% class="green mark" %)//**GET**//(%%)//** get_custom_form_data.php?company**=COMPANY_RTIKEY**&import**=IMPORT_RTIKEY**&form**=FORM_NAME**&start**=YYYYMMDDHHMMSS**&end**=YYYYMMDDHHMMSS//
13
14 = Parameters =
15
16 |=Parameter|=Description|=Type|=Note|=Mandatory
17 |company|RTI company key|string| |yes
18 |vehicle|RTI vehicle key|string|One of vehicle, group or import must be defined!|yes
19 |group|RTI group key|string|One of vehicle, group or import must be defined!|yes
20 |import|RTI import key (all vehicles)|string|One of vehicle, group or import must be defined!|yes
21 |start|Datum ab dem alle Formulardaten zurückgegeben werden|string|Format: YYYYMMDDHHMMSS|yes
22 |end|Datum bis zu dem alle Formulardaten zurückgegeben werden|string|Format: YYYYMMDDHHMMSS|yes
23 |form|the form name|string|Possible to define form or custorder as parameter. Returns all if not given.|no
24 |custorder|User defined order number|string|Possible to define form or custorder as parameter. Returns all if not given.|no
25 |output|Selection of output format|string|The output format. Possible values:(((
26 * csv
27 * json
28 * json_v2
29 )))If nothing is set, the data will be returned as csv. The formats csv and json can only return up to 10 fields per form. The format json_v2 should therefore be favoured.|no
30 |show_spec|Returns the form definition ( nothing -> no, 1 -> yes )|integer|A optional parameter, you can request the definition of the form. If you set the paramter with 1, you get the definition and if you send the request without the parameter it's not in the result.|no
31 |date_query|(create, insert, complete)|string|Optional. Create is default.|no
32 |complete_buffer|how long should a incomplete form be ignored|integer|value in minutes. Has only affect if date_query = complete|no
33
34 = Return =
35
36 A **string** is returned. On error "(% class="error" %)**ERROR:Description**(%%)" is returned.
37
38 == CSV format ==
39
40 If the request is valid, the data are returned as CSV (Comma Separated Value) format. The first response line is always
41 the header, defining the column names. After it the personal data follows.
42
43 === Meta informations ===
44
45 |=Separator|Semicolon ( ; )
46 |=Delimiter|Double quote ( " )
47 |=Line break|0x0D 0x0A (CarriageReturn LineFeed)
48 |=Header|Line 1
49 |=Encoding|UTF-8
50
51 === Columns ===
52
53 |=Column|=Description
54 |DATE|Date with format (YYYY-MM-DD HH:MM:SS)
55 |VEHICLE|Vehicle sign
56 |DRIVER|Driver name (if avialable)
57 |LAT|Latitude coordinate
58 |LON|Longitude coordinate
59 |SAT|Satellite count
60 |IGNITION|Ignition ON(1) or OFF(0)
61 |ENTRY1|Input field 1 value.
62 |ENTRY2|Input field 2 value.
63 |ENTRY3|Input field 3 value.
64 |ENTRY4|Input field 4 value.
65 |ENTRY5|Input field 5 value.
66 |ENTRY6|Input field 6 value.
67 |ENTRY7|Input field 7 value.
68 |ENTRY8|Input field 8 value.
69 |ENTRY9|Input field 9 value.
70 |ENTRY10|Input field 10 value.
71 |KM|Current mileage in kilometers of the vehicle at time of completing form
72 |ORDER|user defined order number, if form is assigned to an order
73 |FORM|The form name/ if "show_desc" is part of request, the form definition in the result is in the "FORM" column
74 |VEHICLE_COST_CENTER|cost center of the vehicle
75 |DRIVER_MA_NUMBER|Employee number of the driver (only filled with activated ReinerSCT support)
76 |RTI_IDENT|RTI ident of the vehicle
77 |TOURDATA|user defined number of tour/destination/shipment, if form is attached to a tour
78 Format as JSON like
79 "tourData": {"tour":"T1","dest":"T2","ship":"T3"}
80 Is null if not attached to tour.
81 |PARENT_ID|If this is a nested form, this contains a hash to find the associated child forms.
82 |PARENT_RELATION|If this is part of a nestes form, this contains the hash of the assiciated parent form.
83 |CUSTOM_ID|Unique identifier of this form data. Might be NULL for older data sets.
84
85 === Example ===
86
87 **CSV-Rückgabe-Format - ohne Parameter "show_desc":**
88 \\{{code language="java"}}"DATE";"VEHICLE";"DRIVER";"LAT";"LON";"SAT";"IGNITION";"ENTRY1";"ENTRY2";"ENTRY3";"ENTRY4";"ENTRY5";"ENTRY6";"ENTRY7";"ENTRY8";"ENTRY9";"ENTRY10";"KM";"ORDER";"FORM";"VEHICLE_COST_CENTER";"DRIVER_MA_NUMBER";"RTI_IDENT";"TOURDATA";"PARENT_ID";"PARENT_RELATION";"CUSTOM_ID"
89 "2013-03-28 09:29:17";"DD-AB 123";"Herr Fuchs";"51.036687";"13.599141";"9";"0";"111";"22.12.89";"11:33";"Eintrag5";"TEXT10";"TEXT30";"777.77";"1";"";"";"123456";"AUFTRAG1";"UNTERSCHRIFT";"Kostenstelle XYZ";"MA123456";"IDENT1";null;"22201eb2fd123df28156bc0c86e0aba2";"" ;"5"{{/code}}
90
91 **CSV-Rückgabe-Format - mit Parameter "show_desc":**
92 \\{{code language="java"}}"DATE";"VEHICLE";"DRIVER";"LAT";"LON";"SAT";"IGNITION";"ENTRY1";"ENTRY2";"ENTRY3";"ENTRY4";"ENTRY5";"ENTRY6";"ENTRY7";"ENTRY8";"ENTRY9";"ENTRY10";"KM";"ORDER";"FORM";"VEHICLE_COST_CENTER";"DRIVER_MA_NUMBER";"RTI_IDENT";"TOURDATA";"PARENT_ID";"PARENT_RELATION";"CUSTOM_ID"
93 "2013-03-28 09:29:17";"DD-AB 123";"Herr Fuchs";"51.036687";"13.599141";"9";"0";"111";"22.12.89";"11:33";"Eintrag5";"TEXT10";"TEXT30";"777.77";"1";"";"";"123456";"AUFTRAG1";
94 "{""name"":""UNTERSCHRIFT"",""driver"":false,""entries"":[{""i"":1,""name"":""Ganzzahl"",""type"":""int"",""mand"":true},{""i"":2,""name"":""Datum"",""type"":""date"",""mand"":true},{""i"":3,""name"":""Zeit"",""type"":""time"",""mand"":true},{""i"":4,""name"":""Auswahlbox"",""type"":""sel"",""mand"":false,""spec"":""Eintrag1|Eintrag2|Eintrag8|Eintrag5""},{""i"":5,""name"":""Text"",""type"":""t10"",""mand"":false},{""i"":6,""name"":""Text"",""type"":""t30"",""mand"":false},{""i"":7,""name"":""Flie\u00dfkommazahl"",""type"":""flt"",""mand"":false},{""i"":8,""name"":""Frage"",""type"":""bool"",""mand"":true},{""i"":9,""name"":""Unterschrift"",""type"":""sig"",""mand"":false}]}";"Kostenstelle XYZ";"MA123456";"IDENT1";null;"22201eb2fd123df28156bc0c86e0aba2";"";"6" {{/code}}
95
96 = JSON Format =
97
98 == Example ==
99
100 **JSON-Rückgabe-Format - ohne Parameter "show_desc":**
101 \\{{code language="java"}}[{
102 "date":"2013-03-28 09:29:17",
103 "customId": "7",
104 "vehicle":"DD-AB 123",
105 "driver":"Herr Fuchs",
106 "lat":51.036687,
107 "lon":13.599141,
108 "sat":9,
109 "ignition":0,
110 "entry1":"111",
111 "entry2":"22.12.89",
112 "entry3":"11:33",
113 "entry4":"Eintrag5",
114 "entry5":"TEXT10",
115 "entry6":"TEXT30",
116 "entry7":"777.77",
117 "entry8":"1",
118 "entry9":"",
119 "entry10":"",
120 "km":"123456",
121 "order":"AUFTRAG1",
122 "tourData": null,
123 "form":"UNTERSCHRIFT",
124 "vehicleCostCenter":"Kostenstelle XYZ",
125 "driverMaNumber":"MA123456",
126 "rtiIdent":"Ident1",
127 "childForms":[
128 {
129 "date":"2013-03-28 08:29:17",
130 "vehicle":"DD-AB 123",
131 "driver":"Herr Fuchs",
132 "lat":51.036687,
133 "lon":13.599141,
134 "sat":9,
135 "ignition":0,
136 "entry1":"Text",
137 "entry2":"22.12.99",
138 "entry3":"11:33",
139 "km":"123456",
140 "order":"",
141 "tourData": null,
142 "form":"Unterformular",
143 "vehicleCostCenter":"Kostenstelle XYZ",
144 "driverMaNumber":"MA123456",
145 "rtiIdent":"Ident1"
146 }
147 ]
148 }] {{/code}}
149
150 **JSON-Rückgabe-Format - mit Parameter "show_desc":**
151 \\{{code language="java"}}[{
152 "date":"2013-03-28 09:29:17",
153 "customId": "8",
154 "vehicle":"DD-AB 123",
155 "driver":"Herr Fuchs",
156 "lat":51.036687,
157 "lon":13.599141,
158 "sat":9,
159 "ignition":0,
160 "entry1":"111",
161 "entry2":"22.12.89",
162 "entry3":"11:33",
163 "entry4":"Eintrag5",
164 "entry5":"TEXT10",
165 "entry6":"TEXT30",
166 "entry7":"777.77",
167 "entry8":"1",
168 "entry9":"",
169 "entry10":"",
170 "km":"123456",
171 "order":"AUFTRAG1",
172 "tourData": null,
173 "form":{
174 "name": "UNTERSCHRIFT",
175 "driver": false,
176 "entries": [
177 {
178 "i": 1,
179 "name": "Ganzzahl",
180 "type": "int",
181 "mand": true
182 },
183 {
184 "i": 2,
185 "name": "Datum",
186 "type": "date",
187 "mand": true
188 },
189 {
190 "i": 3,
191 "name": "Zeit",
192 "type": "time",
193 "mand": true
194 },
195 {
196 "i": 4,
197 "name": "Auswahlbox",
198 "type": "sel",
199 "mand": false,
200 "spec": "Eintrag1|Eintrag2|Eintrag8|Eintrag5"
201 },
202 {
203 "i": 5,
204 "name": "Text",
205 "type": "t10",
206 "mand": false
207 },
208 {
209 "i": 6,
210 "name": "Text",
211 "type": "t30",
212 "mand": false
213 },
214 {
215 "i": 7,
216 "name": "Fließkommazahl",
217 "type": "flt",
218 "mand": false
219 },
220 {
221 "i": 8,
222 "name": "Frage",
223 "type": "bool",
224 "mand": true
225 },
226 {
227 "i": 9,
228 "name": "Unterschrift",
229 "type": "sig",
230 "mand": false
231 }
232 ]
233 },
234 "vehicleCostCenter":"Kostenstelle XYZ",
235 "driverMaNumber":"MA123456",
236 "rtiIdent":"Ident1",
237 "childForms":[
238 {
239 "date":"2013-03-28 08:29:17",
240 "customId": "7",
241 "vehicle":"DD-AB 123",
242 "driver":"Herr Fuchs",
243 "lat":51.036687,
244 "lon":13.599141,
245 "sat":9,
246 "ignition":0,
247 "entry1":"Text",
248 "entry2":"22.12.99",
249 "entry3":"11:33",
250 "km":"123456",
251 "order":"",
252 "tourData": null,
253 "form":{
254 "name": "Unterformular",
255 "driver": false,
256 "entries": [
257 {
258 "i": 1,
259 "name": "Textfeld",
260 "type": "t30",
261 "mand": true
262 },
263 {
264 "i": 2,
265 "name": "Datum",
266 "type": "date",
267 "mand": true
268 },
269 {
270 "i": 3,
271 "name": "Zeit",
272 "type": "time",
273 "mand": true
274 }
275 ]
276 },
277 "vehicleCostCenter":"Kostenstelle XYZ",
278 "driverMaNumber":"MA123456",
279 "rtiIdent":"Ident1"
280 }
281 ]
282 }]{{/code}}
283
284 = JSON_V2 Format =
285
286 The parameters "form" and "custorder" are ignored if the output type "json_v2" is used.
287
288 == Beispiel ==
289
290 **JSON-Rückgabe-Format - mit Parameter "show_desc":**
291 \\{{code language="java"}}[{
292 "date":"2019-11-26T10:51:39+01:00",
293 "customId": "9",
294 "vehicle":"DD-AB 123",
295 "driver":"Herr Fuchs",
296 "driverMaNumber":null,
297 "lat":51.036687,
298 "lon":13.599141,
299 "textPos": "D-01723 Wilsdruff (Kesselsdorf), Am Wüsteberg 3",
300 "sat":9,
301 "ignition":0,
302 "km":123456,
303 "order":null,
304 "orderMeta":null,
305 "tourData": null,
306 "vehicleCostCenter":null,
307 "rtiIdent":null,
308 "formName":"Beispielformular",
309 "formDriverMandatory":true,
310 "insertDate": "2020-07-22T16:08:00+02:00",
311 "completeDate": "2020-07-22T16:08:00+02:00",
312 "fields":
313 [{
314 "id":1,
315 "name":"Fließkommazahl",
316 "isMandatory":true,
317 "type":"flt",
318 "value":"111.11",
319 "isIncomplete": false
320 },
321 {
322 "id":2,
323 "name":"Text10",
324 "isMandatory":true,
325 "type":"t10",
326 "value":"Text10",
327 "isIncomplete": false
328 },
329 {
330 "id":3,
331 "name":"Text30",
332 "isMandatory":true,
333 "type":"t30",
334 "value":"Text30",
335 "isIncomplete": false
336 },
337 {
338 "id":4,
339 "name":"Text500",
340 "isMandatory":true,
341 "type":"t500",
342 "value":"Text500",
343 "isIncomplete": false
344 },
345 {
346 "id":5,
347 "name":"Ganzzahl",
348 "isMandatory":false,
349 "type":"int",
350 "value":"555",
351 "isIncomplete": false
352 },
353 {
354 "id":6,
355 "name":"Bild",
356 "isMandatory":false,
357 "type":"img",
358 "value":"48f5g3d04d177d95hs12182c39410a17e",
359 "isIncomplete": false
360 },
361 {
362 "id":7,
363 "name":"Unterschrift",
364 "isMandatory":false,
365 "type":"sig",
366 "value":"f7al12t4d177dfac0d2162f39410a17e",
367 "isIncomplete": false
368 },
369 {
370 "id":8,
371 "name":"Auswahlbox",
372 "isMandatory":false,
373 "type":"sel",
374 "value":"Eintrag 1",
375 "selectionList":
376 [
377 "Eintrag 1",
378 "Eintrag 2",
379 "Eintrag 3",
380 "Eintrag 4",
381 "Eintrag 5",
382 "Eintrag 6"
383 ]
384 },
385 {
386 "id":9,
387 "name":"Frage",
388 "isMandatory":false,
389 "type":"bool",
390 "value":"1",
391 "isIncomplete": false
392 },
393 {
394 "id":10,
395 "name":"Datum",
396 "isMandatory":false,
397 "type":"date",
398 "value":"10.10.2010",
399 "isIncomplete": false
400 },
401 {
402 "id":11,
403 "name":"Zeit",
404 "isMandatory":false,
405 "type":"time",
406 "value":"11:11",
407 "isIncomplete": false
408 },
409 {
410 "id":12,
411 "name":"Formular",
412 "isMandatory":false,
413 "type":"nestedForm",
414 "value":[
415 {
416 "date":"2019-11-26T09:51:39+01:00",
417 "customId": "7",
418 "vehicle":"DD-AB 123",
419 "driver":"Herr Fuchs",
420 "driverMaNumber":null,
421 "lat":51.036687,
422 "lon":13.599141,
423 "textPos": "D-01723 Wilsdruff (Kesselsdorf), Am Wüsteberg 3",
424 "sat":9,
425 "ignition":0,
426 "km":123456,
427 "order":"",
428 "orderMeta":"",
429 "tourData":null,
430 "vehicleCostCenter":null,
431 "rtiIdent":null,
432 "formName":"Unterformular",
433 "formDriverMandatory":false,
434 "fields":[
435 {
436 "id":1,
437 "name":"Textfeld",
438 "isMandatory":false,
439 "type":"t30",
440 "value":"Text",
441 "isIncomplete":false
442 },
443 {
444 "id":2,
445 "name":"Bild",
446 "isMandatory":false,
447 "type":"img",
448 "value":null,
449 "isIncomplete":false
450 },
451 {
452 "id":3,
453 "name":"Unterschrift",
454 "isMandatory":false,
455 "type":"sig",
456 "value":null,
457 "isIncomplete":false
458 }
459 ],
460 "insertDate":"2019-11-26T09:53:39+01:00",
461 "completeDate":"2019-11-26T09:53:39+01:00"
462 }
463 ],
464 "isIncomplete": false
465 } ]}{{/code}}
466
467 = Example calls =
468
469 **For all Vehicles at 2015-08-01 for form "Form Name"**
470 \\{{code language="java"}}https://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=Form+Name&start=20150801000000&end=20150801235959
471
472 https://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&custorder=123456&start=20150801000000&end=20150831235959{{/code}}
473
474 **For a single vehicle at august 2015 and custom order number 123456**
475 \\{{code language="java"}}https://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&custorder=123456&start=20150801000000&end=20150831235959{{/code}}
476