Obtener cambios incrementales
Este endpoint devuelve los fichajes que han sufrido cambios desde la fecha indicada en la petición hasta la fecha actual.
GET /api/v1/businesses/{businessId}/clockguards/incremental?since={yyyy-MM-ddTHH:mm:ss.SSS}Si los datos incluidos en la petición son correctos, la respuesta contendrá los fichajes que han cambiado desde la fecha indicada en el parámetro since hasta la fecha actual.
Este parámetro debe ser una fecha dentro de los últimos 45 días en formato UTC.
Se trata de una respuesta paginada, por lo que, después de la primera llamada, en los encabezados de respuesta aparecerá un cursor a la página siguiente (next) que indica la URL de la siguiente petición incremental de fichajes.
Para obtener la siguiente página de datos, se debe realizar una petición a esa URL con el cursor:
GET /api/v1/businesses/{businessId}/clockguards/incremental?cursor=*******Será necesario repetir este proceso hasta que la respuesta no contenga la cabecera next, lo que indica que la paginación ha terminado y que no hay más datos que mostrar.
Ver ejemplo
[
{
"employeeId": "225577",
"day": "2024-07-15",
"clockGuards": [
{
"type": "WORK",
"orquestId": 249998207,
"product": "25292_HD",
"checkIn": "2024-07-15T11:00:00.000Z",
"checkOut": "2024-07-15T14:00:00.000Z",
"location": "HD",
"businessDay": "2024-07-15"
}
]
},
{
"employeeId": "222158",
"day": "2024-07-15",
"clockGuards": [
{
"type": "WORK",
"orquestId": 249998199,
"product": "25292_HD",
"checkIn": "2024-07-15T11:00:00.000Z",
"checkOut": "2024-07-15T14:00:00.000Z",
"location": "HD",
"businessDay": "2024-07-15"
},
{
"type": "WORK",
"orquestId": 249998200,
"product": "25292_HD",
"checkIn": "2024-07-15T16:30:00.000Z",
"checkOut": "2024-07-15T20:00:00.000Z",
"location": "HD",
"businessDay": "2024-07-15"
}
]
},
{
"day": "2024-07-17",
"clockGuards": []
}
]|
Como se puede ver en el ejemplo, los fichajes se agrupan por empleado y día. |
El objetivo de este endpoint es que un cliente pueda hacer peticiones recurrentes para mantener actualizados sus datos sin tener que realizar procesos de actualización excesivamente complejos. Gracias a esta petición, por tanto, se ofrece un listado que muestra el estado actual de los fichajes para que solo se tengan que sobreescribir los datos desactualizados.
Aspectos que tener en cuenta
Orquest solo almacena los últimos 45 días de cambios incrementales. Si el cliente no realiza una petición de cambios incrementales en ese periodo de tiempo, tendrá que realizar una petición completa de fichajes.
Debido a la complejidad de los datos, es difícil saber si un elemento ha cambiado cuando se hacen modificaciones masivas.
|
Este endpoint necesita ser habilitado previamente para el negocio dado su coste de cómputo y de memoria. |
Enlaces de interés
¿Qué es un fichaje?