Wiki source code of get_file_list.php

Last modified by YellowFox_RD on 2025/01/23 10:30

version	line-number	content
1.1	1	(% class="box" %)
2.1	2	(((
	3	Table of Contents
	4	)))
	5
1.1	6	{{toc/}}
	7
2.1	8	Returns a list of all files, which was uploaded from digital tachograph or send from a display to the web portal.
	9
	10	= Description =
	11
	12	(% class="green mark" %)GET(%%) get_file_list.php?company=//COMPANY_RTIKEY//&vehicle=//VEHICLE_RTIKEY//&file_type=digitacho&show=new&start=//YYYYMMDDHHMMSS//&end=//YYYYMMDDHHMMSS//
	13
1.1	14	= Parameter =
	15
2.1	16	\|=Parameter\|=Description\|=Type\|=Note\|=Mandatory
	17	\|company\|RTI company key\|string\| \|yes
	18	\|vehicle\|RTI vehicle key\|string\|choose one of these parameters: vehicle, group or import\|(yes)
	19	\|group\|RTI group key\|string\|choose one of these parameters: vehicle, group or import\|(yes)
	20	\|import\|RTI import key\|string\|choose one of these parameters: vehicle, group or import\|(yes)
	21	\|file_type\|Type of files, which should be shown
	22	"digitacho" - digital tachograph files
	23	"picture" - pictures, which was uploaded from display
	24	"signature" - signatures, which was uploaded from display\|string\| \|yes
	25	\|show\|'all': shows all files
	26	'new': shows all files which was not marked as downloaded yet\|string\| \|yes
	27	\|start\|Begin of the requested timespan (date type is changed by using date_type=process)\|datestring\|Format: YYYYMMDDHHMMSS\|no
	28	\|end\|End of the requested timespan (date type is changed by using date_type=process)\|datestring\|Format: YYYYMMDDHHMMSS\|no
	29	\|date_type\|'process'uses the date when the file was processed by YellowFox and not the date
	30	when the file was created. This parameter has impact for the meaning of the options
	31	'start' and 'end' and the return value DATETIME in the CSV result.\|string\| \|no
1.1	32
2.1	33	= Return =
	34
	35	The return is a string. If an error happens, "(% class="error" %)ERROR:Description(%%)" is returned.
	36
	37	== CSV format ==
	38
	39	=== Metainformation ===
	40
	41	\|=Seperator\|semicolon ( ; )
	42	\|=Text qualifier\|double quotes ( " )
	43	\|=Line end\|0x0D 0x0A (CarriageReturn LineFeed)
	44	\|=Header\|line 1
	45
1.1	46	=== Header ===
2.1	47
1.1	48	Header Informationen
2.1	49	\\{{code language="java"}}"DID";"DATETIME";"NEW";"FILENAME","VEHICLE","TYPE";"DRIVERID";"DRIVERNAME";{{/code}}
1.1	50
2.1	51	=== Columns ===
1.1	52
2.1	53	\|=Column\|=Description\|=
	54	\|DID\|Hash-identifier of the downloadable file (use for the download over RTI)\|
	55	\|DATETIME\|Creation date of the file or processing date if the parameter "date_type" has the value "process"\|Format: YYYYMMDDHHMMSS
	56	\|NEW\|1 - file is new, 0 - is already downloaded\|
	57	\|FILENAME\|file name, the file has if you download it with the get_file.php function\|
	58	\|VEHICLE\|identifier of the vehicle where the file comes from\|
	59	\|TYPE\|DRIVER (driver) or VEHICLE (vehicle) for digital tachograph files, SIGNATURE (signature) or PICTURE (picture) for picture files\|
	60	\|DRIVERID\|card number of driver (first 13 token will be used)\|
	61	\|DRIVERNAME\|name of driver\|
1.1	62
2.1	63	=== Example ===
1.1	64
2.1	65	return in CSV
	66	\\{{code language="java"}}digitacho:
	67	"DID";"DATETIME";"NEW";"FILENAME";"VEHICLE";"TYPE";"DRIVERID";"DRIVERNAME"
	68	"28a2fe18ab7fcb2079dacf75bd1ccb62";"20120725001100";"1";"C_20120725_0011_Slot_1_1000000000000.DDD";"DD-YF 2012";"DRIVER";"1000000000000";"Testfahrer"
	69	"1658d0cac3451b7dbaf00f7229e5775a";"20120725144700";"0";"M_20120725_1447__DD-YF_2012___WDB324865L2222229.DDD";"DD-YF 2012";"VEHICLE";"";""
1.1	70
2.1	71	picture/signature:
	72	"DID";"DATETIME";"NEW";"FILENAME";"VEHICLE";"TYPE";"DRIVERID";"DRIVERNAME"
	73	"28a2fe18ab7fcb2079dacf75bd1ccb62";"20120725001100";"1";"28a2fe18ab7fcb2079dacf75bd1ccb62.jpg";"DD-YF 2012";"PICTURE";"1000000000000";"Testfahrer"
	74	"1658d0cac3451b7dbaf00f7229e5775a";"20120725144700";"0";"1658d0cac3451b7dbaf00f7229e5775a.jpg";"DD-YF 2012";"PICTURE";"";""{{/code}}
	75
	76	= Example call =
	77
	78	call to retrieve the list
	79	\\{{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
	80
1.1	81	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}}
	82