Obtener disponibilidad efectiva por empleado

Este endpoint permite consultar la disponibilidad efectiva de un empleado en un periodo de tiempo no superior a 32 días.

GET /api/v1/businesses/{businessId}/people/{employeeId}/effectiveDisponibilities?from={yyyy-MM-dd}&to={yyyy-MM-dd}

Si los datos incluidos en la petición son correctos —tanto el businessId como el employeeId—, la respuesta será un 200 OK con la disponibilidad del empleado.

Ejemplo de respuesta

[
    {
        "day": "2025-05-02",
        "type": "DAY_TYPE",
        "personId": "XX1",
        "free": false,
        "intervals": [
            {
                "from": "2025-05-02T08:00:00.000Z",
                "to": "2025-05-02T13:00:00.000Z"
            }
        ]
    },
    {
        "day": "2025-05-03",
        "type": "AVAILABILITY_PATTERN",
        "personId": "XX1",
        "free": false,
        "intervals": [
            {
                "from": "2025-05-03T16:00:00.000Z",
                "to": "2025-05-03T22:00:00.000Z"
            }
        ]
    },
    {
        "day": "2025-05-04",
        "type": "AVAILABILITY_PATTERN",
        "personId": "XX1",
        "free": false,
        "intervals": [
            {
                "from": "2025-05-04T16:00:00.000Z",
                "to": "2025-05-04T22:00:00.000Z"
            }
        ]
    },
    {
        "day": "2025-05-05",
        "type": "SHIFT_PATTERN",
        "personId": "XX1",
        "free": true,
        "intervals": []
    }
]
Detalles

  • day: día de la disponibilidad.

  • type: tipo de disponibilidad definido para este día. Los posibles valores son DAY_TYPE (tipo de día), SHIFT_PATTERN (patrones de turnos), AVAILABILITY_PATTERN (patrón de disponibilidad) y CALENDAR (calendario de asignaciones).

  • personId: identificador externo del empleado al que corresponde la disponibilidad.

  • free: si se trata de un día libre (true) o no (false).

  • intervals: intervalos de la disponibilidad.

    • from: fecha y hora de inicio de la disponibilidad.

    • to: fecha y hora de fin de la disponibilidad.

Tal y como se aprecia en el ejemplo, la petición devolverá la disponibilidad efectiva del empleado para cada uno de los días del periodo indicado en la URL.

Consideraciones

Si no hay intervalos de disponibilidad definidos para el empleado o para el rango de fechas de la petición, la respuesta contendrá un array vacío [].

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

400 Bad Request

From-date must be before to-date

La fecha indicada en to es anterior a la indicada en from. Se recomienda revisar el orden de las dos fechas de la URL. Este texto viaja en el campo cause; el campo message lo repite seguido de la lista de parámetros del error.

Enlaces de interés

¿Qué es la disponibilidad de un empleado?