"PATCH /openapi/v1/user/:userId"-Methode

Änderungen an Benutzerdaten durchführen. Einen Mitarbeiter des Unternehmens in eine andere Trainingsgruppe verschieben.

Anfrage

Kopfzeile:

• Authorization – API-Token des Unternehmens.

Parameter:

• userId – eine Zeichenfolge – Identifizierungscode des spezifischen Benutzers, der in eine andere Gruppe verschoben wird.

  Muss die folgenden Kriterien erfüllen:

  • Länge von 24 Zeichen
  • Nur Kleinbuchstaben

Körper

Format – JSON.

• groupId – eine Zeichenfolge – ID der Gruppe, in die der Unternehmensmitarbeiter verschoben wird.

  Entspricht der ID der "/openapi/v1/groups"-Methode.

  Die ID muss die folgenden Kriterien erfüllen:

  • Länge von 24 Zeichen
  • Nur Kleinbuchstaben
• fullName – eine Zeichenfolge – Vollständiger Name des Mitarbeiters.
• shortName – eine Zeichenfolge – Kurzname des Mitarbeiters.
• email – eine Zeichenfolge – Die E-Mail-Adresse des Mitarbeiters.

Antwort

JSON mit einem Array von Daten über den Benutzer.

• userId – eine Zeichenfolge – Der Identifizierungscode, der dem Benutzer zugewiesen wurde.
• currentGroup – ein Objekt – Ein Array von Daten über die aktuelle Benutzergruppe.

  Im folgenden Format:

  {

  id,name

  }

  wobei:

  • id – eine Zeichenfolge – der Identifikationsschlüssel der aktuellen Gruppe ist
  • name – eine Zeichenfolge – der Name der aktuellen Gruppe ist
• previousGroup – ein Objekt – Ein Array von Daten über die vorherige Benutzergruppe.

  Im folgenden Format:

  {

  id,name

  }

  wobei:

  • id – der Identifizierungsschlüssel der vorherigen Gruppe ist.
  • name – der Name der vorherigen Gruppe ist.
• currentFullName – eine Zeichenfolge – Aktueller vollständiger Name des Mitarbeiters.

  Dieser Parameter wird nur generiert, wenn fullName in der JSON-Quelle angegeben ist.

• previousFullName – eine Zeichenfolge – Vorheriger vollständiger Name des Mitarbeiters.

  Dieser Parameter wird nur generiert, wenn fullName in der JSON-Quelle angegeben ist.

• currentShortName – eine Zeichenfolge – Aktueller Kurzname des Mitarbeiters.

  Dieser Parameter wird nur generiert, wenn shortName in der JSON-Quelle angegeben ist.

• currentShortName – eine Zeichenfolge – Vorheriger Kurzname des Mitarbeiters.

  Dieser Parameter wird nur generiert, wenn shortName in der JSON-Quelle angegeben ist.

• currentEmail – eine Zeichenfolge – Aktuelle E-Mail-Adresse des Mitarbeiters.

  Dieser Parameter wird nur generiert, wenn email in der JSON-Quelle angegeben ist.

• previousEmail – eine Zeichenfolge – Vorherige E-Mail-Adresse des Mitarbeiters.

  Dieser Parameter wird nur generiert, wenn email in der JSON-Quelle angegeben ist.

  Beispiel einer Antwort: { userId : "1ab2457896abcc1234567891", "currentGroup" : {id" : "60e050803050c0704080a0e6", "name" : "Rischio ridotto"}, "previousGroup" : {id" : "61e151813151c1714181a1e6", "name" : "Hohes Risiko"}, "currentFullName" : "Emma-Luisa Weber", "previousFullName" : "Emma-Luise Weber", "currentShortName" : "Emma Weber", "previousShortName" : "Emma", "currentEmail" : "weber@mail.com", "previousEmail" : "emma.weber@mail.com" }

Mögliche Fehler:

• 200 – success – Der Vorgang war erfolgreich.
• 400 – bad request – Mit der Anforderung stimmt etwas nicht. Der Kunde darf die Anfrage nicht wiederholen, ohne Änderungen durchzuführen.
• 400 – user-email-already-exists-in-company – Diese E-Mail-Adresse wird im Unternehmen bereits verwendet.
• 401 – common-unauthorized – Es ist ein Authentifizierungsfehler aufgetreten.
• 402 – PAYMENT_REQUIRED – Die Lizenz ist nicht aktiv.
• 403 – forbidden – Das Token ist nicht für diese Methode berechtigt.
• 404 – User not found – Eine falsche E-Mail-Adresse wurde übergeben.
• 404 – Group not found – Eine falsche Gruppen-ID wurde übergeben. 
• 409 – User status not supported for this operation – Die Anfrage kann nicht ausgeführt werden; der Status des Benutzers erlaubt nicht, dass der Vorgang ausgeführt wird.
• 409 – User's education plan is being calculated – Die Anfrage kann nicht ausgeführt werden, weil der Trainingsplan berechnet wird.
• 409 – cannot-join-group – Der Mitarbeiter kann nicht in die Gruppe verschoben werden.
• 500 – internal-server-error – Es ist ein interner Serverfehler aufgetreten.