Obtener información de una trayectoria formativa

Este endpoint devuelve la información de una trayectoria formativa del catálogo del negocio, incluido el calendario de sus entrenamientos.

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

Si los datos incluidos en la petición son correctos —tanto el businessId como el trainingPathId—, la respuesta será un 200 OK con la información de la trayectoria formativa.

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

El trainingPathId que hay que especificar en la petición es el identificador externo de la trayectoria formativa.

La respuesta incluye siempre el calendario completo de entrenamientos, tanto si se definió de forma explícita como si lo calculó Orquest.

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

404 Not Found

Training path not found: <trainingPath>

El trainingPathId indicado no existe en el negocio.

Enlaces de interés

¿Qué es una trayectoria formativa?