Obtener información de un empleado
Este endpoint devuelve la información de un empleado filtrado a través de su identificador (employeeId).
GET /api/v2/businesses/{businessId}/employees/{employeeId}Si los datos incluidos en la petición son correctos —tanto el businessId como el employeeId—, la respuesta contendrá la información definida para el empleado.
Ejemplo de respuesta
{
"name": "Olivia",
"surname": "García",
"birthday": "1987-05-07",
"employeeId": "170326",
"virtual": false
}{
"name": "Jane",
"surname": "Santos",
"group": "",
"employeeId": "010203",
"metadata": {
"light": true
},
"seniority": "2018-03-01",
"virtual": false
}Detalles
-
name: nombre del empleado.
-
surname: apellido(s) del empleado.
-
group: grupo al que pertenece el empleado.
-
email: el email del empleado.
-
birthday: fecha de nacimiento en formato
yyyy-MM-dd. -
employeeId: identificador del empleado en el sistema externo.
-
metadata: datos adicionales sobre el empleado. La estructura de este campo debe ser previamente configurada a nivel de negocio por el equipo de Orquest.
-
seniority: antigüedad del empleado en formato
yyyy-MM-dd. -
virtual: determina si se trata de un empleado real o uno virtual utilizado, por ejemplo, para realizar simulaciones.
Tal y como se aprecia en el ejemplo, la petición devolverá la información definida en el sistema, por lo que puede haber campos no obligatorios que no aparezcan en la respuesta.
Los metadatos solo aparecerán en los negocios que hayan configurado previamente esta información.
Aspectos que tener en cuenta
Si el identificador de empleado indicado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found, especificando en el mensaje Employee not found.
Enlaces de interés
¿Qué es un empleado?
¿Qué es una asociación a servicio?
¿Qué es un contrato? ¿Y un tipo de contrato?