Obtener contadores con asignaciones (por servicio)
Este endpoint permite consultar los datos de los contadores de un servicio en un periodo no superior a 31 días. Para el cálculo, solo se tendrán en cuenta las asignaciones.
GET /api/v2/businesses/{businessId}/services/{serviceId}/counters-with-only-assignments?businessCounterIds={id}&from={yyyy-MM-dd}&to={yyyy-MM-dd}|
Los identificadores que se deben utilizar en la URL ( |
Si los datos incluidos en la petición son correctos, la respuesta contendrá los datos de los contadores tal y como se muestra en el siguiente ejemplo:
GET /api/v2/businesses/BUSINESSID/services/SERVICEID/counters-with-only-assignments?businessCounterIds=4890&from=2024-11-18&to=2024-11-20[
{
"counter": {
"id": 4890,
"counterType": {
"id": 69,
"key": "counter.sundays_worked_per_month",
"shortName": "DTM",
"scope": "MONTH",
"dataType": "INTEGER"
}
},
"counts": [
{
"key": "DTM_20241101_20241130",
"from": "2024-11-01",
"to": "2024-11-30",
"total": [
{
"employeeId": "152020",
"count": 0.0
},
{
"employeeId": "152017",
"count": 1.0
},
{
"employeeId": "152014",
"count": 0.0
}
]
}
]
}
]En el ejemplo, el contador muestra el número de domingos trabajados al mes por cada empleado del servicio.
Este contador se representa en días: 1.0 equivale a un día.
Aspectos que tener en cuenta
La respuesta dependerá de la configuración del contador, como el ámbito (semanal, mensual, anual, etc.) o el tipo de dato (minutos, cantidad de días, etc.).
Se puede consultar la información de varios contadores en la misma petición incluyendo los diferentes identificadores en la URL, separados por comas: ?businessCounterIds=id1,id2,….
Si alguno de estos identificadores no se corresponde con los del negocio, la petición devolverá un error indicando No value present.
Si no hay asignaciones que repercutan en el contador para el periodo de tiempo indicado en la URL, el contador indicará 0.0.
Si el periodo de consulta es superior a 31 días, la petición devolverá un error 406 Not Acceptable, indicando The request exceded the maximum number of days allowed (31 days max).
Los empleados que no tengan configurado un identificador externo en el sistema employeeId, no aparecerán en la respuesta.
Enlaces de interés
¿Qué es un contador?
¿Qué es una asignación?