Obtener empleados de un servicio

Este endpoint devuelve la información de todos los empleados dentro de un servicio.

GET /api/v2/businesses/{businessId}/services/{serviceId}/employees

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

  • 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",
        "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
    }
]

Tal y como se aprecia en los ejemplos, la petición devolverá la información definida para cada uno de los empleados del servicio. Así, aquellos campos no obligatorios, cuya información no haya sido definida en Orquest, no aparecerán en la respuesta. Del mismo modo, los metadatos solo aparecerán en los negocios que hayan configurado previamente esta información para sus empleados.

Aspectos que tener en cuenta

Si el servicio 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 servicio indicado, la petición devolverá un array vacío [].

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?