Wiki-Quellcode von get_d8_bookings.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 | (% class="box" %) | ||
| 6 | ((( | ||
| 7 | **Kompatibilität | ||
| 8 | **Damit diese Funktion nutzbar ist, muss mindestens ein Fahrzeug mit aktivierter D8 Info Schnittstelle vorhanden sein. | ||
| 9 | ))) | ||
| 10 | |||
| 11 | Gibt alle Buchungen der D8 Schnittstelle zurück. | ||
| 12 | Vorraussetzung ist neben der aktivierten RTI Schnittstelle ein RTI Schlüssel für die betreffenden Fahrzeuge! | ||
| 13 | = Beschreibung = | ||
| 14 | **(% class="green mark" %)GET(%%) **get_d8_bookings.php?**company**=COMPANY_RTIKEY**&import**=//COMPANY_IMPORTKEY//**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS//**&format**=//CSV// | ||
| 15 | = Parameter = | ||
| 16 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 17 | |company|RTI Firmenschlüssel|string||ja | ||
| 18 | |import|RTI Importschlüssel|string|entweder import, vehicle oder group Parameter|(ja) | ||
| 19 | |vehicle|RTI Fahrzeugschlüssel|string|entweder import, vehicle oder group Parameter|(ja) | ||
| 20 | |group|RTI Gruppenschlüssel|string|entweder import, vehicle oder group Parameter|(ja) | ||
| 21 | |start|Startzeitpunkt der Ausgabe|string|der Ausgabezeitraum darf maximal 31 Tage umfassen|ja | ||
| 22 | |end|Endzeitpunkt der Ausgabe|string|der Ausgabezeitraum darf maximal 31 Tage umfassen|ja | ||
| 23 | |format|Ausgabeformat|string|zulässige Ausgabeformate | ||
| 24 | ((( | ||
| 25 | * csv | ||
| 26 | * json | ||
| 27 | )))|ja | ||
| 28 | |||
| 29 | Rückgabewerte | ||
| 30 | Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)". | ||
| 31 | == JSON Format == | ||
| 32 | Gibt einen JSON Formatierten Text zurück mit den angegebenen Details zu jeder Buchung. | ||
| 33 | === Beispiel Ausgabe === | ||
| 34 | **Ausgabe in JSON** | ||
| 35 | {{code language="js"}}[ | ||
| 36 | { | ||
| 37 | "date": "2020-03-01T02:25:04+01:00", | ||
| 38 | "vehicle": "YF1234", | ||
| 39 | "ignition": 0, | ||
| 40 | "lat": 51.04, | ||
| 41 | "lon": 13.6, | ||
| 42 | "key": "DF47110815123000", | ||
| 43 | "eventtype": 1, | ||
| 44 | "state": 0, | ||
| 45 | "eventid": "CF1C6C0DA98DC17B48B7C4C7DD3F0EE428EF9A61" | ||
| 46 | }, | ||
| 47 | { | ||
| 48 | "date": "2020-03-01T02:25:24+01:00", | ||
| 49 | "vehicle": "YF1234", | ||
| 50 | "ignition": 0, | ||
| 51 | "lat": 51.04, | ||
| 52 | "lon": 13.6, | ||
| 53 | "key": null, | ||
| 54 | "eventtype": 3, | ||
| 55 | "state": 1, | ||
| 56 | "eventid": "EF8F2B94F43228F8F6151D050413E5D9BEFBDE96" | ||
| 57 | } | ||
| 58 | ]{{/code}} | ||
| 59 | |||
| 60 | == CSV Format == | ||
| 61 | Das CSV Format enthält eine Zeile pro Buchung mit allen jeweils vorhandenen Informationen. | ||
| 62 | === Metainformationen === | ||
| 63 | |=Trennzeichen|Semikolon ( ; ) | ||
| 64 | |=Textbegrenzer|Doppeltes Hochkomma ( " ) | ||
| 65 | |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 66 | |=Header|Zeile 1 | ||
| 67 | |=Kodierung|Windows-1252 | ||
| 68 | |||
| 69 | === CSV Spalten === | ||
| 70 | |=Spalte|=Beschreibung|= | ||
| 71 | |DATE|Datum und Zeit vom Fahrtenschreiber|Datum und Zeit im Format ISO 8601 | ||
| 72 | |VEHICLE|selbstdefinierte RTI Fahrzeug ID | ||
| 73 | (ist kein separater RTI Bezeichner vergeben, wird das Fahrzeugkennzeichen verwendet)| | ||
| 74 | |IGNITION|Zündungsstatus laut Tachograph|1: Zündung aktiv | ||
| 75 | 0: Zündung aus | ||
| 76 | |LAT|Latitude| | ||
| 77 | |LON|Longitude| | ||
| 78 | |KEY|Fahrerschlüssel zur Buchung| | ||
| 79 | |EVENTTYPE|Ereignisklasse|0: Kartenaktivität im 1. Slot | ||
| 80 | 1: Kartenaktivität im 2. Slot | ||
| 81 | 2: Tätigkeitsbuchung im 1. Slot | ||
| 82 | 3: Tätigkeitsbuchung im 2. Slot | ||
| 83 | |STATE|Statuswert zum Event|Event 0/1: | ||
| 84 | 0: Kartenauswurf | ||
| 85 | 1:Karteneinschub | ||
| 86 | Event 2/3: | ||
| 87 | 0: Pause- oder Ruhezeit | ||
| 88 | 1: Bereitschaftszeit | ||
| 89 | 2: Arbeitszeit | ||
| 90 | 3: Lenkzeit | ||
| 91 | |EVENTID|Eindeutiger Hash zur Buchung | ||
| 92 | (Ermöglicht die Erkennung von Dopplungen bei überlappenden Zeiträumen)| | ||
| 93 | |||
| 94 | === Beispiel Ausgabe === | ||
| 95 | **Ausgabe in CSV** | ||
| 96 | {{code language="java"}}"DATE";"VEHICLE";"IGNITION";"LAT";"LON";"KEY";"EVENTTYPE";"STATE","EVENTID" | ||
| 97 | "2020-03-01T02:25:04+01:00";"YF1234";1;51.04;13.6;"DF47110815123000";1;0;"CF1C6C0DA98DC17B48B7C4C7DD3F0EE428EF9A61" | ||
| 98 | "2020-03-01T02:25:24+01:00";"YF1234";0;51.04;13.6;"DF47110815123000";3;1;"EF8F2B94F43228F8F6151D050413E5D9BEFBDE96"{{/code}} | ||
| 99 | |||
| 100 | = Beispielaufrufe = | ||
| 101 | |||
| 102 | **Abruf der Buchungen im CSV Format** | ||
| 103 | {{code language="java"}}https://map.yellowfox.de/rti/get_d8_bookings.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&start=20200302000000&end=20200305235959&format=CSV{{/code}} | ||
| 104 |