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