Wiki-Quellcode von get_custom_form_data.php

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