Obtener trayectorias formativas del negocio

Este endpoint devuelve todas las trayectorias formativas del catálogo del negocio.

GET /api/v2/businesses/{businessId}/training-paths

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

Ejemplo de respuesta

[
  {
    "id": "TP-CASHIER",
    "name": "Cajero",
    "description": "",
    "abbreviation": "CAJ",
    "color": "#1f7a5a",
    "courseIds": [
      "CRS-SAFETY",
      "CRS-ONBOARDING"
    ],
    "trainingsOrder": [
      {
        "trainingId": "TRN-PRL",
        "day": 1,
        "order": 1
      },
      {
        "trainingId": "TRN-WELCOME",
        "day": 1,
        "order": 2
      },
      {
        "trainingId": "TRN-CASH",
        "day": 2,
        "order": 1
      }
    ]
  }
]
Detalles

  • id: identificador externo de la trayectoria formativa.

  • name: nombre de la trayectoria formativa.

  • description: descripción de la trayectoria formativa. Si no se ha informado, se devuelve vacía.

  • abbreviation: abreviatura de la trayectoria formativa.

  • color: color de la trayectoria, en formato hexadecimal #rrggbb y en minúsculas.

  • courseIds: identificadores externos de los cursos que forman la trayectoria, en el orden en el que deben realizarse.

  • trainingsOrder: calendario completo de los entrenamientos de la trayectoria, ordenado por día y por orden dentro del día. Para cada entrenamiento, se incluye la siguiente información:

    • trainingId: identificador externo del entrenamiento.

    • day: día de la trayectoria en el que se realiza el entrenamiento, empezando en 1.

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

Consideraciones

Si no hay trayectorias formativas definidas 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 una trayectoria formativa?