get_timerecording.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:37

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
Beispiele

Kompatibilität
Diese Funktion ist nur für Kunden mit aktivierter Zeiterfassung V3 verfügbar.
Kunden mit der bisherigen Zeiterfassung nutzen bitte weiterhin die Funktion get_timerecording.asp

Gibt alle empfangenen Zeiterfassungsbuchungen des abgefragten Zeitraumes zurück. Der Zeitraum kann dabei entweder nach Eingang der Buchungen oder gebuchter Zeit gewählt werden.
Falls die Zeiterfassungsbuchungen aus den Digitacho Dateien erstellt werden ist zu beachten, das es zu Verzögerungen kommt. Es muss erst die jeweilige Datei vom Fahrzeug heruntergeladen werden und danach noch exportiert werden. Dies kann zu mehreren Stunden, eventuell sogar Tagen, Verzögerung führen. Deshalb wird auch standardmäßig das Verarbeitungsdatum verwendet, damit ein chronologischer Datenabruf ohne Lücken oder Dopplungen möglich ist.

Beschreibung

GET get_timerecording.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&format=CSV&version=1&date_query=insert

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
import	RTI Importschlüssel	string		ja
start	Startzeitpunkt der Ausgabe	string	der Ausgabezeitraum darf maximal 31 Tage umfassen	ja
end	Endzeitpunkt der Ausgabe	string	der Ausgabezeitraum darf maximal 31 Tage umfassen	ja
format	Ausgabeformat	string	zulässige Ausgabeformate csv json xml buspronet gfos	ja
version	Versionsnummer der Abfrage	integer	aktuell ist Version 1 sollte sich das Ausgabeformat ändern wird jeweils eine neue Versionsnummer vergeben	nein
date_query	Welches Datum bildet die Grundlage für die Zeitraumeingrenzung	string	'insert' (Standard) = Verarbeitungsdatum 'gps' = Datum an dem die Zeitbuchung stattgefunden hat (in Verbindung mit 'with_changes=1', werden geänderte Buchungszeiten mit beachtet) 'update' = NUR in Verbindung mit 'with_changes=1', allgemeine Rückgabe wie 'insert', wurde eine Buchung bearbeitet, zählt aber das Bearbeitungsdatum	nein
group	Bezeichnung der Personalgruppe, auf welche eingegrenzt werden soll	string	Es muss die exakte Bezeichnung einer Personalgruppe angegeben werden	nein
with_changes	Gibt an, ob portalseitige Bearbeitungen von Buchungen mit beachtet werden sollen. Im Portal gelöschte Buchungen werden dann auch nicht ausgegeben	integer	0 (Standard) - die Buchungen werden immer so ausgegeben, wie ursprünglich erfasst 1 - Die Buchungen werden inklusive der Änderungen ausgegeben (wie im Portal)	nein

Rückgabe

Es wird ein string zurückgegeben. Im Fehlerfall wird "ERROR:Beschreibung".

JSON Format

Gibt einen JSON Formatierten Text zurück mit den angegebenen Details zu jeder Buchung.

Beispiel Ausgabe

JSON Ausgabe
[
    {
       "person": {
           "id": "A23",
           "key": "DF00000001234",
           "name": "Max Mustermann",
           "card_nr": null
        },
       "datetime": "2019-04-01 05:26:00",
       "activity": {
           "id": "1003",
           "name": "Arbeitszeit"
        },
       "terminal": {
"id": "M_123",
"name": "DD-YF 456"
}
       "position": {
           "lat": 51.4,
           "lon": 13.1,
           "address": "Am Wüsteberg 3, 01723 Kesselsdorf"
        },
       "area": null,
       "costcenter": {
           "id": null,
           "name": null
        }
    },
    {
       "person": {
           "id": "A23",
           "key": "DF00000001234",
           "name": "Max Mustermann",
           "card_nr": null
        },
       "datetime": "2019-04-01 12:35:00",
       "activity": {
           "id": "1001",
           "name": "Pause"
        },
       "terminal": {
"id": "F_17",
"name": "Büro",
       "position": {
           "lat": 52.0,
           "lon": 11.9,
           "address": "Am Wüsteberg 3, 01723 Kesselsdorf"
        },
       "area": null,
       "costcenter": {
           "id": "K-47",
           "name": "allgemeines"
        }
    }

XML Format

XML Ausgabe
<?xml version="1.0"?>
<bookings>
   <booking>
       <person>
           <id/>
           <key>DF00000001234</key>
           <name>Max Mustermann</name>
           <card_nr/>
       </person>
       <datetime>2019-04-01 05:26:00</datetime>
       <activity>
           <id>1003</id>
           <name>Arbeitszeit</name>
       </activity>
       <terminal>
<id>M_123</id>
<name>DD-YF 456</name>
</terminal>
       <position>
           <lat>51.0</lat>
           <lon>13.1</lon>
           <address>Am Wüsteberg 3, 01723 Kesselsdorf</address>
       </position>
       <area/>
       <costcenter>
           <id/>
           <name/>
       </costcenter>
   </booking>
   <booking>
       <person>
           <id/>
           <key>DF00000001234</key>
           <name>Max Mustermann</name>
           <card_nr/>
       </person>
       <datetime>2019-04-01 12:35:00</datetime>
       <activity>
           <id>1001</id>
           <name>Pause</name>
       </activity>
       <terminal>
<id>F_17</id>
<name>Büro</name>
</terminal>
       <position>
           <lat>52.3</lat>
           <lon>11.09</lon>
           <address>Am Wüsteberg 3, 01723 Kesselsdorf</address>
       </position>
       <area/>
       <costcenter>
           <id>K-47</id>
           <name>allgemeines</name>
       </costcenter>
   </booking>
</bookings>

CSV Format

Das CSV Format enthält eine Zeile pro Buchung mit allen jeweils vorhandenen Informationen.

Metainformationen

Trennzeichen	Semikolon ( ; )
Textbegrenzer	Doppeltes Hochkomma ( " )
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1
Kodierung	Windows-1252

CSV Spalten

Spalte	Beschreibung
PERSON_ID	optional selbstdefinierter Identifikator	Einstellbar unter Personalverwaltung - MA-Nr.
PERSON_KEY	Selbstdefinierter Buchungsschlüssel der Person
PERSON_NAME	Name der Person
PERSON_CARD_NR	optional Buchungsschlüssel	Einstellbar unter Personalverwaltung - Card-Nr.
DATETIME	Zeitpunkt der Buchung	Format: TT.MM.JJJJ HH:MM:SS
ACTIVITY_ID	Technischer Ident einer Buchung, im Portal zur Tätigkeit hinterlegbar
ACTIVITY_NAME	Beschreibungstext, welcher für diese Buchung hinterlegt wurde
TERMINAL_ID	optional RTI Ident des Buchungsterminals	Einzustellen über die RTI Einstellungen
TERMINAL_NAME	Bezeichner des Buchungsterminals	typischerweise das hinterlegte Fahrzeugkennzeichen
LAT	optional Latitude zur Positionierung
LON	otpional Longitude zur Positionierung
ADDRESS	Aufgelöster Positionstext
AREA	Gebiete, welche für diese Position festgelegt wurden	Trennzeichen: "%\|%"
COST_CENTER_ID	optional technischer Ident zur identifikation einer gesetzten Kostenstelle
COST_CENTER_NAME	optional Name einer gesetzten Kostenstelle

Beispiel Ausgabe

Ausgabe in CSV
"PERSON_ID";"PERSON_KEY";"PERSON_NAME";"PERSON_CARD_NR";"DATETIME";"ACTIVITY_ID";"ACTIVITY_NAME";"TERMINAL_ID";"TERMINAL_NAME";"LAT";"LON;""ADDRESS";"AREA";"COST_CENTER_ID";"COST_CENTER_NAME"
"A23";"DF000000000123";"Max Mustermann";"";"01.10.2019 08:00:00";"1023";"Arbeit";"M_23";"DD-YF 123";"51.4";"13.1";"Musterstraße 17, 01234 Musterstadt";"Hauptzentrale";"K-47";"allgem. Arbeiten"
"A23";"DF000000000123";"Max Mustermann";"";"01.10.2019 12:00:00";"1024";"Pause";"M_23";"DD-YF 123";"52.0";"11.3";"Testweg 23, 91234 Testhausen";"Müller GmbH";"";""

Beispiele

Abruf der Buchungen im CSV Format
https://map.yellowfox.de/rti/get_timerecording.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&start=20190602000000&end=20190605235959&format=CSV