Returns the list of all public reports of a company including the corresponding download links.
Description
GET get_report_list.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
Parameter
Parameter | Description | Type | Note | Mandatory |
---|---|---|---|---|
company | RTI company key | string | yes | |
import | RTI import key | string | yes | |
format | response format | string | 'csv' or'json'. Default is 'csv'. | no |
Return
A character string is returned. On error "403 - forbidden: access denied." http-header will be sent.
CSV format
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.
Meta information
Separator | semicolon ( ; ) |
---|---|
Text delimiter | double quotes ( " ) |
Line end | 0x0D 0x0A (CarriageReturn LineFeed) |
Header | line 1 |
Encoding | UTF-8 |
Columns
Column | Description |
---|---|
REPORTNAME | name of report draft |
REPORTRANGE_FROM | report range start |
REPORTRANGE_TO | report range end |
CREATE_DATE | create date |
REPORT_TYPE | numeric representation of report type: 1... daily usage report |
FORMAT | file format, e.g. html, pdf, xls... |
DOWNLOADLINK | link to generated file Attention: Large Excel reports might be splitted into multiple files and will be returned as ZIP archive! |
JSON format
[ { "reportname":"Zeiterfassung Werkstatt", "reportrange_from":"2020-12-01 00:00:00", "reportrange_to":"2020-12-31 23:59:59", "create_date":"2021-01-01 07:04:53", "report_type":26, "format":"html", "downloadlink":"map.yellowfox.de/rc.php?i=REPORT_IDENT" } ]
Example calls
https://map.yellowfox.de/rti/get_report_list.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv
Example response
"REPORTNAME";"REPORTRANGE_FROM";"REPORTRANGE_TO";"CREATE_DATE";"REPORT_TYPE";"FORMAT";"DOWNLOADLINK" "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" "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"