Showns all form data, recieved by the selected vehicles, for defined date range.
Description
get_custom_form_data.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=FORM_NAME&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS
Parameters
Parameter | Description | Type | Note | Required |
|---|---|---|---|---|
| company | RTI company key | string | yes | |
| vehicle | RTI vehicle key | string | On of vehicle, group or import must be defined! | yes |
| group | RTI group key | string | On of vehicle, group or import must be defined! | yes |
| import | RTI import key (all vehicles) | string | On of vehicle, group or import must be defined! | yes |
| start | Datum ab dem alle Formulardaten zurückgegeben werden | string | Format: YYYYMMDDHHMMSS | yes |
| end | Datum bis zu dem alle Formulardaten zurückgegeben werden | string | Format: YYYYMMDDHHMMSS | yes |
| form | the form name | string | Possible to define form or custorder as parameter but not needed, then all is reported | no |
| custorder | User defined order number | string | Possible to define form or custorder as parameter but not needed, then all is reported | no |
| output | Selection of output format | string | Choice to select output format, if not set the automatic format is CVS | no |
| show_spec | Returns the form definition ( nothing -> no, 1 -> yes ) | integer | A optional parameter, you can request the definition of the form. If you set the paramter with 1, you get the definition and if you send the request without the paramter it's not in the result. | no |
Return
A string is returned. On error "ERROR:Description" is returned.
CSV format
If the request is valid, the data are returned as CSV (Comma Separated Value) format. The first response line is always
the header, defining the column names. After it the personal data follows.
Meta informations
| Separator | Semicolon ( ; ) |
|---|---|
| Delimiter | Double quote ( " ) |
| Line break | 0x0D 0x0A (CarriageReturn LineFeed) |
| Header | Line 1 |
| Encoding | UTF-8 |
Columns
Column | Description |
|---|---|
| DATE | Date with format (YYYY-MM-DD HH:MM:SS) |
| VEHICLE | Vehicle sign |
| DRIVER | Driver name (if avialable) |
| LAT | Latitude coordinate |
| LON | Longitude coordinate |
| SAT | Satellite count |
| IGNITION | Ignition ON(1) or OFF(0) |
| ENTRY1 | Input field 1 value. |
| ENTRY2 | Input field 2 value. |
| ENTRY3 | Input field 3 value. |
| ENTRY4 | Input field 4 value. |
| ENTRY5 | Input field 5 value. |
| ENTRY6 | Input field 6 value. |
| ENTRY7 | Input field 7 value. |
| ENTRY8 | Input field 8 value. |
| ENTRY9 | Input field 9 value. |
| ENTRY10 | Input field 10 value. |
| KM | Current mileage in kilometers of the vehicle at time of completing form |
| ORDER | user defined order number if form is assigned to an order |
| FORM | The form name / if "show_desc" is part of request, the form definition in the result is in the "FORM" column |
VEHICLE_COST_CENTER | cost center of the vehicle |
| DRIVER_MA_NUMBER | Employee number of the driver (only filled with activated ReinerSCT support) |
Example
CSV-Return - without parameter "show_desc"
"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" "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"
CSV-Return - with parameter "show_desc"
"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"
"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";
"{""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"
JSON format
Example
JSON-Return - without parameter "show_desc"
[{
"date":"2013-03-28 09:29:17",
"vehicle":"DD-AB 123",
"driver":"Herr Fuchs",
"lat":51.036687,
"lon":13.599141,
"sat":9,
"ignition":0,
"entry1":"111",
"entry2":"22.12.89",
"entry3":"11:33",
"entry4":"Eintrag5",
"entry5":"TEXT10",
"entry6":"TEXT30",
"entry7":"777.77",
"entry8":"1",
"entry9":"",
"entry10":"",
"km":"123456",
"order":"AUFTRAG1",
"form":"UNTERSCHRIFT",
"VEHICLE_COST_CENTER":"Kostenstelle XYZ",
"DRIVER_MA_NUMBER":"MA123456"
}]
JSON-Return - with parameter "show_desc"
[{
"date":"2013-03-28 09:29:17",
"vehicle":"DD-AB 123",
"driver":"Herr Fuchs",
"lat":51.036687,
"lon":13.599141,
"sat":9,
"ignition":0,
"entry1":"111",
"entry2":"22.12.89",
"entry3":"11:33",
"entry4":"Eintrag5",
"entry5":"TEXT10",
"entry6":"TEXT30",
"entry7":"777.77",
"entry8":"1",
"entry9":"",
"entry10":"",
"km":"123456",
"order":"AUFTRAG1",
"form":{
"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ßkommazahl",
"type": "flt",
"mand": false
},
{
"i": 8,
"name": "Frage",
"type": "bool",
"mand": true
},
{
"i": 9,
"name": "Unterschrift",
"type": "sig",
"mand": false
}
]
},
"VEHICLE_COST_CENTER":"Kostenstelle XYZ",
"DRIVER_MA_NUMBER":"MA123456"
}]
JSON_V2 Format
The parameters "form" and "custorder" are ignored if the output type "json_v2" is used.
Beispiel
JSON-Rückgabe-Format - mit Parameter "show_desc":
[{
"date":"2019-11-26T10:51:39+01:00",
"vehicle":"DD-AB 123",
"driver":"Herr Fuchs",
"driverMaNumber":null,
"lat":51.036687,
"lon":13.599141,
"textPos": "D-01723 Wilsdruff (Kesselsdorf), Am Wüsteberg 3",
"sat":9,
"ignition":0,
"km":123456,
"order":null,
"orderMeta":null,
"vehicleCostCenter":null,
"rtiIdent":null,
"formName":"Beispielformular",
"formDriverMandatory":true,
"fields":
[{
"id":1,
"name":"Fließkommazahl",
"isMandatory":true,
"type":"flt",
"value":"111.11"
},
{
"id":2,
"name":"Text10",
"isMandatory":true,
"type":"t10",
"value":"Text10"
},
{
"id":3,
"name":"Text30",
"isMandatory":true,
"type":"t30",
"value":"Text30"
},
{
"id":4,
"name":"Text500",
"isMandatory":true,
"type":"t500",
"value":"Text500"
},
{
"id":5,
"name":"Ganzzahl",
"isMandatory":false,
"type":"int",
"value":"555"
},
{
"id":6,
"name":"Bild",
"isMandatory":false,
"type":"img",
"value":"48f5g3d04d177d95hs12182c39410a17e"
},
{
"id":7,
"name":"Unterschrift",
"isMandatory":false,
"type":"sig",
"value":"f7al12t4d177dfac0d2162f39410a17e"
},
{
"id":8,
"name":"Auswahlbox",
"isMandatory":false,
"type":"sel",
"value":"Eintrag 1",
"selectionList":
[
"Eintrag 1",
"Eintrag 2",
"Eintrag 3",
"Eintrag 4",
"Eintrag 5",
"Eintrag 6"
]
},
{
"id":9,
"name":"Frage",
"isMandatory":false,
"type":"bool",
"value":"1"
},
{
"id":10,
"name":"Datum",
"isMandatory":false,
"type":"date",
"value":"10.10.2010"
},
{
"id":11,
"name":"Zeit",
"isMandatory":false,
"type":"time",
"value":"11:11"
}
]}
Example calls
For all Vehicles at 2015-08-01 for form "Form Name"
http://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=Form+Name&start=20150801000000&end=20150801235959
For a single vehicle at august 2015 and custom order number 123456
http://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&custorder=123456&start=20150801000000&end=20150831235959