REST-API

Die clockodo-API ermöglicht die Anbindung von clockodo an andere Systeme. Rechnungs- und Projektmanagement-Anwendungen oder eigene Shell-Skripte sind Beispiele für nützliche Mash-Ups mit clockodo.

api/targethours: Sollstunden verwalten

Über diese Ressource können Sie alle Sollstunden-Einstellungen verwalten.


Abstrakter Objekttyp „targethoursRow“

Parameter Typ Beschreibung
id integer Die ID der Sollstunden-Einstellung
type string Art der Sollstunden:
'weekly': wochensollstunden
'monthly': Monatssolstunden
date_since string Datum ab welchem die Soll-Stunden gelten im Format YYYY-MM-DD
date_until string|null Datum bis zu welchem die Soll-Stunden gelten im Format YYYY-MM-DD
compensation_monthly float Automatische Abgeltung pro Monat in Stunden
users_id integer Die ID des zugehörigen Mitarbeiters

Objekttyp „targethoursRowWeekly“

Objekttyp „targethoursRow“ erweitert um:

Parameter Typ Beschreibung
monday float Soll-Stunden für Montag
tuesday float Soll-Stunden für Dienstag
wednesday float Soll-Stunden für Mittwoch
thursday float Soll-Stunden für Donnerstag
friday float Soll-Stunden für Freitag
saturday float Soll-Stunden für Samstag
sunday float Soll-Stunden für Sonntag
absence_fixed_credit boolean true falls bei Abwesenheit die durchschnittliche Soll-Arbeitszeit verrechnet wird, false falls die Soll-Stunden des jeweiligen Tags verrechnet werden.
compensation_daily float Automatische Abgeltung pro Tag in Minuten

Objekttyp „targethoursRowMonthly“

Objekttyp „targethoursRow“ erweitert um:

Parameter Typ Beschreibung
monthly_target float Die zu erreichenden monatlichen Sollstunden
workday_tuesday boolean Ist Dienstag ein Arbeitstag?
workday_wednesday boolean Ist Mittwoch ein Arbeitstag?
workday_thursday boolean Ist Donnerstag ein Arbeitstag?
workday_friday boolean Ist Freitag ein Arbeitstag?
workday_saturday boolean Ist Samstag ein Arbeitstag?
workday_sunday boolean Ist Sonntag ein Arbeitstag?
workday_monday boolean Ist Montag ein Arbeitstag?

Sollstunden auflisten

Anfrage
GET /api/targethours
Optionale Parameter users_id (integer) Benutzer auf welchen eingeschränkt werden soll
Antwort
{
  "targethours": 
  {
    [object of type targethoursRow],
    [object of type targethoursRow], 
    ...
  }
}

Einzelne Sollstunden-Einstellung abrufen

Anfrage
GET /api/targethours/[ID]
Antwort
{
  "targethours": [object of type targethoursRow]
}

Sollstunden anlegen

Anfrage
POST /api/targethours
Pflichtparameter für type: weekly users_id, type, monday, tuesday, wednesday, thursday, friday, saturday, sunday, compensation_daily, compensation_monthly
Pflichtparameter für type: monthly users_id, type, workday_monday, workday_tuesday, workday_wednesday, workday_thursday, workday_friday, workday_saturday, workday_sunday, monthly_target, compensation_monthly
Optionale Parameter date_until
Antwort
{
  "targethours": [object of type targethoursRow]
}

Sollstunden bearbeiten

Anfrage
PUT /api/targethours/[ID]
Pflichtparameter für type: weekly users_id, type, monday, tuesday, wednesday, thursday, friday, saturday, sunday, compensation_daily, compensation_monthly
Pflichtparameter für type: monthly users_id, type, workday_monday, workday_tuesday, workday_wednesday, workday_thursday, workday_friday, workday_saturday, workday_sunday, monthly_target, compensation_monthly
Optionale Parameter date_until
Antwort
{
  "targethours": [object of type targethoursRow]
}

Sollstunden löschen

Anfrage
DELETE /api/targethours/[ID]
Antwort
{
  "success": true
}