Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageen

Returns a list of all files, which was uploaded from digital tachograph or send from a display to the web portal.

Description

Status
colourGreen
titleGET
 get_file_list.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&file_type=digitacho&show=new&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS

Parameter

ParameterDescriptionTypeNoteMandatory
companyRTI company keystring
yes
vehicleRTI vehicle keystringchoose one of these parameters: vehicle, group or import(yes)
groupRTI group keystringchoose one of these parameters: vehicle, group or import(yes)
importRTI import keystringchoose 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
startBegin of the requested timespan (date type is changed by using date_type=process)datestring

Format: YYYYMMDDHHMMSS

no

endEnd 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

Seperatorsemicolon ( ; )
Text qualifierdouble quotes ( " )
Line end0x0D 0x0A (CarriageReturn LineFeed)
Headerline 1

Header

Code Block
titleHeader Informationen
"DID";"DATETIME";"NEW";"FILENAME","VEHICLE","TYPE";"DRIVERID";"DRIVERNAME";

Columns

ColumnDescription
DIDHash-identifier of the downloadable file (use for the download over RTI)
DATETIMECreation date of the file or processing date if the parameter "date_type" has the value "process"Format: YYYYMMDDHHMMSS
NEW1 - file is new, 0 - is already downloaded
FILENAMEfile name, the file has if you download it with the get_file.php function
VEHICLEidentifier of the vehicle where the file comes from
TYPEDRIVER (driver) or VEHICLE (vehicle) for digital tachograph files, SIGNATURE (signature) or PICTURE (picture) for picture files
DRIVERIDcard number of driver (first 13 token will be used)
DRIVERNAMEname of driver

Example

Code Block
titlereturn 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

Code Block
titlecall 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