Wiki source code of do_customdialog_data.php

Last modified by YellowFox_RD on 2025/01/23 09:55
Show last authors
1 (% class="box" %)
2 (((
3 Table of Contents
4 )))
5
6 {{toc/}}
7
8 Creating a form entry for a specific form definition. Every form belongs to a vehicle, a driver and a time, when the form is valid and this has to be given when the form is created.
9
10 = Description =
11
12 (% class="blue mark" %)//**POST**//(%%)//** do_customdialog_data.php?company**//=COMPANY_RTIKEY**&vehicle**=VEHICLE_RTIKEY&driver//=DRIVER_HEXKEY**&form**=formname**&ts**//=//timestamp**&val1**//=//field 1-value**&val2**//=field 2-value//**&valX**//=field// X-value//
13
14 = Parameter =
15
16 |=Parameter|=Desciption|=Type|=Hint|=Mandatory
17 |company|RTI Firmenschlüssel|string|comany RTI key is needed|yes
18 |vehicle|RTI Fahrzeugschlüssel|string|vehicle RTI key is needed|yes
19 |driver|Fahrerschlüssel|string| |yes
20 |form|Formularname|string| |yes
21 |ts|Timestamp|string|Time of the form is set.
22 The following format is needed: YYYYMMDDhhmmss|yes
23 |valX|form entry field X|integer|Each form definition has up to 10 field which can be send.
24 For every form you have to observe the form structure, because of the types and order of each entry.
25 Fields with pictures or signatures can not be set by this function and you let them free, also if they are mandatory.|yes, if mandatory field, if not it is optional
26
27 = Field type formats =
28
29 (((
30 * date: YYYYMMDD
31 * time: hhmmss
32 * integer: 0123456789
33 * float: 123.4567890
34 * text 10: text with the length of 10 characters
35 * text 30: text with the length of 30 characters
36 * text 500: text with the length of 500 characters
37 * options field: text, which is** one **of the defined options of the form field** **
38 * yes/ no-field: yes = 1, no = 0
39 * pictures/ signatures/ forms: you send no value, this can not be set by this RTI function
40 )))
41
42 = Return =
43
44 The standard return is a "**OK**"-message, which marks the succes of the function. If a mandatory parameter is missing or values have a wrong format the retrurn message is "(% class="error" %)**ERROR:Description**(%%)".
45 Possible error Messages and their meaning:
46 "(% class="error" %)**PARAMETER_TS_NOT_GIVEN**(%%)" - no timestamp passed
47 "(% class="error" %)**PARAMETER_DRIVER_NOT_GIVEN**(%%)" - no driver key passed
48 "(% class="error" %)**PARAMETER_FORM_NOT_GIVEN**(%%)" - no form name passed
49 "(% class="error" %)**PARAMETER_TS_INVALID**(%%)" - timestamp is no correct date/time value
50 "(% class="error" %)**PARAMETER_DRIVER_HEXKEY_INVALID**(%%)" - driver key is not correct or is not existing
51 "(% class="error" %)**FORM_NOT_FOUND**(%%)" - no form found with this name
52 "(% class="error" %)**WRONG_FORMATTED_FIELDS(Feldnummern)**(%%)" - list of fields where the values are wrong formatted
53 "(% class="error" %)**MANDATORY_FIELDS_MISSING(Feldnummern)**(%%)" - list of fields, which are mandatory, but no value is passed
54
55 = Example call =
56
57 **normale Nachricht an einzelnes Fahrzeug**
58 {{code language="java"}}example value-types:
59 1: text 10, 2: date, 3: time, 4: integer, 5: float, 6: options field, 7: yes/no-field, 8: text 30, 9: text 500, 10: yes/no-field
60 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=option4&val7=1&val8=Ein%20l%C3%A4ngerer%20Text&val9=Ein%20noch%20viel%20l%C3%A4ngerer%20Text%20als%20Beispiel&val10=0
61
62 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}}
63