Versions Compared

Key

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

Abrufen der angelegten Abwesenheiten für alle oder einzelne Mitarbeiter.

Beschreibung

GET /absence_management/get_absences.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY

Parameter

Parameter

Beschreibung

Typ

Hinweis

Pflicht

companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja
employeeNumbersArray von Mitarbeiternummernjson

Einschränkung auf bestimmte Mitarbeiter

Wird dieser Parameter nicht angegeben, werden die Abwesenheiten von allen Mitarbeiten ausgegeben, welche eine Mitarbeiternummer besitzen.

Format: [ 'NR1','NR2', ... ]

nein
withHolidaysAusgabe von Feiertagenbool

Pro Mitarbeiter kann ein Feiertagsprofil mit vordefinierten Feiertagen zugewiesen werden. Ist dieser Parameter aktiv, werden diese Feiertage ebenfalls als Abwesenheiten mit ausgegeben. Sie erkennen solche Datensätze am Attribut isHoliday = true.

Standard: true

nein
withDeletedAusgabe von gelöschten Abwesenheitenbool

Gelöschte Abwesenheiten werden standardmäßig nicht mit ausgegeben. Sie können diesen Parameter aktivieren, um einen Abgleich mit Ihren Daten durchzuführen. Sie erkennen gelöschte Datensätze am gesetzten Attribut "deleteDate". 

Standard: false

nein

Rückgabe

Die Rückgabe erfolgt im JSON-Format. Bei fehlenden Pflichtparametern wird ein "ERROR:Beschreibung" zurückgegeben.


Attribute

AttributFormatBeschreibung
employeeNumberstringMitarbeiternummer zur Identifizierung
createDate

string (nach ISO 8601) | null

Erstelldatum des Eintrags
deleteDatestring (nach ISO 8601) | nullLöschdatum des Eintrags
startDatestring (nach ISO 8601)Beginn der Abwesenheit
endDatestring (nach ISO 8601)Ende der Abwesenheit
factorfloat

Anteil am Arbeitstag in Bezug auf das Arbeitszeitprofil

Wert zwischen 0 und 1 wobei 1 einem ganzen Arbeitstag entspricht

typestringKürzel der Abwesenheitsart wie im Portal hinterlegt
remarkstring | nullOptionaler Beschreibungstext
isRestTimeboolFlag ob es sich dabei um einen Erholungsurlaub handelt
isFlexTimeboolFlag ob diese Abwesenheit vom Gleitzeitkonto abgezogen werden soll 
isHolidayboolFlag ob es sich dabei um einen Feiertag laut Feiertagsprofil handelt

ignored

  • weekDays
  • calendarDays

object

  • stringint[]
  • string[] (nach ISO 8601)

Abwesenheiten die über einen längeren Zeitraum gehen können Tage innerhalb dieses Zeitraumes ausschließen.

weekDays: Nummern von Wochentagen (Wert 0 bis 6 = Sonntag bis Samstag), z.B. Wochenende

calendarDays: explizite Datumsangaben, z.B. ein Feiertag


Beispiel

Code Block
[
    {
        "employeeNumber": "0815",
        "createDate": "2021-04-15T13:53:23+02:00",
        "deleteDate": null,
        "startDate": "2021-03-08T00:00:00+01:00",
        "endDate": "2021-03-08T23:59:59+01:00",
        "factor": 1,
        "type": "BA",
        "remark": null,
        "isRestTime": false,
        "isFlexTime": false,
        "isHoliday": false,
        "ignored": {
            "weekDays": [],
            "calendarDays": []
        }
    },
	...
]



...