Obtener asignaciones por servicio
Este endpoint devuelve las asignaciones de un servicio dentro de un periodo de tiempo no superior a 31 días.
GET /api/v2/business/{businessId}/services/{serviceId}/assignments/from/{yyyy-MM-dd}/to/{yyyy-MM-dd}
Si los datos incluidos en la petición son correctos —tanto el businessId como el serviceId—, la respuesta contendrá las asignaciones del servicio para ese periodo.
A continuación, se muestra un fragmento de respuesta:
[
{
"product": "0001-G",
"blockedType": "NONE",
"person": "1006355",
"day": "2024-05-02",
"presence": {
"worked": false,
"timeFrames": [
{
"startMinuteDay": 0,
"duration": 1425,
"paid": false,
"worked": false
}
]
}
},
{
"product": "0001-G",
"blockedType": "NONE",
"person": "1006355",
"day": "2024-05-04",
"presence": {
"worked": true,
"timeFrames": [
{
"startMinuteDay": 450,
"duration": 240,
"paid": true,
"location": {
"color": "#fed46b",
"description": "Perform commercial tasks: customer service, collection, orders at the point of sale...",
"name": "Sales",
"shortName": "S",
"requiredLevel": 1,
"priority": 5,
"type": "VARIABLE",
"shouldAvoidOvercover": false,
"system": false,
"category": "Operational",
"product": "0001-G",
"id": "03"
},
"worked": true
},
{
"startMinuteDay": 780,
"duration": 300,
"paid": true,
"location": {
"color": "#7f7f7f",
"description": "Creation of the workshop opening checklist",
"name": "Opening",
"shortName": "OP",
"requiredLevel": 1,
"priority": 5,
"type": "FIXED",
"shouldAvoidOvercover": false,
"system": false,
"category": "Operational",
"product": "0001-G",
"id": "01"
},
"worked": true
}
]
}
}
]
La primera asignación del ejemplo se corresponde con un día de descanso, ya que el campo worked
de la presencia es false
.
Además, solo tiene un timeFrame
sin tarea asociada, cuya duración es del día completo y tanto el campo paid
como el campo worked
también aparecen como false
.
En la segunda asignación del ejemplo, el campo worked
de la presencia es true
y se indican las características de las tareas desempeñadas por el empleado en cada timeFrame
.
El nivel de detalle de la respuesta dependerá de la configuración que se haya establecido en el negocio para las diferentes tareas.
Aspectos que tener en cuenta
Si no hay asignaciones para el periodo de tiempo indicado, la petición devolverá un array vacío []
.
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 el intervalo indicado en la URL es superior a 30 días, la petición devolverá un error 406 Not Acceptable
, especificando en el mensaje The request exceded the maximum number of days allowed.