Consultar parámetros de servicio

Este endpoint permite consultar el valor de los parámetros configurados para un servicio.

GET /api/v1/businesses/{business_id}/services/{service_id}/service_parameters/{key}

El valor de key se encuentra en la sección Configuración de negocio > Parámetros definidos, columna key.

Si los datos incluidos en la petición son correctos —businessId, serviceId y key—, la respuesta contendrá el valor definido para el parámetro dentro del servicio indicado, atendiendo a la siguiente estructura:

  • key: clave identificadora del parámetro.

  • categoryType: categoría en la que se incluye el parámetro. Puede ser:

    • PLANNING - Gestión de planificación.

    • NEEDS - Gestión de necesidades.

    • CLOCK_GUARD - Gestión de fichajes.

    • REPORTS - Gestión de informes.

    • OTHER - Parámetros globales.

  • values: valores definidos para el parámetro.

El contenido de la respuesta varía en función del parámetro de servicio que se quiera consultar y de cómo esté configurado en el sistema. A continuación, se muestran algunos ejemplos.

  • Ejemplo 1

  • Ejemplo 2

Para consultar los contadores que se muestran en el informe de nóminas, se realiza la siguiente petición:

GET /api/v1/businesses/{business_id}/services/{service_id}/service_parameters/payroll.businesscounters

La respuesta indica la configuración establecida para este parámetro, incluyendo la categoría (Gestión de informes/Reports) y los identificadores de los contadores seleccionados para este servicio.

[
    {
        "key": "payroll.businesscounters",
        "categoryType": "REPORTS",
        "values": {
            "value": [
                4866,
                4865
            ]
        }
    }
]

Para consultar los horarios configurados para la sección HD (home delivery), se realiza la siguiente petición:

GET /api/v1/businesses/{business_id}/services/{service_id}/service_parameters/HDTimetable

La respuesta indica la configuración establecida para este parámetro, incluyendo la categoría (Gestión de necesidades/Needs) y los diferentes valores para cada tipo de día.

[
    {
        "key": "HDTimetable",
        "categoryType": "NEEDS",
        "values": {
            "value": true,
            "dayTypeId": "MONDAY",
            "initTime": "10:00",
            "endTime": "15:00"
        }
    },
    {
        "key": "HDTimetable",
        "categoryType": "NEEDS",
        "values": {
            "value": true,
            "dayTypeId": "WEEKENDS",
            "initTime": "08:00",
            "endTime": "10:00"
        }
    },
    {
        "key": "HDTimetable",
        "categoryType": "NEEDS",
        "values": {
            "value": false,
            "dayTypeId": "WEDNESDAY",
            "initTime": "10:00",
            "endTime": "14:00"
        }
    }
]

Aspectos que tener en cuenta

Si el parámetro no está activo en el negocio o no se ha definido dentro del servicio ninguna configuración, la petición devolverá un error 404 Not Found indicando Service Param not Found.

Enlaces de interés

¿Qué es un parámetro de servicio/tienda?