Wiki source code of get_custom_form_description.php
Last modified by YellowFox_RD on 2025/01/23 10:11
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | ((( | ||
| 3 | Table of Contents | ||
| 4 | ))) | ||
| 5 | |||
| 6 | {{toc/}} | ||
| 7 | |||
| 8 | 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. | ||
| 9 | |||
| 10 | = Description = | ||
| 11 | |||
| 12 | (% class="green mark" %)**GET**(%%)** get_custom_form_description.php?company**=//COMPANY_RTIKEY//**&import**=//IMPORT_RTIKEY//**&form**=//Testformular// | ||
| 13 | |||
| 14 | = Parameter = | ||
| 15 | |||
| 16 | |=Parameter|=Description|=Type|=Note|=Mandatory | ||
| 17 | |company|RTI company key|string| |yes | ||
| 18 | |import|RTI import key (all vehicles)|string| |yes | ||
| 19 | |form|formular name|string| |yes | ||
| 20 | |||
| 21 | = Return = | ||
| 22 | |||
| 23 | Returns a **string**. In case of error "(% class="error" %)**ERROR:Description**(%%)" will be returned. | ||
| 24 | **Header** | ||
| 25 | {{code language="java"}}"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";{{/code}} | ||
| 26 | |||
| 27 | == Meta informations == | ||
| 28 | |||
| 29 | |=Separator|Semicolon ( ; ) | ||
| 30 | |=Delimiter|Double quote ( " ) | ||
| 31 | |=Line break|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 32 | |=Header|Line 1 | ||
| 33 | |||
| 34 | == Columns == | ||
| 35 | |||
| 36 | |=Column|=Description|= | ||
| 37 | |ENTRY_NAME_X|name of formular field X| | ||
| 38 | |ENTRY_TYPE_X|type of formular field X| | ||
| 39 | |ENTRY_SPEC_X|specification of formular field 1|only in connection with a select field "sel", multiple entries are divided by(~|) | ||
| 40 | |ENTRY_MANDATORY_X|Is it mandatory to fill out this formular field|1 - must be filled out, 0 - can be filled out | ||
| 41 | |DRIVER_MANDATORY|Is a driver identification mandatory before the fomular can be sent|1 - must be there, 0 - can be there | ||
| 42 | |DELETED|formular deleted|1 - deleted, 0 - not deleted | ||
| 43 | |DELETED_DATE|date when formular was deleted|format YYYY-MM-DD HH:MM:SS | ||
| 44 | |||
| 45 | == Types == | ||
| 46 | |||
| 47 | |=Column|=Description | ||
| 48 | |DATE|date | ||
| 49 | |time|time | ||
| 50 | |int|Integer | ||
| 51 | |flt|float | ||
| 52 | |t10|text with a maximum of 10 token | ||
| 53 | |t30|text with a maximum of 30 token | ||
| 54 | |t500|text with a maximum of 500 token | ||
| 55 | |sel|select box | ||
| 56 | |bool|yes/no selection | ||
| 57 | |sig|Signature | ||
| 58 | |nestedForm|formular | ||
| 59 | |||
| 60 | == Example == | ||
| 61 | |||
| 62 | **return csv** | ||
| 63 | {{code language="java"}}"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"; | ||
| 64 | "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";""; | ||
| 65 | "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"; | ||
| 66 | "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";{{/code}} | ||
| 67 | |||
| 68 | = Example calls = | ||
| 69 | |||
| 70 | **request to get structure of formular** | ||
| 71 | {{code language="java"}}https://map.yellowfox.de/rti/get_custom_form_description.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=Testformular{{/code}} | ||
| 72 |