Obtener tareas por servicio

Este endpoint devuelve todas las tareas habilitadas dentro de un servicio para los diferentes productos.

GET /api/v1/businesses/{businessId}/services/{serviceId}/locations

Si los datos incluidos en la petición son correctos —tanto el businessId como el serviceId—, la respuesta contendrá las tareas habilitadas para cada producto y zona del servicio.

Ejemplo de respuesta

[
    {
        "color": "#c7d0e9",
        "description": "Opening tasks",
        "name": "OPENING",
        "shortName": "OP",
        "requiredLevel": 2,
        "priority": 4,
        "maxResources": 1,
        "type": "FIXED",
        "shouldAvoidOvercover": true,
        "system": false,
        "category": "Fixed tasks",
        "product": "0001-GENERAL",
        "id": "01",
        "active": true,
        "zone": "General"
    },
    {
        "color": "#c7d0e9",
        "description": "Opening tasks",
        "name": "OPENING",
        "shortName": "OP",
        "requiredLevel": 2,
        "priority": 4,
        "maxResources": 1,
        "type": "FIXED",
        "shouldAvoidOvercover": true,
        "system": false,
        "category": "Fixed tasks",
        "product": "0001-GENERAL",
        "id": "01",
        "active": true,
        "zone": "Z1"
    },
    {
        "color": "#425ea9",
        "description": "Replenishment of merchandise",
        "name": "REPLACEMENT",
        "shortName": "REP",
        "requiredLevel": 2,
        "priority": 3,
        "type": "FIXED",
        "shouldAvoidOvercover": false,
        "system": false,
        "category": "Operational",
        "product": "0001-GENERAL",
        "id": "05",
        "active": true,
        "zone": "General"
    }
]
Detalles

  • color: color configurado en Orquest para la tarea.

  • description: descripción de la tarea definida en Orquest.

  • name: nombre de la tarea en Orquest.

  • shortName: abreviatura de la tarea en Orquest.

  • requiredLevel: nivel de aptitud requerido para realizar la tarea. Va de 0 (sin necesidad de formación) a 3 (nivel máximo de formación) y debe ser previamente configurado en Orquest.

  • priority: prioridad de cobertura de la tarea. Va de 0 (baja) a 5 (alta) y debe ser previamente configurada en Orquest.

  • maxResources: límite de personas para la tarea.

  • type: tipo de tarea, si es fija, variable o no planificable (FIXED, VARIABLE, NON_PLANIFIABLE).

  • shouldAvoidOvercover: si este parámetro es true, la tarea no se sobrecubrirá.

  • system: determina si la tarea ha sido creada por el sistema (true) o por el usuario (false).

  • category: categoría de la tarea previamente configurada en Orquest.

  • product: identificador externo del producto o sección.

  • id: identificador externo de la tarea.

  • metadata: cualquier dato adicional que se haya configurado previamente para la tarea en Orquest. La estructura de los metadatos debe configurarse previamente.

  • zone: lugar físico del servicio (tienda, restaurante, etc.) donde se realiza la tarea.

Como se puede apreciar en el ejemplo, si una tarea está habilitada en varias zonas del producto, la respuesta contendrá la información para cada una de las zonas: en este caso, la tarea OPENING está en las zonas General y Z1 del producto 0001-GENERAL.

Si hubiera más productos dentro del servicio con esas tareas habilitadas, aparecería una tarea por cada producto y zona.

El nivel de detalle de la respuesta dependerá de la información que se haya definido previamente para la tarea. Por ejemplo, si no se ha añadido descripción (description), no aparecerá este campo.

Aspectos que tener en cuenta

Si no hay tareas activas en el servicio 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.

Enlaces de interés

¿Qué es una tarea?