Shows structure of formulars with search name. Vehicle key is requested for safety reasons. It doesn't have any influence on the search resutls. All versions of the fomular will be delivered.
Description
GET get_custom_form_description.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=Testformular
Parameter
Parameter | Description | Type | Note | Mandatory |
---|---|---|---|---|
company | RTI company key | string | yes | |
import | RTI import key (all vehicles) | string | yes | |
form | formular name | string | yes |
Return
Returns a string. In case of error "ERROR:Description" will be returned.
Header
"ENTRY_NAME_1";"ENTRY_TYPE_1";"ENTRY_SPEC_1";"ENTRY_MANDATORY_1";"ENTRY_NAME_2";"ENTRY_TYPE_2";"ENTRY_SPEC_2";"ENTRY_MANDATORY_2";"ENTRY_NAME_3";"ENTRY_TYPE_3";"ENTRY_SPEC_3";"ENTRY_MANDATORY_3";"ENTRY_NAME_4";"ENTRY_TYPE_4";"ENTRY_SPEC_4";"ENTRY_MANDATORY_4";"ENTRY_NAME_5";"ENTRY_TYPE_5";"ENTRY_SPEC_5";"ENTRY_MANDATORY_5";"ENTRY_NAME_6";"ENTRY_TYPE_6";"ENTRY_SPEC_6";"ENTRY_MANDATORY_6";"ENTRY_NAME_7";"ENTRY_TYPE_7";"ENTRY_SPEC_7";"ENTRY_MANDATORY_7";"ENTRY_NAME_8";"ENTRY_TYPE_8";"ENTRY_SPEC_8";"ENTRY_MANDATORY_8";"ENTRY_NAME_9";"ENTRY_TYPE_9";"ENTRY_SPEC_9";"ENTRY_MANDATORY_9";"ENTRY_NAME_10";"ENTRY_TYPE_10";"ENTRY_SPEC_10";"ENTRY_MANDATORY_10";"DRIVER_MANDATORY";"DELETED";"DELETED_DATE";
Meta informations
Separator | Semicolon ( ; ) |
---|---|
Delimiter | Double quote ( " ) |
Line break | 0x0D 0x0A (CarriageReturn LineFeed) |
Header | Line 1 |
Columns
Column | Description | |
---|---|---|
ENTRY_NAME_X | name of formular field X | |
ENTRY_TYPE_X | type of formular field X | |
ENTRY_SPEC_X | specification of formular field 1 | only in connection with a select field "sel", multiple entries are divided by(|) |
ENTRY_MANDATORY_X | Is it mandatory to fill out this formular field | 1 - must be filled out, 0 - can be filled out |
DRIVER_MANDATORY | Is a driver identification mandatory before the fomular can be sent | 1 - must be there, 0 - can be there |
DELETED | formular deleted | 1 - deleted, 0 - not deleted |
DELETED_DATE | date when formular was deleted | format YYYY-MM-DD HH:MM:SS |
Types
Column | Description |
---|---|
DATE | date |
time | time |
int | Integer |
flt | float |
t10 | text with a maximum of 10 token |
t30 | text with a maximum of 30 token |
t500 | text with a maximum of 500 token |
sel | select box |
bool | yes/no selection |
sig | Signature |
nestedForm | formular |
Example
return csv
"ENTRY_NAME_1";"ENTRY_TYPE_1";"ENTRY_SPEC_1";"ENTRY_MANDATORY_1";"ENTRY_NAME_2";"ENTRY_TYPE_2";"ENTRY_SPEC_2";"ENTRY_MANDATORY_2";"ENTRY_NAME_3";"ENTRY_TYPE_3";"ENTRY_SPEC_3";"ENTRY_MANDATORY_3";"ENTRY_NAME_4";"ENTRY_TYPE_4";"ENTRY_SPEC_4";"ENTRY_MANDATORY_4";"ENTRY_NAME_5";"ENTRY_TYPE_5";"ENTRY_SPEC_5";"ENTRY_MANDATORY_5";"ENTRY_NAME_6";"ENTRY_TYPE_6";"ENTRY_SPEC_6";"ENTRY_MANDATORY_6";"ENTRY_NAME_7";"ENTRY_TYPE_7";"ENTRY_SPEC_7";"ENTRY_MANDATORY_7";"ENTRY_NAME_8";"ENTRY_TYPE_8";"ENTRY_SPEC_8";"ENTRY_MANDATORY_8";"ENTRY_NAME_9";"ENTRY_TYPE_9";"ENTRY_SPEC_9";"ENTRY_MANDATORY_9";"ENTRY_NAME_10";"ENTRY_TYPE_10";"ENTRY_SPEC_10";"ENTRY_MANDATORY_10";"DRIVER_MANDATORY";"DELETED";"DELETED_DATE"; "Ganzahl";"int";"";"0";"Zeit";"time";"";"0";"Spinner";"sel";"Eintrag1|Eintrag2|Eintrag3|Eintrag4|Eintrag5|Eintrag6|Eintrag7|Eintrag8|Eintrag9|Eintrag10|Eintrag11|Eintrag12";"0";"Text10";"t10";"";"0";"Text30";"t30";"";"0";"Double";"flt";"";"0";"Checkbox";"bool";"";"0";"";"";"";"0";"";"";"";"0";"0";"0";""; "Ganzahl";"int";"";"0";"Zeit";"time";"";"0";"Double";"flt";"";"0";"Text10";"t10";"";"0";"Text30";"t30";"";"0";"Spinner";"sel";"";"0";"Checkbox";"bool";"";"0";"";"";"";"0";"";"";"";"0";"0";"1";"2013-03-27 11:41:21"; "Stundenzettel";"nestedForm";"min:0|max:null";"0";"Beschreibung";"t10";"";"1";"Unterschrift";"sig";"";"0";"";"";"";"0";"";"";"";"0";"";"";"";"0";"";"";"";"0";"";"";"";"0";"";"";"";"0";"";"";"";"0";"0";"1";"2022-09-06 13:55:03";
Example calls
request to get structure of formular
https://map.yellowfox.de/rti/get_custom_form_description.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=Testformular