Consultar peticiones de un empleado
Este endpoint permite consultar las peticiones de un empleado en un periodo de tiempo determinado no superior a 31 días.
GET /api/v1/businesses/{businessId}/employees/{employeeId}/requests?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 contendrá el listado de peticiones del empleado en el intervalo de tiempo definido:
[
{
"employeeId": "00001",
"status": "REQUESTED",
"type": "NON_WORKED",
"from": "2024-07-20",
"to": "2024-07-20"
},
{
"employeeId": "00001",
"status": "GRANTED",
"type": "MAYBE",
"from": "2024-07-21",
"to": "2024-07-21",
"fromHour": "10:00",
"toHour": "17:00"
},
{
"employeeId": "00001",
"status": "REQUESTED",
"type": "MANDATORY",
"from": "2024-07-25",
"to": "2024-07-25",
"fromHour": "10:00",
"toHour": "12:00"
}
]
Como se puede apreciar en el ejemplo, la información de la respuesta dependerá de los datos que se hayan definido para cada petición y el estado de estas en el sistema.
Aspectos que tener en cuenta
Los campos fromHour
y toHour
devuelven los valores en la hora local, determinada por la zona horaria configurada para el servicio.
Si el periodo de tiempo indicado en la URL es superior a 31 días, la petición devolverá un error 406 Not Acceptable
.
Si el identificador del empleado no es correcto, la petición devolverá un error 404 Not Found
indicando Employee not found.
Si no hay peticiones para el empleado en el intervalo de la consulta, la petición devolverá un array vacío []
.
Enlaces de interés
¿Qué es una petición?
¿Cómo es la estructura de una petición en la API?