Abwesenheiten¶

Abruf von Abwesenheitsperioden¶

Für den Datenabruf benötigen Sie ein im Abschnitt Konfiguration erstelltes Schichtgruppen-Token. Die URL lautet:

https://<host>/planerio/absences/api/external/tokenapi/aaa-bbb-ccc/absencePeriods

Ersetzen Sie aaa-bbb-ccc durch das entsprechende Schichtgruppen-Token und hängen Sie die folgenden Query-Parameter an. Leiten Sie den ersten Parameter mit ? und alle weiteren Parameter mit & ein.

Folgende Parameter stehen optional zur Verfügung:

Folgende Daten sind enthalten (jeweils ein JSON-Objekt pro Abwesenheitsperiode):

Perioden, die über den unten beschriebenen Import von Abwesenheitsperioden angelegt wurden und daher extern verwaltet werden, gibt dieser Endpunkt nicht zurück.

Import von Abwesenheitsperioden¶

Über diesen Endpunkt können Sie Abwesenheitsperioden in Planerio anlegen. Die entsprechenden Abwesenheitstypen müssen bereits in Planerio vorhanden sein. Importierte Abwesenheitsperioden sind in Planerio sichtbar, können dort aber weder von Benutzern noch von Administratoren genehmigt, bearbeitet oder gelöscht werden.

Die URL des Endpunkts lautet:

https://<host>/integrations/tokenapi/v1/aaa-bbb-ccc/absencePeriod

Ersetzen Sie aaa-bbb-ccc durch das entsprechende Schichtgruppen-Token (siehe Abschnitt Konfiguration).

Abwesenheiten können nur für Mitarbeiter angelegt, geändert oder gelöscht werden, deren primäre Schichtgruppe mit dem verwendeten Schichtgruppen-Token verknüpft ist. Dadurch lässt sich der Zugriff auf bestimmte Schichtgruppen beschränken.

Anlegen und Aktualisieren (POST)¶

Folgende Parameter stehen zur Verfügung:

Übermitteln Sie die Felder in einem POST-Request. Beispiel mit curl:

curl -v \
  --data-urlencode 'unique_absence_id=A1182783912' \
  --data-urlencode 'absence_type_key=0400' \
  --data-urlencode 'employee_personnel_number=001234' \
  --data-urlencode 'date_from=2023-07-17' \
  --data-urlencode 'date_to=2023-07-17' \
  -H 'X-Planerio-Api-Gateway-Auth: SESSIONTOKEN' \
  'https://HOST/integrations/tokenapi/v1/AAA-BBB-CCC/absencePeriod'

Nach erfolgreichem Anlegen oder Aktualisieren gibt der Endpunkt den HTTP-Status-Code 204 mit einem leeren Response-Body zurück.

Löschen (DELETE)¶

Senden Sie zum Löschen einer Abwesenheitsperiode einen DELETE-Request. Übergeben Sie den folgenden Parameter im URL-Pfad:

Vollständige URL: https://<host>/integrations/tokenapi/v1/aaa-bbb-ccc/absencePeriod/<unique_absence_id>

Wurde die Abwesenheit erfolgreich gelöscht oder war sie bereits nicht mehr vorhanden, gibt der Endpunkt den HTTP-Status-Code 204 mit einem leeren Response-Body zurück.

Beispielaufruf mit curl:

curl -v -XDELETE \
  -H 'X-Planerio-Api-Gateway-Auth: SESSIONTOKEN' \
  'https://HOST/integrations/tokenapi/v1/AAA-BBB-CCC/absencePeriod/A1182783912'

Einmaliger Import¶

Der primäre Anwendungsfall dieses Endpunkts ist der kontinuierliche Import von Abwesenheitsperioden aus einem Drittsystem. Sie können ihn jedoch auch verwenden, um einmalig eine größere Anzahl von Abwesenheiten in Planerio anzulegen.

Dazu ist die POST-Anfrage (vgl. oben) wie folgt zu parametrisieren:

So importierte Perioden:

• können in Planerio bearbeitet werden und verhalten sich wie direkt in Planerio angelegte Abwesenheitsperioden;
• können anschließend nicht mehr über die Schnittstelle aktualisiert werden, da ihnen eine unique_absence_id fehlt.

Abruf des Urlaubsbudgets¶

Über diesen Endpunkt können Sie Urlaubsdaten automatisiert oder manuell abrufen, beispielsweise zur Berechnung von Urlaubsrückstellungen. Dafür benötigen Sie ein im Abschnitt Konfiguration erstelltes Schichtgruppen-Token. Die URL zum Datenabruf lautet:

https://<host>/integrations/tokenapi/v3/aaa-bbb-ccc/absences/vacationDays

Verwenden Sie für diesen Endpunkt unbedingt Version v3 (siehe URL). Ältere Versionen werden nicht mehr unterstützt.

Ersetzen Sie aaa-bbb-ccc durch das entsprechende Schichtgruppen-Token. Sie können den Datenabruf mit den folgenden Query-Parametern konfigurieren. Leiten Sie den ersten Parameter mit ? und alle weiteren Parameter mit & ein.

Folgende Daten sind pro Zeile/Datensatz enthalten:

ℹ️ Dieser Endpunkt wird in 2026/27 im Rahmen der Einführung von mehreren Budgets ersetzt.