Obtener cursos del negocio

Este endpoint devuelve todos los cursos del catálogo del negocio, incluidos sus entrenamientos.

GET /api/v2/businesses/{businessId}/courses

Si el businessId incluido en la petición es correcto, la respuesta contendrá la lista de cursos del negocio.

Ejemplo de respuesta

[
    {
        "id": "CRS-CAJ",
        "name": "Caja",
        "description": "Medios de pago, operativa TPV y arqueo",
        "abbreviation": "CAJ",
        "color": "#f7c2e5",
        "expiresAfter": "P1Y",
        "requirementIds": [
            "CRS-VAC"
        ],
        "unlockCatalogLocationIds": [
            "000001"
        ],
        "trainings": [
            {
                "id": "TRN-CAJ-NOR",
                "name": "Normativa de caja y medios de pago",
                "description": "",
                "day": 1,
                "order": 1,
                "duration": "PT1H",
                "needsTrainer": false,
                "needsValidation": false
            },
            {
                "id": "TRN-CAJ-TPV",
                "name": "Operativa TPV",
                "description": "",
                "day": 1,
                "order": 2,
                "duration": "PT3H",
                "needsTrainer": true,
                "needsValidation": false,
                "coverCatalogLocationId": "000001"
            },
            {
                "id": "TRN-CAJ-ARQ",
                "name": "Arqueo y cuadre de caja",
                "description": "",
                "day": 2,
                "order": 1,
                "duration": "PT1H",
                "needsTrainer": true,
                "needsValidation": true
            }
        ]
    }
]
Detalles

  • id: identificador externo del curso.

  • name: nombre del curso.

  • description: descripción del curso. Si no se ha informado, se devuelve vacía.

  • abbreviation: abreviatura del curso.

  • color: color del curso, en formato hexadecimal #rrggbb y en minúsculas.

  • expiresAfter: periodo de validez de la aprobación del curso, en formato ISO-8601. No se incluye si la aprobación no caduca.

  • requirementIds: identificadores externos de los cursos que son requisito de este curso.

  • unlockCatalogLocationIds: identificadores externos de las tareas del catálogo que habilita el curso.

  • trainings: entrenamientos del curso, ordenados por día y por orden dentro del día. Para cada entrenamiento, se incluye la siguiente información:

    • id: identificador externo del entrenamiento.

    • name: nombre del entrenamiento.

    • description: descripción del entrenamiento.

    • day: día del curso en el que se realiza el entrenamiento, empezando en 1.

    • order: orden del entrenamiento dentro de su día.

    • duration: duración del entrenamiento, en formato ISO-8601.

    • needsTrainer: indica si el entrenamiento requiere formador.

    • needsValidation: indica si el entrenamiento se evalúa (superado o no superado) o solo se registra la asistencia.

    • coverCatalogLocationId: identificador externo de la tarea del catálogo que cubre el empleado durante el entrenamiento. No se incluye si no está definida.

Consideraciones

La respuesta solo incluye la versión vigente de cada curso.

Si no hay cursos definidos en el negocio, la petición devolverá un array vacío [].

Códigos de error

Este endpoint no devuelve códigos de error propios que no se encuentren descritos en errores comunes.

Enlaces de interés

¿Qué es un curso?