GET /api/v1/programs/sessions/{session_id}/
Get information about a given program session.
Returns:
-
_id: String. Program session id -
name: String. Program session name. -
author: String. Program session author’s mail. -
description: String. Session description. -
startDate: String. Program session start date (GMT). -
endDate: String. Program session end date (GMT). -
hasUserLimit: Boolean. True if the number of seats available for open registration ID is defined. -
lang: String. The language of the program session's content. -
modifiedAt: String. Date at which the program session was last modified (GMT). -
programDuration: Floating point. Estimated duration of the program session, in hours.nullif the program duration is not specified. -
programDurationType: Constant stringhour. -
programTemplate: String. The id of the program template for this session. -
tutors: Array. List of the referents’ mails. -
automatedReminders: Boolean. Indicates if automated reminders are set or not for the program session. -
sessionCustom: String. Session’s additional information. -
templateCustom: String. Template’s additional information. -
modules: Array. List of the program session modules. Includes_id(string) andtype(string) of each module in the program session.typecan be a course, a webinar or a classroom. -
groups: Array. List of group IDs assigned to this session. -
customFields: Array. List of available customFields for the program session and their value. -
requirements: Object. List of allcourses,programsandpathsset as requirements before allowing learners to start this program session. -
users: Array with users objects. Includes_id(string) andmail(string) of users.
NB: /programs/:program_id/ redirects to this route to prevent any backward compatibility break from the pre-program session era. (before September 2017)
Changelog :
-
June 21: added a number of fields
-
February 2021: added the groups field
-
March 20: added the programTemplate and hasUserLimit fields
-
Milestone O (sept 19): added "skills"
-
Milestone H (Nov 18): "description" and "userLimit" are now available.
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
session_id |
String | Yes |
Program session's id |
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.