get_file_list.php
Table of Contents
Returns a list of all files, which was uploaded from digital tachograph or send from a display to the web portal.
Description
GET get_file_list.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&file_type=digitacho&show=new&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS
Parameter
| Parameter | Description | Type | Note | Mandatory |
|---|---|---|---|---|
| company | RTI company key | string | yes | |
| vehicle | RTI vehicle key | string | choose one of these parameters: vehicle, group or import | (yes) |
| group | RTI group key | string | choose one of these parameters: vehicle, group or import | (yes) |
| import | RTI import key | string | choose one of these parameters: vehicle, group or import | (yes) |
| file_type | Type of files, which should be shown "digitacho" - digital tachograph files "picture" - pictures, which was uploaded from display "signature" - signatures, which was uploaded from display | string | yes | |
| show | 'all': shows all files 'new': shows all files which was not marked as downloaded yet | string | yes | |
| start | Begin of the requested timespan (date type is changed by using date_type=process) | datestring | Format: YYYYMMDDHHMMSS | no |
| end | End of the requested timespan (date type is changed by using date_type=process) | datestring | Format: YYYYMMDDHHMMSS | no |
| date_type | 'process'uses the date when the file was processed by YellowFox and not the date when the file was created. This parameter has impact for the meaning of the options 'start' and 'end' and the return value DATETIME in the CSV result. | string | no |
Return
The return is a string. If an error happens, "ERROR:Description" is returned.
CSV format
Metainformation
| Seperator | semicolon ( ; ) |
|---|---|
| Text qualifier | double quotes ( " ) |
| Line end | 0x0D 0x0A (CarriageReturn LineFeed) |
| Header | line 1 |
Header
Header Informationen
"DID";"DATETIME";"NEW";"FILENAME","VEHICLE","TYPE";"DRIVERID";"DRIVERNAME";
Columns
| Column | Description | |
|---|---|---|
| DID | Hash-identifier of the downloadable file (use for the download over RTI) | |
| DATETIME | Creation date of the file or processing date if the parameter "date_type" has the value "process" | Format: YYYYMMDDHHMMSS |
| NEW | 1 - file is new, 0 - is already downloaded | |
| FILENAME | file name, the file has if you download it with the get_file.php function | |
| VEHICLE | identifier of the vehicle where the file comes from | |
| TYPE | DRIVER (driver) or VEHICLE (vehicle) for digital tachograph files, SIGNATURE (signature) or PICTURE (picture) for picture files | |
| DRIVERID | card number of driver (first 13 token will be used) | |
| DRIVERNAME | name of driver |
Example
return in CSV
digitacho:
"DID";"DATETIME";"NEW";"FILENAME";"VEHICLE";"TYPE";"DRIVERID";"DRIVERNAME"
"28a2fe18ab7fcb2079dacf75bd1ccb62";"20120725001100";"1";"C_20120725_0011_Slot_1_1000000000000.DDD";"DD-YF 2012";"DRIVER";"1000000000000";"Testfahrer"
"1658d0cac3451b7dbaf00f7229e5775a";"20120725144700";"0";"M_20120725_1447__DD-YF_2012___WDB324865L2222229.DDD";"DD-YF 2012";"VEHICLE";"";""
picture/signature:
"DID";"DATETIME";"NEW";"FILENAME";"VEHICLE";"TYPE";"DRIVERID";"DRIVERNAME"
"28a2fe18ab7fcb2079dacf75bd1ccb62";"20120725001100";"1";"28a2fe18ab7fcb2079dacf75bd1ccb62.jpg";"DD-YF 2012";"PICTURE";"1000000000000";"Testfahrer"
"1658d0cac3451b7dbaf00f7229e5775a";"20120725144700";"0";"1658d0cac3451b7dbaf00f7229e5775a.jpg";"DD-YF 2012";"PICTURE";"";""
Example call
call to retrieve the list
https://map.yellowfox.de/rti/get_file_list.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&file_type=digitacho&show=new&start=20180101120000&end=20180131120000
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