absence_management/get_absences.php

Version 1.1 von YellowFox_RD am 2024/12/19 10:11

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
- Attribute
- Beispiel

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

Beschreibung

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

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
import	RTI Importschlüssel	string		ja
start	Start Abfragezeitraum	string	Format: YYYYMMDDHHIISS	ja
end	Ende Abfragezeitraum	string	Format: YYYYMMDDHHIISS	ja
employeeNumbers	Array von Mitarbeiternummern	json	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
withHolidays	Ausgabe von Feiertagen	bool	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
withDeleted	Ausgabe von gelöschten Abwesenheiten	bool	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
group	Bezeichnung der Personalgruppe, auf welche eingegrenzt werden soll	string	Es muss die exakte Bezeichnung einer Personalgruppe angegeben werden	nein

Rückgabe

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

Attribute

Attribut	Format	Beschreibung
employeeNumber	string	Mitarbeiternummer zur Identifizierung
createDate	string (nach ISO 8601) \| null	Erstelldatum des Eintrags
deleteDate	string (nach ISO 8601) \| null	Löschdatum des Eintrags
startDate	string (nach ISO 8601)	Beginn der Abwesenheit
endDate	string (nach ISO 8601)	Ende der Abwesenheit
factor	float	Anteil am Arbeitstag in Bezug auf das Arbeitszeitprofil Wert zwischen 0 und 1 wobei 1 einem ganzen Arbeitstag entspricht
type	string	Kürzel der Abwesenheitsart wie im Portal hinterlegt
remark	string \| null	Optionaler Beschreibungstext
isRestTime	bool	Flag ob es sich dabei um einen Erholungsurlaub handelt
isFlexTime	bool	Flag ob diese Abwesenheit vom Gleitzeitkonto abgezogen werden soll
isHoliday	bool	Flag ob es sich dabei um einen Feiertag laut Feiertagsprofil handelt
ignored weekDays calendarDays	object int[] 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
workTime targetTimeInMinutes calculatedTimeInMinutes	object int int	Arbeitszeitrelevante Daten. Werte können nur korrekt bestimmt werden, wenn YellowTimeManager 3.0 gebucht und korrekt eingerichtet wurde. targetTimeInMinutes = Soll-Arbeitszeit laut Arbeitszeitprofilen während des Abwesenheitszeitraums. calculatedTimeInMinutes = gutgeschriebene Arbeitszeit, abhängig von Soll-Arbeitszeit, Abwesenheits-Anteil und ob die Abwesenheit vom Gleitzeitkonto abgezogen wird (Gleitzeitkonto Abwesenheiten schreiben keine Arbeitszeit gut)

Beispiel

[
   {
       "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": []
       },
"workTime": {
           "targetTimeInMinutes": 0,
           "calculatedTimeInMinutes": 0
       }
   },
...
]