GET /api/v1/paths/{userld}/getPaths

Returns all paths in which the user has been enrolled (individually, via a group, or via open registration).

Fields

For each path session:

• authorIds: List (array) of the ID of the main author and co-authors of the path.

• defaultLang: Default language of the path session (as a bigram: en, fr, de, etc.).

• instructorIds: List (array) of the ID of the main instructor and co-instructors of the path.

• pathId: ID of the path.

• pathName: Name of the path.

• sessionId: ID of the path session.

• sessionName: Name of the path session.

• sourceLang: Source language of the path session (as a bigram: en, fr, de, etc.).

• startDate: Date when the path session starts. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.

• stats:

  • progress: Percentage (in integer) of the user’s completion rate on the path session. 0 if the user hasn’t started it yet.
  • totalTimeSpentInSeconds: Number of seconds spent by the user on the path session.
  • score Percentage (in integer) of the user’s score on the path session. null if the user hasn’t completed it yet.
  • status: Status of the user. Possible values:
    • completed: all mandatory steps have been completed.
    • onTime: all steps with a due date that is passed have been completed, or are optional.
    • late: at least one non-optional step with a due date that is passed has not been completed.
    • successful: all steps have been completed.
    • unsuccessful: the minimum score of a step has not been reached.
  • completedAt: Date when the user has completed the path session. null if the user hasn’t completed it yet. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.
  • detailedStatus: Detailed status of the user, with the following fields:
    • type: Possible values are:
      • awaitingCorrection: The user reached an assessment step that the assessor hasn't validated yet.
      • late: The user started the path, but they are late on relative steps due dates for at least one mandatory step.
      • notYetStarted: The user is enrolled in an ongoing path session but they haven't started the path yet.
      • onTime: The user started the path, they haven't completed all the mandatory steps, and they haven't reached a blocking point.
      • sessionNotOpened: The user is enrolled in a path session that hasn't started yet.
      • successful: The user completed all the mandatory steps and fulfilled all the required conditions (time limit, minimum score, and/or mandatory replay).
      • toRetake: The user completed all the mandatory steps without fulfilling all the required conditions (time limit, minimum score, and/or mandatory replay), but they still haven't reached the maximum amount of authorized attempts (if any).
      • unsuccessful: The user had the status notYetStarted, onTime, late, or toRetake when the path session ended; or the user completed the path without fulfilling all the required conditions (time limit, minimum score, or mandatory replay), and they reached the maximum amount of authorized attempts.
    • reasult (optional): Only the following values are included in specific cases:
      • sessionEnded when type is unsuccessful because the session ended when the user status was either notYetStarted, onTime, late, or toRetake
      • mandatoryReplay when type is toRetake because the user completed some mandatory steps outside the path with mandatory replay.

• endDate (optional): Date when the path session ends. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.

• estimatedDuration (optional): Estimated duration of the path session.

  • unit: "month", "week", "day", "hour" or "minute".
  • value: integer.

Servers

• https://app.360learning.com

Path parameters

Query parameters

How to start integrating

1. Add HTTP Task to your workflow definition.
2. Search for the API you want to integrate with and click on the name.
   • This loads the API reference documentation and prepares the Http request settings.
3. Click Test request to test run your request to the API and see the API's response.