Wiki-Quellcode von get_custom_form_data.php

Zuletzt geändert von YellowFox_RD am 2025/01/23 10:04
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((
3 Inhaltsverzeichnis
4 )))
5
6 {{toc/}}
7
8 Zeigt alle Formulardaten die bei den gewählten Fahrzeugen, in dem gewählten Zeitraum empfangen wurden.
9
10 = Beschreibung =
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 = Parameter =
15
16 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
17 |company|RTI Firmenschlüssel|string| |ja
18 |vehicle|RTI Fahrzeugschlüssel|string|Es muss immer einer der Parameter vehicle, group oder import angegeben werden!|ja
19 |group|RTI Gruppenschlüssel|string|Es muss immer einer der Parameter vehicle, group oder import angegeben werden!|ja
20 |import|RTI Importschlüssel (alle Fahrzeuge)|string|Es muss immer einer der Parameter vehicle, group oder import angegeben werden!|ja
21 |start|Datum ab dem alle Formulardaten zurückgegeben werden|string|Format: YYYYMMDDHHMMSS|ja
22 |end|Datum bis zu dem alle Formulardaten zurückgegeben werden|string|Format: YYYYMMDDHHMMSS|ja
23 |form|Formularname|string|Es kann einer der Parameter form oder custorder angegeben werden|nein
24 |custorder|Selbstdefinierte Auftragsnummer, zur Abfrage der Daten von einem Auftrag|string|Es kann einer der Parameter form oder custorder angegeben werden|nein
25 |output|Auswahl des Ausgabeformates|string|Es kann das Ausgabeformat gewählt werden. Mögliche Werte:(((
26 * csv
27 * json
28 * json_v2
29 )))Wenn kein Format gesetzt wird, werden die Daten standardmäßig als CSV ausgegeben. Die Formate CSV und JSON können nur bis zu 10 Felder pro Formular ausgeben. Das Format JSON V2 ist daher zu bevorzugen.|nein
30 |show_desc|Gib den Aufbau des Formulartyps zurück ( nichts -> nein, 1 -> ja )|integer|Ein optionaler Parameter, mit dem übergeben werden kann, ob die Formulardefinition mit übergeben werden soll.|nein
31 |date_query|Nach welchem Datumstyp soll eingegrenzt werden (create, insert, complete)|string|Optional. create ist der Standard|nein
32 |complete_buffer|Wie lange sollen nicht vollständige Formualre zurückgehalten werden|integer|Optional. Wert in Minuten. Hat nur Einfluss, wenn date_query = complete. Standard ist 0. Wird dauerhaft zurückgehalten.|nein
33
34 = Rückgabe =
35
36 Es wird eine** string **zurück gegeben. Ansonsten wird bei einem Fehler ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
37
38 == CSV Format ==
39
40 === Metainformationen ===
41
42 |=Trennzeichen|Semikolon ( ; )
43 |=Textbegrenzer|Doppeltes Hochkomma ( " )
44 |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
45 |=Header|Zeile 1
46 |=Kodierung|UTF-8
47
48 === Spalten ===
49
50 |=Spalte|=Beschreibung
51 |DATE|Datum im Format (YYYY-MM-DD HH:MM:SS)
52 |VEHICLE|Fahrzeugkennzeichen
53 |DRIVER|Fahrername (falls einer angemeldet war)
54 |LAT|Latitude Koordinate(geographische Breite)
55 |LON|Longitude Koordinate (geographische Länge)
56 |SAT|Anzahl Satelliten
57 |IGNITION|Zündung an(1) oder aus(0)
58 |ENTRY1|Wert von Eingabefeld 1
59 |ENTRY2|Wert von Eingabefeld 2
60 |ENTRY3|Wert von Eingabefeld 3
61 |ENTRY4|Wert von Eingabefeld 4
62 |ENTRY5|Wert von Eingabefeld 5
63 |ENTRY6|Wert von Eingabefeld 6
64 |ENTRY7|Wert von Eingabefeld 7
65 |ENTRY8|Wert von Eingabefeld 8
66 |ENTRY9|Wert von Eingabefeld 9
67 |ENTRY10|Wert von Eingabefeld 10
68 |KM|aktueller KM-Stand des Fahrzeuges bei Ausfüllen des Formulars
69 |ORDER|selbstdefinierte Auftragsnummer, falls das Formular einem Auftrag zugeordnet war
70 |FORM|Name des Formulars/ wenn "show_desc" übergeben wurde,
71 wird die Formulardefinition über die Spalte FORM zurückgeliefert
72 |VEHICLE_COST_CENTER|Kostenstelle des Fahrzeugs
73 |DRIVER_MA_NUMBER|Mitarbeiter Nummer des Fahrers (nur gefüllt bei ReinerSCT Support)
74 |RTI_IDENT|RTI Ident des Fahrzeuges
75 |TOURDATA|selbstdefinierte Tournummern der Tour/des Ziels/der Sendung, falls das Formular einer Tour zugeordnet war
76 Format als JSON mit 
77 Unknown macro: {'tour'}
78 Wenn keine Referenz zu einer Tour besteht, ist dieses Feld null.
79 |PARENT_ID|Wenn dieses Formular ein Elternformular ist, dann enthält dieses Feld einen Hash um alle untergeordneten Kindformulare zu finden.
80 |PARENT_RELATION|Wenn dieses Formular ein Kindformular ist, dann enthält dieses Feld den Hash des übergeordneten Elternformulares.
81 |CUSTOM_ID|Eindeutige Identifikationsnummer des Formulars. Kann bei älteren Datensätzen NULL sein.
82
83 === Beispiel ===
84
85 **CSV-Rückgabe-Format - ohne Parameter "show_desc":**
86 \\{{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"
87 "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}}
88
89 **CSV-Rückgabe-Format - mit Parameter "show_desc":**
90 \\{{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"
91 "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";
92 "{""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}}
93
94 == JSON Format ==
95
96 === Beispiel ===
97
98 **JSON-Rückgabe-Format - ohne Parameter "show_desc":**
99
100 {{code language="java"}}
101 [{
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  }]
149 {{/code}}
150
151 **JSON-Rückgabe-Format - mit Parameter "show_desc":**
152
153 {{code language="java"}}
154 [{
155 "date":"2013-03-28 09:29:17",
156 "customId": "8",
157   "vehicle":"DD-AB 123",
158 "driver":"Herr Fuchs",
159 "lat":51.036687,
160 "lon":13.599141,
161 "sat":9,
162 "ignition":0,
163 "entry1":"111",
164 "entry2":"22.12.89",
165 "entry3":"11:33",
166 "entry4":"Eintrag5",
167 "entry5":"TEXT10",
168 "entry6":"TEXT30",
169 "entry7":"777.77",
170 "entry8":"1",
171 "entry9":"",
172 "entry10":"",
173 "km":"123456",
174 "order":"AUFTRAG1",
175 "tourData": null,
176 "form":{
177 "name": "UNTERSCHRIFT",
178 "driver": false,
179 "entries": [
180 {
181 "i": 1,
182 "name": "Ganzzahl",
183 "type": "int",
184 "mand": true
185 },
186 {
187 "i": 2,
188 "name": "Datum",
189 "type": "date",
190 "mand": true
191 },
192 {
193 "i": 3,
194 "name": "Zeit",
195 "type": "time",
196 "mand": true
197 },
198 {
199 "i": 4,
200 "name": "Auswahlbox",
201 "type": "sel",
202 "mand": false,
203 "spec": "Eintrag1|Eintrag2|Eintrag8|Eintrag5"
204 },
205 {
206 "i": 5,
207 "name": "Text",
208 "type": "t10",
209 "mand": false
210 },
211 {
212 "i": 6,
213 "name": "Text",
214 "type": "t30",
215 "mand": false
216 },
217 {
218 "i": 7,
219 "name": "Fließkommazahl",
220 "type": "flt",
221 "mand": false
222 },
223 {
224 "i": 8,
225 "name": "Frage",
226 "type": "bool",
227 "mand": true
228 },
229 {
230 "i": 9,
231 "name": "Unterschrift",
232 "type": "sig",
233 "mand": false
234 }
235 ]
236 },
237 "vehicleCostCenter":"Kostenstelle XYZ",
238 "driverMaNumber":"MA123456",
239 "rtiIdent":"Ident1",
240 "childForms":[
241 {
242 "date":"2013-03-28 08:29:17",
243 "customId": "7",
244 "vehicle":"DD-AB 123",
245 "driver":"Herr Fuchs",
246 "lat":51.036687,
247 "lon":13.599141,
248 "sat":9,
249 "ignition":0,
250 "entry1":"Text",
251 "entry2":"22.12.99",
252 "entry3":"11:33",
253 "km":"123456",
254 "order":"",
255 "tourData": null,
256 "form":{
257 "name": "Unterformular",
258 "driver": false,
259 "entries": [
260 {
261 "i": 1,
262 "name": "Textfeld",
263 "type": "t30",
264 "mand": true
265 },
266 {
267 "i": 2,
268 "name": "Datum",
269 "type": "date",
270 "mand": true
271 },
272 {
273 "i": 3,
274 "name": "Zeit",
275 "type": "time",
276 "mand": true
277 }
278 ]
279 },
280 "vehicleCostCenter":"Kostenstelle XYZ",
281 "driverMaNumber":"MA123456",
282 "rtiIdent":"Ident1"
283 }
284 ]
285 }]
286 {{/code}}
287
288 = JSON_V2 Format =
289
290 Die Parameter “form” und "custorder" werden ignoriert, wenn der Datentyp “json_v2” verwendet wird.
291
292 == Beispiel ==
293
294 **JSON-Rückgabe-Format - mit Parameter "show_desc":**
295 \\{{code language="java"}}[{
296 "date":"2019-11-26T10:51:39+01:00",
297 "customId": "9",
298 "vehicle":"DD-AB 123",
299 "driver":"Herr Fuchs",
300 "driverMaNumber":null,
301 "lat":51.036687,
302 "lon":13.599141,
303 "textPos": "D-01723 Wilsdruff (Kesselsdorf), Am Wüsteberg 3",
304 "sat":9,
305 "ignition":0,
306 "km":123456,
307 "order":null,
308 "orderMeta":null,
309 "tourData": null,
310 "vehicleCostCenter":null,
311 "rtiIdent":null,
312 "formName":"Beispielformular",
313 "formDriverMandatory":true,
314 "insertDate": "2020-07-22T16:08:00+02:00",
315 "completeDate": "2020-07-22T16:08:00+02:00",
316 "fields":
317 [{
318 "id":1,
319 "name":"Fließkommazahl",
320 "isMandatory":true,
321 "type":"flt",
322 "value":"111.11",
323 "isIncomplete": false
324 },
325 {
326 "id":2,
327 "name":"Text10",
328 "isMandatory":true,
329 "type":"t10",
330 "value":"Text10",
331 "isIncomplete": false
332 },
333 {
334 "id":3,
335 "name":"Text30",
336 "isMandatory":true,
337 "type":"t30",
338 "value":"Text30",
339 "isIncomplete": false
340 },
341 {
342 "id":4,
343 "name":"Text500",
344 "isMandatory":true,
345 "type":"t500",
346 "value":"Text500",
347 "isIncomplete": false
348 },
349 {
350 "id":5,
351 "name":"Ganzzahl",
352 "isMandatory":false,
353 "type":"int",
354 "value":"555",
355 "isIncomplete": false
356 },
357 {
358 "id":6,
359 "name":"Bild",
360 "isMandatory":false,
361 "type":"img",
362 "value":"48f5g3d04d177d95hs12182c39410a17e",
363 "isIncomplete": false
364 },
365 {
366 "id":7,
367 "name":"Unterschrift",
368 "isMandatory":false,
369 "type":"sig",
370 "value":"f7al12t4d177dfac0d2162f39410a17e",
371 "isIncomplete": false
372 },
373 {
374 "id":8,
375 "name":"Auswahlbox",
376 "isMandatory":false,
377 "type":"sel",
378 "value":"Eintrag 1",
379 "selectionList":
380 [
381 "Eintrag 1",
382 "Eintrag 2",
383 "Eintrag 3",
384 "Eintrag 4",
385 "Eintrag 5",
386 "Eintrag 6"
387 ]
388 },
389 {
390 "id":9,
391 "name":"Frage",
392 "isMandatory":false,
393 "type":"bool",
394 "value":"1",
395 "isIncomplete": false
396 },
397 {
398 "id":10,
399 "name":"Datum",
400 "isMandatory":false,
401 "type":"date",
402 "value":"10.10.2010",
403 "isIncomplete": false
404 },
405 {
406 "id":11,
407 "name":"Zeit",
408 "isMandatory":false,
409 "type":"time",
410 "value":"11:11",
411 "isIncomplete": false
412 },
413 {
414 "id":12,
415 "name":"Formular",
416 "isMandatory":false,
417 "type":"nestedForm",
418 "value":[
419 {
420 "date":"2019-11-26T09:51:39+01:00",
421 "customId": "7",        
422 "vehicle":"DD-AB 123",
423 "driver":"Herr Fuchs",
424 "driverMaNumber":null,
425 "lat":51.036687,
426 "lon":13.599141,
427 "textPos": "D-01723 Wilsdruff (Kesselsdorf), Am Wüsteberg 3",
428 "sat":9,
429 "ignition":0,
430 "km":123456,
431 "order":"",
432 "orderMeta":"",
433 "tourData":null,
434 "vehicleCostCenter":null,
435 "rtiIdent":null,
436 "formName":"Unterformular",
437 "formDriverMandatory":false,
438 "fields":[
439 {
440 "id":1,
441 "name":"Textfeld",
442 "isMandatory":false,
443 "type":"t30",
444 "value":"Text",
445 "isIncomplete":false
446 },
447 {
448 "id":2,
449 "name":"Bild",
450 "isMandatory":false,
451 "type":"img",
452 "value":null,
453 "isIncomplete":false
454 },
455 {
456 "id":3,
457 "name":"Unterschrift",
458 "isMandatory":false,
459 "type":"sig",
460 "value":null,
461 "isIncomplete":false
462 }
463 ],
464 "insertDate":"2019-11-26T09:53:39+01:00",
465 "completeDate":"2019-11-26T09:53:39+01:00"
466 }
467 ],
468 "isIncomplete": false
469 } ]}{{/code}}
470
471 = Beispielaufrufe =
472
473 **Für ein Fahrzeug im August 2015 und Auftragsnummer 123456**
474 \\{{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
475
476 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}}
477
478 **Für alle Fahrzeuge am 01.08.2015 für Formular "Formular Name"**
479 \\{{code language="java"}}https://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=Formular+Name&start=20150801000000&end=20150801235959{{/code}}
480