get_custom_form_data.php

Zuletzt geändert von YellowFox_RD am 2025/01/23 10:04

Inhaltsverzeichnis

Zeigt alle Formulardaten die bei den gewählten Fahrzeugen, in dem gewählten Zeitraum empfangen wurden.

Beschreibung

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

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring ja
vehicleRTI FahrzeugschlüsselstringEs muss immer einer der Parameter vehicle, group oder import angegeben werden!ja
groupRTI GruppenschlüsselstringEs muss immer einer der Parameter vehicle, group oder import angegeben werden!ja
importRTI Importschlüssel (alle Fahrzeuge)stringEs muss immer einer der Parameter vehicle, group oder import angegeben werden!ja
startDatum ab dem alle Formulardaten zurückgegeben werdenstringFormat: YYYYMMDDHHMMSSja
endDatum bis zu dem alle Formulardaten zurückgegeben werdenstringFormat: YYYYMMDDHHMMSSja
formFormularnamestringEs kann einer der Parameter form oder custorder angegeben werdennein
custorderSelbstdefinierte Auftragsnummer, zur Abfrage der Daten von einem AuftragstringEs kann einer der Parameter form oder custorder angegeben werdennein
outputAuswahl des AusgabeformatesstringEs kann das Ausgabeformat gewählt werden. Mögliche Werte:
  • csv
  • json
  • json_v2
Wenn kein Format gesetzt wird, werden die Daten standardmäßig als CSV ausgegeben. Die Formate CSV und JSON können nur bis zu 10 Felder pro Formular ausgeben. Das Format JSON V2 ist daher zu bevorzugen.		nein
show_descGib den Aufbau des Formulartyps zurück ( nichts -> nein, 1 -> ja )integerEin optionaler Parameter, mit dem übergeben werden kann, ob die Formulardefinition mit übergeben werden soll.nein
date_queryNach welchem Datumstyp soll eingegrenzt werden (create, insert, complete)stringOptional. create ist der Standardnein
complete_bufferWie lange sollen nicht vollständige Formualre zurückgehalten werdenintegerOptional. Wert in Minuten. Hat nur Einfluss, wenn date_query = complete. Standard ist 0. Wird dauerhaft zurückgehalten.nein

Rückgabe

Es wird eine string zurück gegeben. Ansonsten wird bei einem Fehler ein "ERROR:Beschreibung" zurückgegeben

CSV Format

Metainformationen

TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1
KodierungUTF-8

Spalten

SpalteBeschreibung
DATEDatum im Format (YYYY-MM-DD HH:MM:SS)
VEHICLEFahrzeugkennzeichen
DRIVERFahrername (falls einer angemeldet war)
LATLatitude Koordinate(geographische Breite)
LONLongitude Koordinate (geographische Länge)
SATAnzahl Satelliten
IGNITIONZündung an(1) oder aus(0)
ENTRY1Wert von Eingabefeld 1
ENTRY2Wert von Eingabefeld 2
ENTRY3Wert von Eingabefeld 3
ENTRY4Wert von Eingabefeld 4
ENTRY5Wert von Eingabefeld 5
ENTRY6Wert von Eingabefeld 6
ENTRY7Wert von Eingabefeld 7
ENTRY8Wert von Eingabefeld 8
ENTRY9Wert von Eingabefeld 9
ENTRY10Wert von Eingabefeld 10
KMaktueller KM-Stand des Fahrzeuges bei Ausfüllen des Formulars
ORDERselbstdefinierte Auftragsnummer, falls das Formular einem Auftrag zugeordnet war
FORMName des Formulars/ wenn "show_desc" übergeben wurde,
wird die Formulardefinition über die Spalte FORM zurückgeliefert
VEHICLE_COST_CENTERKostenstelle des Fahrzeugs
DRIVER_MA_NUMBERMitarbeiter Nummer des Fahrers (nur gefüllt bei ReinerSCT Support)
RTI_IDENTRTI Ident des Fahrzeuges
TOURDATAselbstdefinierte Tournummern der Tour/des Ziels/der Sendung, falls das Formular einer Tour zugeordnet war
Format als JSON mit 
Unknown macro: {'tour'}
Wenn keine Referenz zu einer Tour besteht, ist dieses Feld null.
PARENT_IDWenn dieses Formular ein Elternformular ist, dann enthält dieses Feld einen Hash um alle untergeordneten Kindformulare zu finden.
PARENT_RELATIONWenn dieses Formular ein Kindformular ist, dann enthält dieses Feld den Hash des übergeordneten Elternformulares.
CUSTOM_IDEindeutige Identifikationsnummer des Formulars. Kann bei älteren Datensätzen NULL sein.

Beispiel

CSV-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";"CUSTOM_ID"
"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";"IDENT1";null;"22201eb2fd123df28156bc0c86e0aba2";"" ;"5"

CSV-Rückgabe-Format - 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";"CUSTOM_ID"  
"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";"IDENT1";null;"22201eb2fd123df28156bc0c86e0aba2";"";"6"  

JSON Format

Beispiel

JSON-Rückgabe-Format - ohne Parameter "show_desc":

[{
"date":"2013-03-28 09:29:17",
"customId": "7",
"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",
"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":"Unterformular",
  "vehicleCostCenter":"Kostenstelle XYZ",
  "driverMaNumber":"MA123456",
  "rtiIdent":"Ident1"
 }
]
 }]

JSON-Rückgabe-Format - mit Parameter "show_desc":

[{
"date":"2013-03-28 09:29:17",
"customId": "8",
   "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": [
        {
           "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
        }
 ]
},
"vehicleCostCenter":"Kostenstelle XYZ",
"driverMaNumber":"MA123456",
"rtiIdent":"Ident1",
   "childForms":[
 {
    "date":"2013-03-28 08:29:17",
  "customId": "7",
  "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

Die Parameter “form” und "custorder" werden ignoriert, wenn der Datentyp “json_v2” verwendet wird.

Beispiel

JSON-Rückgabe-Format - mit Parameter "show_desc":

[{
"date":"2019-11-26T10:51:39+01:00",
"customId": "9",
"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
  },
  {
   "id":10,
   "name":"Datum",
   "isMandatory":false,
   "type":"date",
   "value":"10.10.2010",
   "isIncomplete": false
  },
  {
   "id":11,
   "name":"Zeit",
   "isMandatory":false,
   "type":"time",
   "value":"11:11",
   "isIncomplete": false
  },
   {
   "id":12,
   "name":"Formular",
   "isMandatory":false,
   "type":"nestedForm",
   "value":[
      {
        "date":"2019-11-26T09:51:39+01:00",
       "customId": "7",        
       "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":"",
       "orderMeta":"",
       "tourData":null,
       "vehicleCostCenter":null,
       "rtiIdent":null,
       "formName":"Unterformular",
       "formDriverMandatory":false,
       "fields":[
          {
           "id":1,
           "name":"Textfeld",
           "isMandatory":false,
           "type":"t30",
           "value":"Text",
           "isIncomplete":false
          },
          {
           "id":2,
           "name":"Bild",
           "isMandatory":false,
           "type":"img",
           "value":null,
           "isIncomplete":false
          },
          {
           "id":3,
           "name":"Unterschrift",
           "isMandatory":false,
           "type":"sig",
           "value":null,
           "isIncomplete":false
          }
         ],
       "insertDate":"2019-11-26T09:53:39+01:00",
       "completeDate":"2019-11-26T09:53:39+01:00"
      }
   ],
   "isIncomplete": false
  }  ]}

Beispielaufrufe

Für ein Fahrzeug im August 2015 und Auftragsnummer 123456

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

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

Für alle Fahrzeuge am 01.08.2015 für Formular "Formular Name"

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