get_report_list.php
Inhaltsverzeichnis
Gibt die Liste aller öffentlich verfügbaren Berichte einer Firma inklusive des Downloadlinks zurück. Von Yellowfox berechnet Berichte liegen für den Abruf 7 Tage ab Generierung bereit.
Hinweis
Wir empfehlen die Reporte im CSV-Format zu generieren, um sie standardisiert weiterzuverarbeiten. Die CSV Struktur der Reporte kann man unter diesem Link einsehen
Beschreibung
GET get_report_list.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| import | RTI Importschlüssel | string | ja | |
| format | Rückgabeformat | string | 'csv' oder 'json'. Standard bei Nichtangabe ist 'csv'. | nein |
Rückgabe
Es wird eine Zeichenkette zurückgegeben. Bei einem Fehler wird der "403 - Verboten: Zugriff verweigert." HTTP-Header gesendet..
CSV Format
Bei einer korrekten Anfrage werden die Berichtsdaten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste
Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Danach folgen die Daten.
Metainformationen
| Trennzeichen | Semikolon ( ; ) |
|---|---|
| Textbegrenzer | Doppeltes Hochkomma ( " ) |
| Zeilenende | 0x0D 0x0A (CarriageReturn LineFeed) |
| Header | Zeile 1 |
| Kodierung | UTF-8 |
Spalten
| Spalte | Beschreibung |
|---|---|
| REPORTNAME | Name der Berichtsvorlage |
| REPORTRANGE_FROM | Auswertungszeitraum Beginn |
| REPORTRANGE_TO | Auswertungszeitraum Ende |
| CREATE_DATE | Erstellungsdatum |
| REPORT_TYPE | Numerische Repräsentation des Berichtstyps:
|
| FORMAT | Dateiformat, z.B. html, pdf, xls... |
| DOWNLOADLINK | Link zu der generierten Datei Achtung: Besonders große Excel-Berichte sind möglicherweise in mehrere Dateien geteilt und werden als ZIP Archiv zurückgegeben! |
JSON Format
Rückgabe JSON
[
{
"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"
}
]
Beispielaufrufe
Beispielaufruf im CSV Format
https://map.yellowfox.de/rti/get_report_list.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv
Beispielantwort
Beispielantwort in CSV Format
"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"