Wiki-Quellcode von get_report_list.php
Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | (((Inhaltsverzeichnis))) | ||
| 3 | {{toc/}} | ||
| 4 | |||
| 5 | 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. | ||
| 6 | |||
| 7 | (% class="box" %) | ||
| 8 | ((( | ||
| 9 | **Hinweis | ||
| 10 | **Wir empfehlen die Reporte im CSV-Format zu generieren, um sie standardisiert weiterzuverarbeiten. Die [[CSV Struktur der Reporte>>doc:YellowFox Remote Tracking Interface.Funktionen.Abfrageseiten.get_report_list\.php.CSV Struktur der Reporte.WebHome]] kann man unter diesem [[ Link >>doc:YellowFox Remote Tracking Interface.Funktionen.Abfrageseiten.get_report_list\.php.CSV Struktur der Reporte.WebHome]]einsehen | ||
| 11 | ))) | ||
| 12 | = Beschreibung = | ||
| 13 | **(% class="green mark" %)GET(%%) get_report_list.php****?company**=//COMPANY_RTIKEY//**&import**=//IMPORT_RTIKEY// | ||
| 14 | = Parameter = | ||
| 15 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 16 | |company|RTI Firmenschlüssel|string||ja | ||
| 17 | |import|RTI Importschlüssel|string||ja | ||
| 18 | |format|Rückgabeformat|string|'csv' oder 'json'. Standard bei Nichtangabe ist 'csv'.|nein | ||
| 19 | |||
| 20 | = Rückgabe = | ||
| 21 | Es wird eine Zeichenkette zurückgegeben. Bei einem Fehler wird der "**(% class="error" %)403 - Verboten: Zugriff verweigert.(%%)**" HTTP-Header gesendet.. | ||
| 22 | == CSV Format == | ||
| 23 | Bei einer korrekten Anfrage werden die Berichtsdaten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste | ||
| 24 | Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Danach folgen die Daten. | ||
| 25 | === Metainformationen === | ||
| 26 | |=Trennzeichen|Semikolon ( ; ) | ||
| 27 | |=Textbegrenzer|Doppeltes Hochkomma ( " ) | ||
| 28 | |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 29 | |=Header|Zeile 1 | ||
| 30 | |=Kodierung|UTF-8 | ||
| 31 | |||
| 32 | === Spalten === | ||
| 33 | |=Spalte|=Beschreibung | ||
| 34 | |REPORTNAME|Name der Berichtsvorlage | ||
| 35 | |REPORTRANGE_FROM|Auswertungszeitraum Beginn | ||
| 36 | |REPORTRANGE_TO|Auswertungszeitraum Ende | ||
| 37 | |CREATE_DATE|Erstellungsdatum | ||
| 38 | |REPORT_TYPE|Numerische Repräsentation des Berichtstyps: | ||
| 39 | ((( | ||
| 40 | * 1... Tagesfahrtenreport | ||
| 41 | * 2... Tagessummenreport | ||
| 42 | * 3... Tagesroutenreport | ||
| 43 | * 4... Betriebsstundenreport | ||
| 44 | * 5... Stillstandsreport | ||
| 45 | * 6... Temperaturschreiber | ||
| 46 | * 8... FMS/CAN - Fahrzeugvergleich | ||
| 47 | * 9... Zeiterfassung (alt) | ||
| 48 | * 10... Geschwindigkeitsreport | ||
| 49 | * 11... Tankreport | ||
| 50 | * 15... FMS/CAN - Fahrzeuganalyse | ||
| 51 | * 21... FMS/CAN - Fahrervergleich | ||
| 52 | * 22... Fahrerbewertung / Fahrstilanalyse | ||
| 53 | * 23... Gebiets-/KST-Auswertung | ||
| 54 | * 26... POI-Bericht | ||
| 55 | * 27... Tacho - Arbeitszeiten (alt) | ||
| 56 | * 29... Fahrer - Übergeschwindigkeiten | ||
| 57 | * 30... Spesenabrechnung | ||
| 58 | * 31... Telemetriereport | ||
| 59 | * 32... Zeiterfassung (neu) | ||
| 60 | * 34... Führerscheinkontrolle | ||
| 61 | * 35... Fahrzeugnutzung | ||
| 62 | * 36... Tacho - Arbeitszeiten (neu) | ||
| 63 | * 37... Tätigkeitsreport | ||
| 64 | * 38... Trailerreport | ||
| 65 | * 40... Tacho - Verstoßanalyse | ||
| 66 | * 43... Zeiterfassung - Monatsbericht | ||
| 67 | ))) | ||
| 68 | |FORMAT|Dateiformat, z.B. html, pdf, xls... | ||
| 69 | |DOWNLOADLINK|Link zu der generierten Datei | ||
| 70 | //Achtung: Besonders große Excel-Berichte sind möglicherweise in mehrere Dateien geteilt und werden als ZIP Archiv zurückgegeben!// | ||
| 71 | |||
| 72 | === JSON Format === | ||
| 73 | **Rückgabe JSON** | ||
| 74 | {{code language="java"}}[ | ||
| 75 | { | ||
| 76 | "reportname":"Zeiterfassung Werkstatt", | ||
| 77 | "reportrange_from":"2020-12-01 00:00:00", | ||
| 78 | "reportrange_to":"2020-12-31 23:59:59", | ||
| 79 | "create_date":"2021-01-01 07:04:53", | ||
| 80 | "report_type":26, | ||
| 81 | "format":"html", | ||
| 82 | "downloadlink":"map.yellowfox.de/rc.php?i=REPORT_IDENT" | ||
| 83 | } | ||
| 84 | ]{{/code}} | ||
| 85 | |||
| 86 | = Beispielaufrufe = | ||
| 87 | **Beispielaufruf im CSV Format** | ||
| 88 | {{code language="java"}}https://map.yellowfox.de/rti/get_report_list.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv{{/code}} | ||
| 89 | |||
| 90 | === Beispielantwort === | ||
| 91 | **Beispielantwort in CSV Format** | ||
| 92 | {{code language="java"}}"REPORTNAME";"REPORTRANGE_FROM";"REPORTRANGE_TO";"CREATE_DATE";"REPORT_TYPE";"FORMAT";"DOWNLOADLINK" | ||
| 93 | "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" | ||
| 94 | "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}} | ||
| 95 |