Wiki-Quellcode von absence_management/get_absences.php
Version 1.1 von YellowFox_RD am 2024/12/19 10:11
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | (((Inhaltsverzeichnis))) | ||
| 3 | {{toc/}} | ||
| 4 | |||
| 5 | Abrufen der angelegten Abwesenheiten für alle oder einzelne Mitarbeiter. | ||
| 6 | = Beschreibung = | ||
| 7 | (% class="green mark" %)GET(%%)//** /absence_management/get_absences.php?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY**&start**=YYYYMMDDHHIISS**&end**=YYYYMMDDHHIISS// | ||
| 8 | = Parameter = | ||
| 9 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 10 | |company|RTI Firmenschlüssel|string||ja | ||
| 11 | |import|RTI Importschlüssel|string||ja | ||
| 12 | |start|Start Abfragezeitraum|string|Format: YYYYMMDDHHIISS|ja | ||
| 13 | |end|Ende Abfragezeitraum|string|Format: YYYYMMDDHHIISS|ja | ||
| 14 | |employeeNumbers|Array von Mitarbeiternummern|json|Einschränkung auf bestimmte Mitarbeiter | ||
| 15 | Wird dieser Parameter nicht angegeben, werden die Abwesenheiten von allen Mitarbeiten ausgegeben, **welche eine Mitarbeiternummer besitzen**. | ||
| 16 | Format: [ 'NR1','NR2', ... ]|nein | ||
| 17 | |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. | ||
| 18 | Standard: //true//|nein | ||
| 19 | |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". | ||
| 20 | Standard: //false//|nein | ||
| 21 | |group|Bezeichnung der Personalgruppe, auf welche eingegrenzt werden soll|string|Es muss die exakte Bezeichnung einer Personalgruppe angegeben werden|nein | ||
| 22 | |||
| 23 | = Rückgabe = | ||
| 24 | Die Rückgabe erfolgt im JSON-Format. Bei fehlenden Pflichtparametern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben. | ||
| 25 | |||
| 26 | == Attribute == | ||
| 27 | |=Attribut|=Format|=Beschreibung | ||
| 28 | |employeeNumber|string|Mitarbeiternummer zur Identifizierung | ||
| 29 | |createDate|string (nach ISO 8601) ~| null|Erstelldatum des Eintrags | ||
| 30 | |deleteDate|string (nach ISO 8601) ~| null|Löschdatum des Eintrags | ||
| 31 | |startDate|string (nach ISO 8601)|Beginn der Abwesenheit | ||
| 32 | |endDate|string (nach ISO 8601)|Ende der Abwesenheit | ||
| 33 | |factor|float|Anteil am Arbeitstag in Bezug auf das Arbeitszeitprofil | ||
| 34 | Wert zwischen 0 und 1 wobei 1 einem ganzen Arbeitstag entspricht | ||
| 35 | |type|string|Kürzel der Abwesenheitsart wie im Portal hinterlegt | ||
| 36 | |remark|string ~| null|Optionaler Beschreibungstext | ||
| 37 | |isRestTime|bool|Flag ob es sich dabei um einen Erholungsurlaub handelt | ||
| 38 | |isFlexTime|bool|Flag ob diese Abwesenheit vom Gleitzeitkonto abgezogen werden soll | ||
| 39 | |isHoliday|bool|Flag ob es sich dabei um einen Feiertag laut Feiertagsprofil handelt | ||
| 40 | |ignored | ||
| 41 | ((( | ||
| 42 | * weekDays | ||
| 43 | * calendarDays | ||
| 44 | )))|object | ||
| 45 | ((( | ||
| 46 | * int[] | ||
| 47 | * string[] (nach ISO 8601) | ||
| 48 | )))|Abwesenheiten die über einen längeren Zeitraum gehen können Tage innerhalb dieses Zeitraumes ausschließen. | ||
| 49 | weekDays: Nummern von Wochentagen (Wert 0 bis 6 = Sonntag bis Samstag), z.B. Wochenende | ||
| 50 | calendarDays: explizite Datumsangaben, z.B. ein Feiertag | ||
| 51 | |workTime | ||
| 52 | ((( | ||
| 53 | * targetTimeInMinutes | ||
| 54 | * calculatedTimeInMinutes | ||
| 55 | )))|object | ||
| 56 | ((( | ||
| 57 | * int | ||
| 58 | * int | ||
| 59 | )))|Arbeitszeitrelevante Daten. Werte können nur korrekt bestimmt werden, wenn YellowTimeManager 3.0 gebucht und korrekt eingerichtet wurde. | ||
| 60 | ((( | ||
| 61 | * targetTimeInMinutes = Soll-Arbeitszeit laut Arbeitszeitprofilen während des Abwesenheitszeitraums. | ||
| 62 | * calculatedTimeInMinutes = gutgeschriebene Arbeitszeit, abhängig von Soll-Arbeitszeit, Abwesenheits-Anteil und ob die Abwesenheit vom Gleitzeitkonto abgezogen wird (Gleitzeitkonto Abwesenheiten schreiben keine Arbeitszeit gut) | ||
| 63 | ))) | ||
| 64 | |||
| 65 | == Beispiel == | ||
| 66 | |||
| 67 | {{code language="java"}}[ | ||
| 68 | { | ||
| 69 | "employeeNumber": "0815", | ||
| 70 | "createDate": "2021-04-15T13:53:23+02:00", | ||
| 71 | "deleteDate": null, | ||
| 72 | "startDate": "2021-03-08T00:00:00+01:00", | ||
| 73 | "endDate": "2021-03-08T23:59:59+01:00", | ||
| 74 | "factor": 1, | ||
| 75 | "type": "BA", | ||
| 76 | "remark": null, | ||
| 77 | "isRestTime": false, | ||
| 78 | "isFlexTime": false, | ||
| 79 | "isHoliday": false, | ||
| 80 | "ignored": { | ||
| 81 | "weekDays": [], | ||
| 82 | "calendarDays": [] | ||
| 83 | }, | ||
| 84 | "workTime": { | ||
| 85 | "targetTimeInMinutes": 0, | ||
| 86 | "calculatedTimeInMinutes": 0 | ||
| 87 | } | ||
| 88 | }, | ||
| 89 | ... | ||
| 90 | ]{{/code}} | ||
| 91 |