Méthode « PATCH /openapi/v1/user/:userId »

Apporter des modifications aux données de l'utilisateur. Déplacement d'un employé de l'entreprise vers un autre groupe de formation.

Demande

En-tête :

• Autorisation : le jeton API de l'entreprise.

Paramètre :

• userId : une chaîne – code d'identification de l'utilisateur particulier qui est déplacé vers un groupe différent.

  Il doit répondre aux critères suivants :

  • longueur de 24 caractères
  • uniquement des lettres minuscules

Exemple de demande : /openapi/v1/user/1ab2457896abcc1234567891

Corps

Format : JSON.

• groupId : une chaîne – identifiant du groupe dans lequel l'employé de l'entreprise sera déplacé.

  Il correspond à l'identifiant de la méthode « /openapi/v1/groups ».

  L'identifiant doit répondre aux critères suivants :

  • longueur de 24 caractères
  • uniquement des lettres minuscules
• fullName : une chaîne – le nom complet de l'employé.
• shortName : une chaîne – le nom court de l'employé.
• email : une chaîne – l'adresse email de l'employé.

Exemple du corps d'une demande : { "groupId": "1ab2457896abcc1234567891", fullName : "Marc Julien Beauvert" shortName : "Marc Beauvert" email : "beauvert@mail.com" }

Réponse

JSON contenant un tableau de données sur chaque utilisateur.

• userId : une chaîne – le code d'identification attribué à l'utilisateur.
• currentGroup : un objet – un tableau de données sur le groupe d'utilisateurs actuel.

  Dans le format suivant :

  {

  id,name

  }

  where:

  • id : une chaîne – la clé d'identification du groupe actuel
  • name : une chaîne – le nom du groupe actuel.
• previousGroup : un objet – un tableau de données sur le groupe d'utilisateurs précédent.

  Dans le format suivant :

  {

  id,name

  }

  where:

  • id : clé d'identification du groupe précédent.
  • name : le nom du groupe précédent.
• currentFullName : une chaîne – le nom complet actuel de l'employé.

  Le paramètre est généré uniquement si fullName est indiqué dans la source JSON.

• previousFullName : une chaîne – le nom complet précédent de l'employé.

  Le paramètre est généré uniquement si fullName est indiqué dans la source JSON.

• currentShortName : une chaîne – le nom abrégé actuel de l'employé.

  Le paramètre est généré uniquement si shortName est indiqué dans la source JSON.

• currentShortName : une chaîne – le nom abrégé précédent de l'employé.

  Le paramètre est généré uniquement si shortName est indiqué dans la source JSON.

• currentEmail : une chaîne – l'adresse email actuelle de l'employé.

  Le paramètre est généré uniquement si email est indiqué dans la source JSON.

• currentEmail : une chaîne – l'adresse email précédente de l'employé.

  Le paramètre est généré uniquement si email est indiqué dans la source JSON.

  Exemple de réponse : { userId : "1ab2457896abcc1234567891", "currentGroup" : {id" : "60e050803050c0704080a0e6", "name" : "Rischio ridotto"}, "previousGroup" : {id" : "61e151813151c1714181a1e6", "name" : "Rischio elevato"}, "currentFullName" : "Marc Julien Beauvert", "previousFullName" : "Marc Julien Beauvert", "currentShortName" : "Marc Beauvert", "previousShortName" : "Marc", "currentEmail" : "beauvert@mail.com", "previousEmail" : "marcbeauvert@mail.com" }

Erreurs possibles :

• 200 : successful – l'opération a réussi.
• 400 : Bad Request – une erreur s'est produite dans la demande. Le client ne doit pas répéter la demande sans apporter de modifications.
• 400 : user-email-already-exists-in-company – cette adresse email est déjà utilisée dans l'entreprise.
• 401 : common-unauthorized – il y a eu une erreur d'authentification.
• 402 : PAYMENT_REQUIRED – la licence n'est pas active.
• 403 : forbidden – le jeton n'a pas le droit d'utiliser cette méthode.
• 404 : User not found – l'adresse email est incorrecte.
• 404 : Group not found – l'identifiant du groupe est incorrect.
• 409 : User status not supported for this operation – la demande ne peut pas être exécutée ; l'état de l'utilisateur ne permet pas d'effectuer l'opération.
• 409 : User's education plan is being calculated – La demande ne peut être exécutée car le plan de formation est en cours de calcul.
• 409 : cannot-join-group – impossible de déplacer l'employé dans le groupe.
• 500 : internal-server-error – une erreur de serveur interne s'est produite.

Jusqu'au sommet