Sv translation

language	en

Shows all form data received by selected vehicles during a defined date range.

Description

Status

colour	Green
title	GET

get_custom_form_data.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=FORM_NAME&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS

Parameters

Parameter	Description	Type	Note	Mandatory
company	RTI company key	string		yes
vehicle	RTI vehicle key	string	One of vehicle, group or import must be defined!	yes
group	RTI group key	string	One of vehicle, group or import must be defined!	yes
import	RTI import key (all vehicles)	string	One 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. Returns all if not given.	no
custorder	User defined order number	string	Possible to define form or custorder as parameter. Returns all if not given.	no
output	Selection of output format	string	is CSV by default	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
date_query	(create, insert, complete)	string	Optional. Create is default.	no
complete_buffer	how long should a incomplete form be ignored	integer	value in minutes. Has only affect if date_query = complete	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)
RTI_IDENT	RTI ident of the vehicle
TOURDATA	user defined number of tour/destination/shipment, if form is attached to a tour Format as JSON like "tourData": {"tour":"T1","dest":"T2","ship":"T3"} Is null if not attached to tour.

Example

Code Block

title	CSV-Return - without parameter Rückgabe-Format - ohne 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";"RTI_IDENT";"TOURDATA"
";"PARENT_ID";"PARENT_RELATION" "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";"IDENT123IDENT1";null
;"22201eb2fd123df28156bc0c86e0aba2";""

Code Block

title	CSV-Rückgabe-Return Format - with parameter mit 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";"RTI_IDENT";"TOURDATA"
";"PARENT_ID";"PARENT_RELATION"  "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";"IDENT123IDENT1";null;"22201eb2fd123df28156bc0c86e0aba2";""

JSON

format

Format

Example

Code Block

title	return json- without parameter JSON-Rückgabe-Format - ohne 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",
	"tourData": null,
    	"form":"UNTERSCHRIFT",
    "VEHICLE_COST_CENTER	"vehicleCostCenter":"Kostenstelle XYZ",
    "DRIVER_MA_NUMBER	"driverMaNumber":"MA123456",
	"rtiIdent":"Ident1",
 }]

Code Block

title	return json- with parameter "show_desc"

[{
    	"childForms":[
		{
		  	"date":"2013-03-28 0908:29:17",
    			"vehicle":"DD-AB 123",
    			"driver":"Herr Fuchs",
    			"lat":51.036687,
    			"lon":13.599141,
    			"sat":9,
    			"ignition":0,
    			"entry1":"111Text",
    			"entry2":"22.12.8999",
    			"entry3":"11:33",
    "entry4			"km":"Eintrag5123456",
    "entry5			"order":"TEXT10",
			"tourData": null,
			"form":"Unterformular",
			"vehicleCostCenter":"Kostenstelle XYZ",
			"driverMaNumber":"MA123456",
			"rtiIdent":"Ident1"
		}
	]
 }]

Code Block

title	JSON-Rückgabe-Format - mit 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",
	"tourData": null,
	"form":{
	  "name": "UNTERSCHRIFT",
      "driver": false,
      "entries": [    "entry6":"TEXT30",
    "entry7":"777.77",
    "entry8":"1",
    "entry9":"",
    "entry10":"",
    "km":"123456",
    "order":"AUFTRAG1",
	"tourData": null,
    "form":{
      "name": "UNTERSCHRIFT",
      "driver": false,
      "entries": [
            {
                "i": 1,
                "name": "Ganzzahl",
                "type": "int",
                "mand": true
            },
            {
                "i": 2,
        	{
          		"namei": "Datum"1,
          		"name": "Ganzzahl",
          		"type": "dateint",
                		"mand": true
            	},
            	{
                		"i": 32,
                		"name": "ZeitDatum",
                		"type": "timedate",
                		"mand": true
            	},
            	{
                		"i": 43,
                "name": "Auswahlbox"		"name": "Zeit",
                		"type": "seltime",
                		"mand": false,true
                "spec": "Eintrag1|Eintrag2|Eintrag8|Eintrag5"
            	},
            	{
                		"i": 54,
                		"name": "TextAuswahlbox",
                		"type": "t10sel",
                		"mand": false,
				"spec":            "Eintrag1|Eintrag2|Eintrag8|Eintrag5" 
			},
            	{
                		"i": 65,
                		"name": "Text",
                		"type": "t30t10",
                		"mand": false
            	},
            	{
                		"i": 76,
                		"name": "FließkommazahlText",
                		"type": "fltt30",
                		"mand": false
            	},
            	{
                		"i": 87,
                		"name": "FrageFließkommazahl",
                		"type": "boolflt",
                		"mand": truefalse
            	},
            	{
                		"i": 98,
                		"name": "UnterschriftFrage",
                		"type": "sigbool",
                		"mand": falsetrue
         	},
        }	{
        ]
   		"i": 9,
           },
		"name": "Unterschrift",
          "VEHICLE_COST_CENTER		"type": "Kostenstelle XYZsig",
          "DRIVER_MA_NUMBER":"MA123456"
 }]

JSON_V2 Format

The parameters "form" and "custorder" are ignored if the output type "json_v2" is used.

example

Code Block

title	return json- with parameter "show_desc":

[{
		"mand": false
        	}
		]
	},
	"vehicleCostCenter":"Kostenstelle XYZ",
	"driverMaNumber":"MA123456",
	"rtiIdent":"Ident1",
   	"childForms":[
		{
		  	"date":"2013-03-28 08:29:17",
			"vehicle":"DD-AB 123",
			"driver":"Herr Fuchs",
			"lat":51.036687,
			"lon":13.599141,
			"sat":9,
			"ignition":0,
			"entry1":"Text",
			"entry2":"22.12.99",
			"entry3":"11:33",
			"km":"123456",
			"order":"",
			"tourData": null,
			"form":{
	  				"name": "Unterformular",
      				"driver": false,
      				"entries": [
        				{
          					"i": 1,
          					"name": "Textfeld",
          					"type": "t30",
          					"mand": true
        				},
        				{
          					"i": 2,
          					"name": "Datum",
          					"type": "date",
          					"mand": true
        				},
        				{
          					"i": 3,
          					"name": "Zeit",
          					"type": "time",
          					"mand": true
        				}
					]
			},
			"vehicleCostCenter":"Kostenstelle XYZ",
			"driverMaNumber":"MA123456",
			"rtiIdent":"Ident1"
		}
	] 
 }]

JSON_V2 Format

The parameters "form" and "custorder" are ignored if the output type "json_v2" is used.

Beispiel

Code Block

title	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,
	"tourData": null,
	"vehicleCostCenter":null,
	"rtiIdent":null,
	"formName":"Beispielformular",
	"formDriverMandatory":true,
	"insertDate": "2020-07-22T16:08:00+02:00",
    "completeDate": "2020-07-22T16:08:00+02:00",
	"fields":
			[{
				"id":1,
				"name":"Fließkommazahl",
				"isMandatory":true,
				"type":"flt",
				"value":"111.11",
				"isIncomplete": false            
			},
			{
				"id":2,
				"name":"Text10",
				"isMandatory":true,
				"type":"t10",
				"value":"Text10",
				"isIncomplete": false
			},
			{
				"id":3,
				"name":"Text30",
				"isMandatory":true,
				"type":"t30",
				"value":"Text30",
				"isIncomplete": false
			},
			{
				"id":4,
				"name":"Text500",
				"isMandatory":true,
				"type":"t500",
				"value":"Text500",
				"isIncomplete": false
			},
			{	
				"id":5,
				"name":"Ganzzahl",
				"isMandatory":false,
				"type":"int",
				"value":"555",
				"isIncomplete": false
			},
			{
				"id":6,
				"name":"Bild",
				"isMandatory":false,
				"type":"img",
				"value":"48f5g3d04d177d95hs12182c39410a17e",
				"isIncomplete": false
			},
			{
				"id":7,
				"name":"Unterschrift",
				"isMandatory":false,
				"type":"sig",
				"value":"f7al12t4d177dfac0d2162f39410a17e",
				"isIncomplete": false
			},
			{
				"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",
				"isIncomplete": false
			},
			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,
	"tourData": null,
	"vehicleCostCenter":null,
	"rtiIdent":null,
	"formName":"Beispielformular",
	"formDriverMandatory":true,
	"insertDate": "2020-07-22T16:08:00+02:00",
    "completeDate": "2020-07-22T16:08:00+02:00",
	"fields":
			[{
				"id":110,
				"name":"FließkommazahlDatum",
				"isMandatory":truefalse,
				"type":"fltdate",
				"value":"11110.10.112010",
				"isIncomplete": false
			},
			{
				"id":211,
				"name":"Text10Zeit",
				"isMandatory":truefalse,
				"type":"t10time",
				"value":"Text1011:11",
				"isIncomplete": false
			},
 			{
				"id":312,
				"name":"Text30Formular",
				"isMandatory":truefalse,
				"type":"t30nestedForm",
				"value":"Text30",[ 
				"isIncomplete": false
			},{
 				{
				"id":4,
"date":"2019-11-26T09:51:39+01:00",
								"namevehicle":"Text500DD-AB 123",
				"isMandatory":true,
				"typedriver":"t500Herr Fuchs",
				"value":"Text500",
				"isIncompletedriverMaNumber": false
			}null,
			{	
				"idlat":551.036687,
								"namelon":"Ganzzahl"13.599141,
				"isMandatory":false,
				"typetextPos":"int "D-01723 Wilsdruff (Kesselsdorf), Am Wüsteberg 3",
				"value":"555",
				"isIncompletesat": false
			}9,
				{
				"idignition":60,
								"namekm":"Bild"123456, 
				"isMandatory":false,
				"typeorder":"img",
								"valueorderMeta":"48f5g3d04d177d95hs12182c39410a17e",
								"isIncompletetourData": false
null,
								}"vehicleCostCenter":null,
				{
				"idrtiIdent":7null,
								"nameformName":"UnterschriftUnterformular",
								"isMandatoryformDriverMandatory":false,
				"type":"sig",
				"valuefields":"f7al12t4d177dfac0d2162f39410a17e",[
					"isIncomplete": false
			},
			{
												"id":81,
												"name":"AuswahlboxTextfeld",
												"isMandatory":false,
												"type":"selt30",
												"value":"Eintrag 1Text",,
												"isIncomplete": false
false
											},
											"selectionList":
{
										[
		"id":2,
												"Eintrag 1"name":"Bild",
												"Eintrag 2isMandatory":false,
												"Eintrag 3"type":"img",
												"Eintrag 4value":null,
									"Eintrag 5",
			"isIncomplete":false
											"Eintrag 6"
},
										]	{
					},
			{
				"id":93,
				"name":"Frage",
				"isMandatory":false,
				"typename":"boolUnterschrift",
							"value":"1",
					"isIncompleteisMandatory": false,
			},
			{
				"id":10,
				"nametype":"Datumsig",
				"isMandatory":false,
				"type":"date",
				"value":"10.10.2010"null,
												"isIncomplete": false
											},
						{
				"id":11],
								"nameinsertDate":"Zeit2019-11-26T09:53:39+01:00",
				"isMandatory":false,
				"typecompleteDate":"time",2019-11-26T09:53:39+01:00"
							}
				"value":"11:11"],
				"isIncomplete": false
			}
  ]}

Example calls

Code Block

title	For all Vehicles at 2015-08-01 for form "Form Name"

https://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&form=Form+Name&start=20150801000000&end=20150801235959

https://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&custorder=123456&start=20150801000000&end=20150831235959

Code Block

title	For a single vehicle at august 2015 and custom order number 123456

https://map.yellowfox.de/rti/get_custom_form_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&custorder=123456&start=20150801000000&end=20150831235959

Page tree

Versions Compared

Old Version 81

New Version Current

Key

Description

Parameters

Return

CSV format

Meta informations

Columns

Example

JSON

Format

Example

JSON_V2 Format

example

JSON_V2 Format

Beispiel

Example calls

Page tree

Page History

Versions Compared

Old Version 81

New Version Current

Key

Description

Parameters

Return

CSV format

Meta informations

Columns

Example

JSON

Format

Example

JSON_V2 Format

example

JSON_V2 Format

Beispiel

Example calls