api/users: Mitarbeiter verwalten
Objekttyp „user“
Parameter | Typ | Beschreibung |
---|---|---|
id | integer | Die ID des Mitarbeiters |
name | string | Der Name des Mitarbeiter |
number | string | Personalnummer |
string | Die E-Mail-Adresse des Mitarbeiters | |
role | string | Die Rolle des Mitarbeiters |
active | boolean | Ist der Mitarbeiter aktiviert? |
timeformat_12h | boolean | Nutzt der Mitarbeiter das 12h-Zeitformat? |
weekstart_monday | boolean | Ist der Wochenanfang für den Mitarbeiter Montag? Falls nicht, beginnt die Woche am Sonntag |
weekend_friday | boolean | Ist das Wochenende für den Mitarbeiter Freitag und Samstag? Falls nicht, ist das Wochenende Samstag und Sonntag |
language | string | Sprache Erlaubte Werte: 'de', 'en', 'fr' |
timezone | string | Zeitzone des Mitarbeiters z.B. 'Europe/Berlin' |
wage_type | integer | Lohnart (nur relevant für DATEV-Export) Erlaubte Werte: 1 (Gehalt), 2 (Stundenlohn) |
can_generally_see_absences | boolean | Darf der Mitarbeiter Abwesenheiten anderer Mitarbeiter sehen? Nur änderbar für Mitarbeiter mit der Rolle 'worker' |
can_generally_manage_absences | boolean | Darf der Mitarbeiter Abwesenheiten anderer Mitarbeiter bearbeiten? Nur änderbar für Mitarbeiter mit der Rolle 'manager' |
can_add_customers | boolean | Darf der Mitarbeiter Kunden anlegen? Nur änderbar für Mitarbeiter mit der Rolle 'worker' |
edit_lock | date (YYYY-MM-DD) |
Festgelegte Bearbeitungssperre für den Mitarbeiter
null (Keine Bearbeitungssperre) YYYY-MM-DD (Nicht bearbeitbar bis) |
edit_lock_dyn | integer |
Dynamische Bearbeitungssperre für den Mitarbeiter
null (Keine Bearbeitungssperre) 1 (Heute bearbeitbar) 2 (Heute und Gestern bearbeitbar) 3 (Heute und 2 Tage rückwirkend bearbeitbar) 5 (Heute und 4 Tage rückwirkend bearbeitbar) 8 (Heute und eine Woche rückwirkend bearbeitbar) 15 (Heute und 2 Wochen rückwirkend bearbeitbar) 31 (Heute und 30 Tage rückwirkend bearbeitbar) 46 (Heute und 45 Tage rückwirkend bearbeitbar) 91 (Heute und 90 Tage rückwirkend bearbeitbar) |
edit_lock_sync | boolean | Kann die für den Mitarbeiter geltende Bearbeitungssperre durch eine Änderung der firmenweiten Bearbeitungssperre überschrieben werden? |
Mitarbeiter auflisten
GET /api/users
Antwort
{ "users": { [object of type user], [object of type user], ... } }
Einen Mitarbeiter abrufen
GET /api/users/[ID]
Antwort
{ "user": [object of type user] }
Mitarbeiter anlegen
POST /api/users
Notwendige Parameter | name, email, role |
---|
Der Parameter mail_to_user bestimmt, ob eine E-Mail an den neuen Mitarbeiter versendet wird (Default: false).
Optionale Parameter | mail_to_user, number, timeformat_12h, weekstart_monday, weekend_friday, language, timezone, wage_type, can_generally_see_absences, can_generally_manage_absences, can_add_customers, edit_lock_sync |
---|
Antwort
{ "user": [object of type user] }
Mitarbeiter bearbeiten
PUT /api/users/[ID]
Notwendige Parameter | keine |
---|
Optionale Parameter | name, number, active, role, timeformat_12h, weekstart_monday, weekend_friday, language, timezone, wage_type, can_generally_see_absences, can_generally_manage_absences, can_add_customers, edit_lock, edit_lock_dyn, edit_lock_sync |
---|
Antwort
{ "user": [object of type user] }
Mitarbeiter deaktivieren
DELETE /api/users/[ID]
Antwort
{ "user": [object of type user] }