Wiki source code of get_report_list.php

Last modified by YellowFox_RD on 2024/12/19 10:11
Show last authors
1 (% class="box" %)
2 (((Table of Contents)))
3 {{toc/}}
4
5 Returns the list of all public reports of a company including the corresponding download links.
6 = Description =
7 ****(% class="green mark" %)GET(%%) **get_report_list.php****?company**=//COMPANY_RTIKEY//**&import**=//IMPORT_RTIKEY//
8 = Parameter =
9 |=Parameter|=Description|=Type|=Note|=Mandatory
10 |company|RTI company key|string||yes
11 |import|RTI import key|string||yes
12 |format|response format|string|'csv' or'json'. Default is 'csv'.|no
13
14 = Return =
15 A character string is returned. On error "**(% class="error" %)403 - forbidden: access denied.(%%)**" http-header will be sent.
16 == CSV format ==
17 On a correct request the report data will be sent as CSV (comma separated value). First line is the header with column names. Data is follwoing afterwards.
18 === Meta information ===
19 |=Separator|semicolon ( ; )
20 |=Text delimiter|double quotes ( " )
21 |=Line end|0x0D 0x0A (CarriageReturn LineFeed)
22 |=Header|line 1
23 |=Encoding|UTF-8
24
25 === Columns ===
26 |=Column|=Description
27 |REPORTNAME|name of report draft
28 |REPORTRANGE_FROM|report range start
29 |REPORTRANGE_TO|report range end
30 |CREATE_DATE|create date
31 |REPORT_TYPE|numeric representation of report type:
32 1... daily usage report
33 2... daily total usage report
34 3... routes driven
35 4... hours of operation report
36 5... idle report
37 6... analog inputs
38 8... FMS/CAN - object comparison
39 9... timerecording (old)
40 10... speed report
41 11... fuel report
42 12... private drive report
43 15... FMS/CAN - object report
44 21... FMS/CAN - driver comparison
45 22... driver behaviour/ driving analysis
46 23... area-/cc-report
47 24... temperature recorder
48 25... insurance report
49 26... POI-report
50 27... tacho - timerecording (old)
51 29... driver - overspeed
52 30... expense report
53 31... telemetry report
54 32... timerecording (new)
55 34... driving license check
56 35... vehicle usage
57 36... tacho - timerecording (new)
58 37... activity report
59 38... trailer report
60 |FORMAT|file format, e.g. html, pdf, xls...
61 |DOWNLOADLINK|link to generated file
62 //Attention: Large Excel reports might be splitted into multiple files and will be returned as ZIP archive!//
63
64 === JSON format ===
65 **return json**
66 {{code language="java"}}[
67 {
68 "reportname":"Zeiterfassung Werkstatt",
69 "reportrange_from":"2020-12-01 00:00:00",
70 "reportrange_to":"2020-12-31 23:59:59",
71 "create_date":"2021-01-01 07:04:53",
72 "report_type":26,
73 "format":"html",
74 "downloadlink":"map.yellowfox.de/rc.php?i=REPORT_IDENT"
75 }
76 ]{{/code}}
77
78 = Example calls =
79 **example call in csv**
80 {{code language="java"}}https://map.yellowfox.de/rti/get_report_list.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv{{/code}}
81
82 === Example response ===
83 **example response in csv**
84 {{code language="java"}}"REPORTNAME";"REPORTRANGE_FROM";"REPORTRANGE_TO";"CREATE_DATE";"REPORT_TYPE";"FORMAT";"DOWNLOADLINK"
85 "Zeiterfassung Werkstatt";"2020-12-01 00:00:00";"2020-12-31 23:59:59";"2021-01-01 07:04:53";"32";"html";"map.yellowfox.de/rc.php?i=REPORT_IDENT"
86 "tägliche Serie POI-Bericht";"2020-12-25 00:00:00";"2020-12-31 23:59:59";"2021-01-01 07:09:20";"26";"pdf";"map.yellowfox.de/rc.php?i=REPORT_IDENT"{{/code}}
87