Versions Compared

Old Version 12

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version Current

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede


Info
titleKompatibilitä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

Status
colourGreen
titleGET
 getget_timerecording.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&beginstart=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&format=CSV&version=1&date_query=insert

Parameter

Parameter

Beschreibung

Typ

Hinweis

Pflicht

companyRTI Firmenschlüsselstring
 

ja
importRTI Importschlüsselstring
 

ja
begin
startStartzeitpunkt der Ausgabestringder Ausgabezeitraum darf maximal 31 Tage umfassenja
endEndzeitpunkt der Ausgabestringder Ausgabezeitraum darf maximal 31 Tage umfassenja
formatAusgabeformatstring

zulässige Ausgabeformate

  • CSV
  • JSON
    • XML
    • csv
    • json
    • xml
    • buspronet
    • gfos
    		ja
    versionVersionsnummer der Abfrageinteger

    aktuell ist Version 1

    sollte sich das Ausgabeformat ändern wird jeweils eine neue Versionsnummer vergeben

    		nein
    date_queryWelches Datum bildet die Grundlage für die Zeitraumeingrenzungstring

    'insert' (Standard) = Verarbeitungsdatum

    'gps' = Datum an dem die Zeitbuchung stattgefunden hat

    nein

    Rückgabewerte

    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

    (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
    groupBezeichnung der Personalgruppe, auf welche eingegrenzt werden sollstringEs muss die exakte Bezeichnung einer Personalgruppe angegeben werdennein
    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

    Code Block
    languagejs
    titleJSON Ausgabe
    [
    {
        "person": {
    Code Block
    languagejs
    titleJSON Ausgabe
    [
    {
        "person": {
            "id": "A23",
            "key": "DF00000001234",
            "name": "Max Mustermann",
            "card_nrid": null
    "A23",
    },
        "datetimekey": "2019-04-01 05:26:00DF00000001234",
            "activityname": {"Max Mustermann",
            "idcard_nr": "1003",null
        },
        "namedatetime": "Arbeitszeit"
2019-04-01 05:26:00",
         },"activity": {
        "terminal": {
			    "id": "M_1231003",
			            "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

    Code Block
    languagexml
    titleXML 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</namename>
        </costcenter>
    </booking>
</bookings>


    CSV Format

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

    Metainformationen

    TrennzeichenSemikolon ( ; )
    TextbegrenzerDoppeltes Hochkomma ( " )
    Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
    HeaderZeile 1
    KodierungWindows-1252

    CSV Spalten

    Spalte

    Beschreibung


     
    PERSON_IDoptional selbstdefinierter IdentifikatorEinstellbar unter Personalverwaltung - MA-Nr.
    PERSON_KEYSelbstdefinierter Buchungsschlüssel der Person
    PERSON_NAMEName der Person
    PERSON_CARD_NRoptional BuchungsschlüsselEinstellbar unter Personalverwaltung - Card-Nr.

    DATETIME

    		Zeitpunkt der BuchungFormat: 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_IDoptional RTI Ident des BuchungsterminalsEinzustellen über die RTI Einstellungen
    TERMINAL_NAMEBezeichner des Buchungsterminalstypischerweise das hinterlegte Fahrzeugkennzeichen
    LAT

    optional Latitude zur Positionierung


    LONotpional Longitude zur Positionierung
    ADDRESSAufgelöster Positionstext
     

    AREA

    Gebiete, welche für diese Position festgelegt wurden

    Trennzeichen: "%|%" 

    COST_CENTER_IDoptional technischer Ident zur identifikation einer gesetzten Kostenstelle
     

    COST_CENTER_NAMEoptional Name einer gesetzten Kostenstelle
     

    Beispiel Ausgabe

    "

    Code Block
    titleAusgabe 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
    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
    2019 12:00:00";"1024";"Pause";"M_23";"DD-YF 123";"52.0";"11.3";"Testweg 23, 91234 Testhausen";"Müller GmbH";"";""

     Beispiele

    Code Block
    titleAbruf der Buchungen
    mit Geokoordinatenhttp
    im CSV Format
    https://map.yellowfox.de/rti/get_timerecording.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&
    begin
    start=
    20151102000000
    20190602000000&end=
    20151108235959
    20190605235959&format=CSV


    'insert' (default) = get bookings by processing time

    'gps' = get booking by booked date and time
    Sv translation
    languageen


    Info
    titleCompatibility

    This function is intended to be used with timerecording V3

    If you are using the older V2 version, please use get_timerecording.asp

    Returns all received timerecording bookings for the requested time range. This range may refer to the processing time in our computing center or to the booked date and time.

    In case you are using bookings based on digitacho files, there is a delay of multiple hours between the booked time and when this booking is available via rti. The digitacho files with all bookings per (work) day are typically submitted at the next work day. Then this digitacho bookings will be translated into time bookings and are available after this is done. So working with digitacho bookings requires to use the insert date to get catch all bookings without a gap.

    Description

    get_timerecording.php?output=bookingslist&company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&begin=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&format=CSV&version=1&date_query=insert

    Parameter

    into time bookings and are available after this is done. So working with digitacho bookings requires to use the insert date to get catch all bookings without a gap.

    Description

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

    Parameter

    ParameterDescriptionTypeNoteMandatory
    companyRTI company keystring
    		yes
    importRTI import keystring
    		yes
    startstart time for outputstringthe difference between start and end must not ecxeed 31 daysyes
    endend time for outputstringthe difference between start and end must not ecxeed 31 daysyes
    formatoutput formatstring

    valid output formats

    • csv
    • json
    • xml
    • buspronet
    • gfos
    		yes
    versionversion number for requestinteger

    currently there is only the version 1

    on change of any output parameter this version number will change, too

    		no
    date_queryset the date reference for requeststring

    'insert' (default) = get bookings by processing time

    'gps' = get booking by booked date and time (if 'with_changes=1' active and a booked time was modified, this modified time is relevant)

    'update' = ONLY for 'with_changes=1'; common result similar to option 'insert', for changed bookings, the change date will be used

    		no
    groupName of the personnel group to which the restriction is to be madestringThe exact name of a personnel group must be givenno
    with_changes

    indicates if changes, done in portal will be applied to returned bookings or not

    if so, bookings deleted in portal won't be returned anymore

    		integer

    0 (default) = always return unmodified bookings

    1 = apply changes so the resultset is similar to the visible result in web portal

    ParameterDescriptionTypeHintMandatory
    companyRTI company keystringyesimportRTI import keystringyes
    beginstart time for outputstringthe difference between start and end must not ecxeed 31 daysyes
    endend time for outputstringthe difference between start and end must not ecxeed 31 daysyes
    formatoutput formatstring

    valid output formats

    • csv
    • json
    • xml
    		yes
    versionversion number for requestinteger

    currently there is only the version 1

    on change of any output parameter this version number will change, too

    		no
    date_queryset the date reference for requeststring

    		no

    Return values

    This funtion returns a string. On error the return will be "Error:Description".

    CSV Format

    Returning a row per booking with all the data as defined below

    Meta informations

    SeparatorSemicolon ( ; )
    DelimiterDouble quote ( " )
    Line break0x0D 0x0A (CarriageReturn LineFeed)
    HeaderRow 1
    EncodingWindows-1252

    Columns

    Column

    Description


     
    PERSON_ID
    • self defined person number
    		in
    portal
    personell administration listed as
    "Ma
    MA-Nr
    "
    PERSON_KEYBooking key, used by person
    PERSON_NAMEname of person
    PERSON_CARD_NUMBER
    • self defineable additional booking number
    		in
    portal
    personell administration listed as
    "
    Card-Nr
    "
    DATETIMEDateformat DD.MM.YYYY HH:MM:SS
    ACTIVITY_ID

    Short booging type definition


    ACTIVITY_NAME

    Description text for booking as defined


    TERMINAL
    portal Name of object, where the booking was done
    _IDrti ident of booking terminalas set via rti settings → rti ident per vehicle
    TERMINAL_NAMEname of the booking terminalusually the vehicle sign
    LATLatitude
    LONLongitude
    ADDRESSAufgelöster Positionstext
     

    AREA

    areas, as defined for this Position

    delimiter: "%|%" 

    DRIVERKEYpersonal key of person who did the booking
     

    COST_CENTER_IDtechnical ident of cost center
     

    COST_CENTER_NAMEname of used cost center
    example

    Example

    Code Block
    titlereturn in csv
    "PERSON_ID";"PERSON_KEY";"PERSON_NAME";"PERSON_CARD_NR";"DATETIME";"ACTIVITY_IDID";"ACTIVITY_NAME";"ACTIVITYTERMINAL_NAMEID";"TERMINAL_NAME";"LAT";"LON;""ADDRESS";"AREA";"COST_CENTER_ID";"COST_CENTER_NAME"
"A23";"DF000000000123";"John Smith";"";"01.10.2019 08:00:00";"1023";"work";"CAR_17";"DD-YF 123";"51.4";"13.1";"Musterstraße 17, 01234 Musterstadt";"Hauptzentrale";"K-47";"common work"
"A23";"DF000000000123";"John smith";"";"01.10.2019 12:00:00";"1024";"break";"CAR_17";"DD-YF 123";"52.0";"11.3";"Testweg 23, 91234 Testhausen";"Müller GmbH";"";""

    JSON Format

    Returns a JSON formatted string with detailed data per booking

    Example output

    Code Block
    languagejs
    titleJSON output
    [
    {
        "person": {
            "id": "A23",
            "key": "DF00000001234",
            "name": "John Smith",
            "card_nr": null
        },
        "datetime": "2019-04-01 05:26:00",
        "activity": {
            "id": "1003",
            "name": "work time"
        },
        "terminal": {
			"id": "C_32",
			"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": "John Smith",
            "card_nr": null
        },
        "datetime": "2019-04-01 12:35:00",
        "activity": {
            "id": "1001",
            "name": "break time"
        },
        "terminal": {
			"id": "C-1",
			"name": "central"
		},
        "position": {
            "lat": 52.0,
            "lon": 11.9,
            "address": "Am Wüsteberg 3, 01723 Kesselsdorf"
        },
        "area": null,
        "costcenter": {
            "id": "K-47",
            "name": "common"
        }
    }


    XML Format

    Code Block
    languagexml
    titleXML output
    <?xml version="1.0"?>
<bookings>
    <booking>
        <person>
            <id/>
            <key>DF00000001234</key>
            <name>John Smith</name>
            <card_nr/>
        </person>
        <datetime>2019-04-01 05:26:00</datetime>
        <activity>
            <id>1003</id>
            <name>work time</name>
        </activity>
        <terminal>DD<terminal>
			<id>C_32</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>John Smith</name>
            <card_nr/>
        </person>
        <datetime>2019-04-01 12:35:00</datetime>
        <activity>
            <id>1001</id>
            <name>break</name>
        </activity>
        <terminal>central<<terminal>
			<id>C_1</id>
			<name>central</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>common</namename>
        </costcenter>
    </booking>
</bookings>


    Example

    request

    call

    Code Block
    languagexml
    titlecall to output json
    httpshttp://map.yellowfox.de/rti/get_timerecording.php?output=bookingslist&company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&beginstart=2015110200000020190602000000&end=2015110823595920190605235959&format=JSON