Obtener empleados de un producto

Este endpoint devuelve la información de todos los empleados con asociación a servicio activa dentro de un producto.

GET /api/v2/businesses/{businessId}/products/{productId}/employees

Si los datos incluidos en la petición son correctos —tanto el businessId como el productId—, la respuesta contendrá el listado de empleados del producto con toda la información definida para ellos.

Ejemplo de respuesta

  • Ejemplo 1

  • Ejemplo 2

[
    {
        "name": "Theodore",
        "surname": "Hayes",
        "email": "theohayes@bsn.com",
        "birthday": "1989-09-10",
        "employeeId": "209_14",
        "virtual": false
    },
    {
        "name": "Melanie",
        "surname": "Jenkins",
        "employeeId": "555",
        "virtual": false
    },
    {
        "name": "Andrea",
        "surname": "Meyer",
        "employeeId": "444",
        "metadata": {},
        "virtual": false
    },
    {
        "name": "Mariane",
        "surname": "Ortega Acevedo",
        "birthday": "2004-01-02",
        "employeeId": "1006350",
        "virtual": false
    }
]
[
    {
        "name": "ARIANA",
        "surname": "VISMARA",
        "group": "Responsible",
        "employeeId": "1493432",
        "metadata": {
            "language": "english"
        },
        "virtual": false
    },
    {
        "name": "CLARA",
        "surname": "SANDERS",
        "group": "Merchandising",
        "employeeId": "5690921",
        "metadata": {
            "or": "WOMAN"
        },
        "virtual": false
    },
    {
        "name": "MAYA",
        "surname": "SANTORO",
        "group": "General",
        "employeeId": "9454863",
        "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 producto indicado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found, especificando en el mensaje not exits.

Si no hay empleados en el producto indicado, o los empleados no tienen asociaciones a servicio activas, la petición devolverá un array vacío [].

Aunque existan metadatos definidos a nivel de negocio, solo se incluirán en la respuesta aquellos que tengan un valor asignado. Es decir, si un metadato no tiene un valor definido para un empleado, dicho campo no aparecerá en la respuesta correspondiente a ese empleado.

Enlaces de interés

¿Qué es un empleado?

¿Qué es una asociación a servicio?

¿Qué es un contrato? ¿Y un tipo de contrato?

¿Cómo integrar empleados?