GET /api/v1/paths/sessions/{session_id}
This route returns the details of a path session based on the session id. It returns an array with the following data:
-
sessionId: string, id of the path session. -
sessionName: string, name of the path session. -
sessionOwnerGroup: string, id of the group owning the session. -
sessionCreatedAt: string, date of creation of the session (ISO 8601). -
sessionModifiedAt: string, date of creation of the session (ISO 8601). -
instructorsMails: array of strings, list of the emails of the instructors for the session. -
startDate: string, start date of the session (ISO 8601). -
endDate: (optional) string, end date of the session (ISO 8601). -
pathName: string, name of the path. -
pathId: string, id of the path. -
pathOwnerGroup: string, id of the group owning the session. -
pathModifiedAt: string, last modification date of the path (ISO 8601). -
authorsMail: array of strings, list of the emails of the authors of the path. -
description: string, description of the path session. -
lang: language of the path. -
sourceLang: string, language (bigram) in which the path was originally created. -
translationLangs: array, list of all additional languages associated to the path. Each element is an object.-
lang: string, bigram of the language. -
published: boolean, whether the language is made available for learners or not. -
translators: array, list of the emails of the translators associated to the language.
-
-
pathEstimatedDuration: Array with the estimated duration of the path. Includes:-
value: Integer. Value of the estimated duration of the path. -
unit: String. Unit of the estimated duration of the path:minute,hour,day,weekormonth.
-
-
linear: Boolean.trueif the path steps must be played in a linear progression.falseif the steps can be played in any order. -
certificationOutlineId: (optional) id of the certification -
steps: Array with the steps included in the path. Includes:-
_id: String. Unique identifier of the path step. -
type: String. Type of the path step.
-
-
enrolledGroups: array with the ids of the groups enrolled in the session
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
session_id |
String | Yes |
The ID of the path session |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.