Get training path information

This endpoint returns the information of a training path from the business catalog, including the schedule of its trainings.

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

If the data included in the request is correct —both the businessId and the trainingPathId—, the response will be a 200 OK with the training path information.

Response example

{
  "id": "TP-CASHIER",
  "name": "Cashier",
  "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
    }
  ]
}
Details

  • id: external identifier of the training path.

  • name: name of the training path.

  • description: description of the training path. If it was not provided, it is returned empty.

  • abbreviation: abbreviation of the training path.

  • color: color of the training path, in hexadecimal #rrggbb format and in lowercase.

  • courseIds: external identifiers of the courses that make up the training path, in the order in which they must be taken.

  • trainingsOrder: full schedule of the trainings of the training path, sorted by day and by order within the day. For each training, the following information is included:

    • trainingId: external identifier of the training.

    • day: day of the training path on which the training takes place, starting at 1.

    • order: order of the training within its day.

Considerations

The trainingPathId that must be specified in the request is the external identifier of the training path.

The response always includes the full training schedule, whether it was defined explicitly or calculated by Orquest.

Error codes

In addition to the common errors, this endpoint can return the following codes:

Code Message Description

404 Not Found

Training path not found: <trainingPath>

The given trainingPathId does not exist in the business.

Useful links

What is a training path?