Clockodo API:
Anträge auf Änderung der Arbeitszeit verwalten

Endpunkt api/v2/workTimes/changeRequests

Dieser Endpunkt wird erst ab Montag, 21. August 2023 valide Daten liefern.

Objekttyp „changeRequest“

Parameter Typ Beschreibung
idinteger
Die ID des Antrags
datestring
Das Datum, für das Arbeitszeiten geändert werden sollen
users_idinteger
Der Benutzer, dessen Arbeitszeiten geändert werden sollen
statusinteger
Status des Antrags
1: beantragt, 2: abgelehnt
declined_atstring|null
Zeitpunkt, zu dem der Antrag abgelehnt wurde
im Format ISO 8601 UTC, z.B. „2023-07-30T12:34:56Z“
declined_byinteger|null
ID des Benutzers, der den Antrag abgelehnt hat
changeschangeRequestInterval[]
Die beantragten Änderungen der Arbeitszeit

Objekttyp „changeRequestInterval“

Parameter Typ Beschreibung
typeinteger
Art der Änderung
1: Zeit hinzufügen; 2: Zeit entfernen
time_sincestring
Beginn der Änderung
im Format ISO 8601 UTC, z.B. „2023-07-30T12:34:56Z“
time_untilstring
Ende der Änderung
im Format ISO 8601 UTC, z.B. „2023-07-30T12:34:56Z“

Anträge auflisten

Anfrage
GET /api/v2/workTimes/changeRequests
Optionale Parameter date_sincestring
Beginn des Zeitraums, für den angefragt wird
date_untilstring
Ende des Zeitraums, für den angefragt wird
users_idinteger
ID des Benutzers, dessen Anträge angefragt werden
statusinteger
Status-Filter
1: angefragt; 2: abgelehnt
Antwort
{
  "paging": [paging information],
  "change_requests": 
  {
    [object of type changeRequest],
    [object of type changeRequest], 
    ...
  }
}

Antrag anlegen

Anfrage
POST /api/v2/workTimes/changeRequests
Pflichtparameter datestring
users_idinteger
changeschangeRequestInterval[]
JSON-Body eines POST-Requests (Beispiel)
{
    "date": "2023-07-30",
    "users_id": 123,
    "changes": [
        {
            "type": 1,
            "time_since": "2023-07-30T14:00:00Z",
            "time_until": "2023-07-30T15:00:00Z",
        },
        {
            "type": 2,
            "time_since": "2023-07-30T13:00:00Z",
            "time_until": "2023-07-30T14:00:00Z",
        },
    ]
}
Antwort
{
  'change_request':          [object of type changeRequest],      // Der neu angelegte Antrag
  'replaced_change_request': [object of type changeRequest]|null, // Der bisherige offene Antrag für diesen Tag, der überschrieben wurde
  'approved_immediately':    boolean                              // Wurde der Antrag sofort automatisch angenommen?
}

Pro Benutzer und Tag kann nur ein offener Antrag existieren. Wird für einen Tag, an dem bereits ein offener Antrag vorliegt, ein weiterer Antrag erstellt, überschreibt dieser den existierenden. Wird ein Antrag für einen Tag erstellt, dessen Arbeitszeiten ohne Antrag bearbeitet werden dürfen, wird dieser automatisch angenommen und sofort auf die Arbeitszeiten des Tages angewendet.

Antrag annehmen

Anfrage
POST /api/v2/workTimes/changeRequests/[ID]/approve
Antwort
{
  "change_request": null
}

Antrag ablehnen

Anfrage
POST /api/v2/workTimes/changeRequests/[ID]/decline
Antwort
{
  "change_request": [object of type changeRequest]
}

Antrag löschen

Anfrage
DELETE /api/v2/workTimes/changeRequests/[ID]

Abgelehnte Anträge können nicht gelöscht werden.

Antwort
{
  "change_request": null
}
stripes illustration
Kontaktieren Sie uns!

Unser Customer-Success-Team steht Ihnen für Fragen zur Verfügung!

Jetzt kontaktieren!
Alle Funktionen 14 Tage kostenlos testen
Mit dem Absenden des Formulars akzeptieren Sie unsere AGB und unsere Datenschutz­erklärung und bestätigen, dass Sie Clockodo als Unternehmer nutzen.

Nutzen Sie die Erfahrungen von 10.000 weiteren Unternehmen:

Bechtle Mannheim LogoBechtlePeerigon LogoPeerigon GmbH
Phoenix Logistik LogoPhoenix LogistikFieda LogoFidea