Metodo "PATCH /openapi/v1/user/:userId"

Apporta modifiche ai dati dell'utente. Trasferimento di un dipendente dell'azienda in un altro gruppo di formazione.

Richiesta

Intestazione:

• Autorizzazione: token API dell'azienda.

Parametro:

• userId – una stringa: codice identificativo dell'utente specifico che viene spostato in un gruppo diverso.

  Deve soddisfare i seguenti criteri:

  • lunghezza massima di 24 caratteri
  • solo lettere minuscole

Esempio di richiesta: /openapi/v1/user/1ab2457896abcc1234567891

Corpo

Formato - JSON.

• groupId – una sequenza: ID del gruppo in cui verrà spostato il o la dipendente dell'azienda.

  Corrisponde all'ID del metodo "/openapi/v1/groups".

  L'ID deve soddisfare i seguenti criteri:

  • lunghezza massima di 24 caratteri
  • solo lettere minuscole
• fullName – una sequenza: nome e cognome del dipendente o della dipendente.
• shortName – una sequenza: nome del dipendente o della dipendente.
• email – una sequenza: indirizzo email del o della dipendente.

Esempio del corpo di una richiesta: { "groupId": "1ab2457896abcc1234567891", fullName : "Marvin John Mims" shortName : "Marvin Mims" email : "mims@mail.com" }

Risposta

JSON che contiene un array di dati su ciascun utente.

• userId – una sequenza: codice identificativo assegnato all'utente.
• currentGroup – un oggetto: un array di dati sul gruppo di utenti corrente.

  Nel seguente formato:

  {

  id,name

  }

  in cui:

  • id – una sequenza: chiave di identificazione del gruppo corrente.
  • name – una sequenza: nome del gruppo corrente.
• previousGroup – un oggetto: un array di dati sul gruppo di utenti precedente.

  Nel seguente formato:

  {

  id,name

  }

  in cui:

  • id: chiave di identificazione del gruppo precedente.
  • name: nome del gruppo precedente.
• currentFullName – una sequenza: nome e cognome correnti del dipendente o della dipendente.

  Il parametro viene generato solo se fullName è indicato nel JSON sorgente.

• previousFullName – una sequenza: nome e cognome precedenti del dipendente o della dipendente.

  Il parametro viene generato solo se fullName è indicato nel JSON sorgente.

• currentShortName – una sequenza: nome corrente del dipendente o della dipendente.

  Il parametro viene generato solo se shortName è indicato nel JSON sorgente.

• currentShortName – una sequenza: nome precedente del dipendente o della dipendente.

  Il parametro viene generato solo se shortName è indicato nel JSON sorgente.

• currentEmail – una sequenza: indirizzo email corrente del dipendente o della dipendente.

  Il parametro viene generato solo se e-mail è indicato nel JSON sorgente.

• previousEmail – una sequenza: indirizzo email precedente del dipendente o della dipendente.

  Il parametro viene generato solo se email è indicato nel JSON sorgente.

  Esempio di risposta: { userId : "1ab2457896abcc1234567891", "currentGroup" : {id" : "60e050803050c0704080a0e6", "name" : "Rischio ridotto"}, "previousGroup" : {id" : "61e151813151c1714181a1e6", "name" : "Rischio elevato"}, "currentFullName" : "Marvin John Mims", "previousFullName" : "Marvin Jon Mims", "currentShortName" : "Marvin Mims", "previousShortName" : "Marvin", "currentEmail" : "mims@mail.com", "previousEmail" : "johnmims@mail.com" }

Possibili errori:

• 200 – success: l'operazione è andata a buon fine.
• 400 – bad request: si è verificato un problema con la richiesta. Il cliente non deve ripetere la richiesta senza apportare modifiche.
• 400 – user-email-already-exists-in-company: l'indirizzo email specificato è già in uso presso l'azienda.
• 401 – common-unauthorized: si è verificato un errore di autenticazione.
• 402 – PAYMENT_REQUIRED: la licenza non è attiva.
• 403 – forbidden: il token non è autorizzato a utilizzare questo metodo.
• 404 – User not found: è stato trasmesso un indirizzo email non valido.
• 404 – Group not found: è stato trasmesso un ID del gruppo non valido.
• 409 – User status not supported for this operation: la richiesta non può essere eseguita; lo stato dell'utente non consente l'esecuzione dell'operazione.
• 409 – User's education plan is being calculated: la richiesta non può essere eseguita perché il piano formativo è in fase di calcolo.
• 409 – cannot-join-group: il o la dipendente non può essere spostato nel gruppo.
• 500 – internal-server-error: si è verificato un errore del server interno.

In alto