Wiki-Quellcode von do_customdialog_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 Ein Formulareintrag wird für einen bestimmten Formulartyp angelegt. Dabei kann das Fahrzeug, der Fahrer und der Zeitpunkt, an dem das Formular gültig sein soll, übergeben werden.
6 = Beschreibung =
7 //**(% class="blue mark" %)POST(%%) do_customdialog_data.php?company**//=COMPANY_RTIKEY**&vehicle**=VEHICLE_RTIKEY//**//**&driver**//**////=DRIVER_HEXKEY**&form**////=Formname**&ts**//=//Zeitstempel////**&val1**//=//Feld 1-Wert////**&val2**//=Felld 2-Wert//**&valX**//=//Feld X-Wert//
8 = Parameter =
9 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
10 |company|RTI Firmenschlüssel|string|Firmen RTI Schlüssel wird erwartet|ja
11 |vehicle|RTI Fahrzeugschlüssel|string|Fahrzeug RTI Schlüssel wird erwartet|ja
12 |driver|Fahrerschlüssel|string||ja
13 |form|Formularname|string||ja
14 |ts|Timestamp|string|Zeitstempel, der den Zeitpunkt des Formulareintrags festlegt.
15 Dabei ist folgende Form einzuhalten: YYYYMMDDhhmmss|ja
16 |valX|Formularwert Feld X|integer|Je nach Formulardefinition können bis zu 10 Werten übergeben werden.
17 Dabei ist der jeweilige Formularaufbau zu beachten, der vorgibt welcher
18 Wertetyp bei den einzelnen Werten einzuhalten ist.
19 Felder für Bilder und Unterschriften können, selbst wenn sie als Pflichtfelder
20 deklariert sind, freigelassen werden.|ja, falls Pflichtfeld, ansonsten optional
21
22 = Feldtypen-Formate =
23 (((
24 * Datum: YYYYMMDD
25 * Zeit: hhmmss
26 * Ganzzahl: 0123456789
27 * Fließkommazahl: 123.4567890
28 * Text 10: Text mit der Länge von 10 Zeichen
29 * Text 30: Text mit der Länge von 30 Zeichen
30 * Text 500: Text mit der Länge von 500 Zeichen
31 * Auswahlfeld: Text, der **eine** in der Formulardefinition enthaltene Auswahlmöglichkeit enthält
32 * Ja/ Nein-Feld: Ja = 1, Nein = 0
33 * Bilder/ Unterschriften/ Formulare: es wird kein Wert übergeben, kann über RTI nicht eingegeben werden
34 )))
35 = Rückgabe =
36 Es wird standardmäßig eine "**OK**"-Meldung zurückgegeben, die den Erfolg der Funktion bestätigt. Bei fehlenden Pflichtparametern oder fehlerhaften Datentypen für einen oder mehrere Werte wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
37 Mögliche Fehlermeldungen und Bedeutung:
38 (% class="error" %)"**PARAMETER_TS_NOT_GIVEN**" - Kein Timestamp übergeben(%%)
39 "**(% class="error" %)PARAMETER_DRIVER_NOT_GIVEN(%%)**" - Kein Fahrerschlüssel übergeben
40 "**(% class="error" %)PARAMETER_FORM_NOT_GIVEN(%%)**" - Kein Formularbezeichner übergeben
41 "**(% class="error" %)PARAMETER_TS_INVALID(%%)**" - Timestamp ist nicht korrekt
42 "**(% class="error" %)PARAMETER_DRIVER_HEXKEY_INVALID(%%)**" - Fahrerschlüssel ist nicht korrekt oder existiert nicht
43 "**(% class="error" %)FORM_NOT_FOUND(%%)**" - Kein Formular mit dem Bezeichner gefunden
44 "(% class="error" %)**WRONG_FORMATTED_FIELDS(Feldnummern)**(%%)" - Liste der Felder, für die falsch formatierte Werte übergeben wurden
45 "**(% class="error" %)MANDATORY_FIELDS_MISSING(Feldnummern(%%)(% class="error" %))(%%)**" - Liste der Felder, die Pflichtfelder sind, für die aber keine Werte übergeben wurden
46 = Beispielaufrufe =
47
48 **normale Nachricht an einzelnes Fahrzeug**
49 {{code language="java"}}Beilspielwerte-Typen:
50 1: Text 10, 2: Datum, 3: Zeit, 4: Ganzzahl, 5: Fließkommazahl, 6: Auswahlfeld, 7: Ja/Nein-Feld, 8: Text 30, 9: Text 500, 10: Ja/Nein-Feld
51 https://map.yellowfox.de/rti/do_customdialog_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&driver=DRIVER_HEXKEY&form=FORM_NAME&ts=20171114120000&val1=Text&val2=20171231&val3=114500&val4=12345&val5=12.345&val6=Auswahl4&val7=1&val8=Ein%20l%C3%A4ngerer%20Text&val9=Ein%20noch%20viel%20l%C3%A4ngerer%20Text%20als%20Beispiel&val10=0
52
53 https://map.yellowfox.de/rti/do_customdialog_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&driver=DRIVER_HEXKEY&form=FORM_NAME&ts=20171114120000&val1=Text&val2=20171231&val3=114500&val4=12345&val5=12.345&val6=Auswahl4&val7=1&val8=Ein%20l%C3%A4ngerer%20Text&val9=Ein%20noch%20viel%20l%C3%A4ngerer%20Text%20als%20Beispiel&val10=0{{/code}}
54