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? |
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) 91 (Heute und 90 Tage rückwirkend bearbeitbar) |
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 |
---|
Optionale Parameter | number | string | Personalnummer |
---|---|---|---|
mail_to_user | boolean | Soll eine E-Mail an den neuen Mitarbeiter versenden werden? Default false |
Antwort
{ "user": [object of type user] }
Mitarbeiter bearbeiten
PUT /api/users/[ID]
Notwendige Parameter | keine |
---|
Optionale Parameter | name, number, active, role, edit_lock, edit_lock_dyn |
---|
Antwort
{ "user": [object of type user] }
Mitarbeiter deaktivieren
DELETE /api/users/[ID]
Antwort
{ "user": [object of type user] }