Método «PATCH /openapi/v1/user/:userId»
Hacer cambios en los datos del usuario. Desplace a un empleado de la empresa a otro grupo de formación.
Solicitud
Encabezado:
- Authorization: El token de la API de la empresa.
Parámetro:
- userId - una cadena: Código de identificación del usuario específico que se va a mover a un otro grupo.
Debe cumplir los siguientes criterios:
- 24 caracteres de longitud.
- Solo letras minúsculas.
| Ejemplo de una solicitud:
|
Cuerpo:
Formato: JSON.
- groupId – una cadena: ID del grupo al que se moverá el empleado de la empresa.
Corresponde al ID del método «/openapi/v1/groups».
El ID debe cumplir los siguientes criterios:
- 24 caracteres de longitud.
- Solo letras minúsculas.
- fullName – una cadena: El nombre completo del empleado.
- shortName – una cadena: El nombre corto del empleado.
- email – una cadena: La dirección de correo electrónico del empleado.
| Ejemplo del cuerpo de una solicitud:
|
Respuesta
JSON que contiene una matriz de datos sobre cada usuario.
- userId – una cadena: El código de identificación asignado al usuario.
- currentGroup – un objeto: Una matriz de datos sobre el grupo de usuarios actual.
En el siguiente formato:
{id,name}donde:
- id – una cadena: La clave de identificación del grupo actual.
- name – una cadena: El nombre del grupo actual.
- previousGroup – un objeto: una matriz de datos sobre el grupo de usuarios anterior.
En el siguiente formato:
{id,name}donde:
- id: La clave identificadora del grupo anterior.
- name: El nombre del grupo anterior.
- currentFullName – una cadena: El nombre completo actual del empleado.
El parámetro solo se genera si se indica fullName en el JSON de origen.
- previousFullName – una cadena: El nombre completo anterior del empleado.
El parámetro solo se genera si se indica fullName en el JSON de origen.
- currentShortName – una cadena: El nombre corto actual del empleado.
El parámetro solo se genera si se indica shortName en el JSON de origen.
- currentShortName – una cadena: El nombre corto anterior del empleado.
El parámetro solo se genera si se indica shortName en el JSON de origen.
- currentEmail – una cadena: La dirección de correo electrónico actual del empleado.
El parámetro solo se genera si se indica email en el JSON de origen.
- previousEmail – una cadena: La dirección de correo electrónico anterior del empleado.
El parámetro solo se genera si se indica email en el JSON de origen.
Ejemplo de una respuesta:
{
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"}
Posibles errores:
- 200 – success: La operación se ha realizado correctamente.
- 400 – bad request: Hay algún error con la solicitud. El cliente no debería repetir la solicitud sin hacer cambios.
- 400 – user-email-already-exists-in-company: Esta dirección de correo electrónico ya se está utilizando en la empresa.
- 401 - common-unauthorized: Ha ocurrido un error de autenticación.
- 402 – PAYMENT_REQUIRED: La licencia no está activa.
- 403 – forbidden: El token no tiene derecho a usar este método.
- 404 – User not found: Se ha pasado una dirección de correo electrónico incorrecta.
- 404 – Group not found: Se ha pasado un ID de grupo incorrecto.
- 409 – User status not supported for this operation: La solicitud no se puede ejecutar; el estado del usuario no permite realizar la operación.
- 409 – User's education plan is being calculated: No se puede ejecutar la solicitud porque se está calculando el plan de formación.
- 409 – cannot-join-group: El empleado no puede trasladarse al grupo.
- 500 – internal-server-error: Ha habido un error interno del servidor.