Wiki-Quellcode von get_file_list.php
Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | (((Inhaltsverzeichnis))) | ||
| 3 | {{toc/}} | ||
| 4 | |||
| 5 | Gibt eine Liste Dateien aus, welche vom Digitacho heruntergeladen wurden oder über ein Display an das Portal geschickt wurden. | ||
| 6 | = Beschreibung = | ||
| 7 | **(% class="green mark" %)GET(%%) get_file_list.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&file_type**=digitacho**&show**=new**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS// | ||
| 8 | = Parameter = | ||
| 9 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 10 | |company|RTI Firmenschlüssel|string||ja | ||
| 11 | |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group Parameter|(ja) | ||
| 12 | |group|RTI Gruppenschlüssel|string|oder|(ja) | ||
| 13 | |import|RTI Importschlüssel|string|import Parameter für alle Fahrzeuge|(ja) | ||
| 14 | |file_type|Der Typ der Dateien, die angezeigt werden sollen. | ||
| 15 | "digitacho" - Fahrerkartendateien | ||
| 16 | "picture" - über Displays hochgeladene Bilder | ||
| 17 | "signature" - über Formulare hochgeladene Unterschriften|string||ja | ||
| 18 | |show|'all': zeigt alle Dateien an | ||
| 19 | 'new': zeigt nur noch nicht heruntergeladene Dateien an|string||ja | ||
| 20 | |start|Anfang des Abfragezeitraum (Datumstyp ändert sich bei Verwendung von date_type=process)|datestring|Format: YYYYMMDDHHMMSS|nein | ||
| 21 | |end|Ende des Abfragezeitraum (Datumstyp ändert sich bei Verwendung von date_type=process)|datestring|Format: YYYYMMDDHHMMSS|nein | ||
| 22 | |date_type|'process' Nutzt das Datum zu dem die Datei bei YellowFox verarbeitet wurden und nicht das | ||
| 23 | Datum an dem die Datei erzeugt wurde. Diese Einstellung hat Auswirkung auf die Bedeutung | ||
| 24 | der Parameter 'start' und 'end' und auf den Rückgabewert DATETIME im CSV|string||nein | ||
| 25 | |||
| 26 | = Rückgabe = | ||
| 27 | Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben. | ||
| 28 | == CSV Format == | ||
| 29 | === Metainformationen === | ||
| 30 | |=Trennzeichen|Semikolon ( ; ) | ||
| 31 | |=Textbegrenzer|Doppeltes Hochkomma ( " ) | ||
| 32 | |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 33 | |=Header|Zeile 1 | ||
| 34 | |||
| 35 | === Header === | ||
| 36 | **Header Informationen** | ||
| 37 | {{code language="java"}}"DID";"DATETIME";"NEW";"FILENAME","VEHICLE","TYPE";"DRIVERID";"DRIVERNAME";"IDENT";"ARCHIVEDAT";"CONTENTFROM";"CONTENTTO";{{/code}} | ||
| 38 | |||
| 39 | === Spalten === | ||
| 40 | |=Spalte|=Beschreibung|= | ||
| 41 | |DID|Hash-Bezeichner der Downloaddatei (wichtig für den Download via RTI)| | ||
| 42 | |DATETIME|Erstellungsdatum der Datei oder Verarbeitungsdatum, falls parameter 'date_type' gesetzt ist und den Wert 'process' hat.|Format: YYYYMMDDHHMMSS | ||
| 43 | |NEW|1 - steht für neu, 0 - für bereits heruntergeladen| | ||
| 44 | |FILENAME|Dateiname, mit dem die Datei über die get_file-Funktion ausgegeben werden kann| | ||
| 45 | |VEHICLE|Fahrzeugkennzeichen von welchem Fahrzeug die Datei stammt| | ||
| 46 | |TYPE|DRIVER (Fahrer) oder VEHICLE (Fahrzeug) für Digitacho Dateien, SIGNATURE (Unterschrift) bzw. PICTURE (Bild) für Bilddateien| | ||
| 47 | |DRIVERID|Kartennummer des Fahrers (ohne fortlaufende Nummer 001, 002,...)| | ||
| 48 | |DRIVERNAME|Name des Fahrers| | ||
| 49 | |IDENT|Nutzerdefinierter RTI Ident des Fahrzeugs, welches die Datei gesendet hat| | ||
| 50 | |ARCHIVEDAT|Verarbeitungsdatum der Datei im YellowFox Rechenzentrum|Format: YYYYMMDDHHMMSS | ||
| 51 | |CONTENTFROM|für DDD Dateien: 1. Tag mit einer aufgezeichneten Aktivität|Format: YYYYMMDD | ||
| 52 | |CONTENTTO|für DDD Dateien: letzter Tag mit einer aufgezeichneten Aktivität|Format: YYYYMMDD | ||
| 53 | |||
| 54 | === Beispiel === | ||
| 55 | **Rückgabe** | ||
| 56 | {{code language="java"}}digitacho: | ||
| 57 | "DID";"DATETIME";"NEW";"FILENAME";"VEHICLE";"TYPE";"DRIVERID";"DRIVERNAME";"IDENT";"ARCHIVEDAT";"CONTENTFROM";"CONTENTTO"; | ||
| 58 | "28a2fe18ab7fcb2079dacf75bd1ccb62";"20120725001100";"1";"C_20120725_0011_Slot_1_1000000000000.DDD";"DD-YF 2012";"DRIVER";"1000000000000";"Testfahrer";"YF-RTI-123";"20120725001130";"20111021";"20120724"; | ||
| 59 | "1658d0cac3451b7dbaf00f7229e5775a";"20120725144700";"0";"M_20120725_1447__DD-YF_2012___WDB324865L2222229.DDD";"DD-YF 2012";"VEHICLE";"";"";""YF-RTI-123";"20120725144720";"20120720";"20120725" | ||
| 60 | |||
| 61 | picture/signature | ||
| 62 | "DID";"DATETIME";"NEW";"FILENAME";"VEHICLE";"TYPE";"DRIVERID";"DRIVERNAME";"IDENT";"ARCHIVEDAT";"CONTENTFROM";"CONTENTTO"; | ||
| 63 | "28a2fe18ab7fcb2079dacf75bd1ccb62";"20120725001100";"1";"28a2fe18ab7fcb2079dacf75bd1ccb62.jpg";"DD-YF 2012";"PICTURE";"1000000000000";"Testfahrer";"YF-RTI-123";"20120725001200";"";""; | ||
| 64 | "1658d0cac3451b7dbaf00f7229e5775a";"20120725144700";"0";"1658d0cac3451b7dbaf00f7229e5775a.jpg";"DD-YF 2012";"PICTURE";"";"";"YF-RTI-123";"20120725164300";"";"";{{/code}} | ||
| 65 | |||
| 66 | = Beispielaufrufe = | ||
| 67 | **Aufruf zum Abrufen der Liste** | ||
| 68 | {{code language="java"}}https://map.yellowfox.de/rti/get_file_list.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&file_type=digitacho&show=new&start=20180101120000&end=20180131120000 | ||
| 69 | |||
| 70 | https://map.yellowfox.de/rti/get_file_list.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&file_type=digitacho&show=new&start=20180101120000&end=20180131120000{{/code}} | ||
| 71 |