GET /api/v1/courses/{course_id}
Return the details of a course.
Fields
-
_id
(string): Unique identifier of the course. -
author
(string): Email address of the course’s main author. -
creationDate
(string): Date and time of the course creation, in ISO 8601 format. -
description
(string): Contents of the fieldDescription
in the course. -
defaultLang
(string): Default language for the course. -
modificationDate
(string): Date and time of the last modification of the course, in ISO 8601 format. -
name
(string): Title of the course. -
externalPlatform
(string): Optional. Name of the external platform if the course is attached to an external content provider. -
sourceLang
(string): Source language for the course. -
status
(string): Status of the course. Possible values arepublished
orarchived
. -
type
-
coAuthors
(array of strings): List of email addresses of co-authors of the course. -
group
(string): Unique identifier of the course’s owner group. -
courseDuration
(integer): Duration of the course (in minutes). -
groupName
(string): Name of the course’s owner group. -
reactionScore
(integer): Reaction Score of the course. -
relevanceScore
(integer): Relevance Score of the course. -
translationLangs
(array): List of languages added to the course, with the following fields:-
lang
(string): Bigram of the language. -
published
(boolean):true
if the language is available in playing mode for the course.false
otherwise. -
translators
(array of strings): List of the email addresses of the translators.
-
Changelog :
-
Milestone C (March 22)
- The groupName is now returned
-
Milestone V (Oct 21)
-
The draft state does not exist anymore
-
The optional publishedAt field is not returned any more
-
Added the courseDuration field
-
-
June 15th, 2022: added
reactionScore
andrelevanceScore
, and detailed each returned field. -
Oct 19th, 2022: added
courseDuration
-
Nov 9th, 2022: added
sourceLang
anddefaultLang
Servers
- https://app.360learning.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
course_id |
String | Yes |
Identifier of the course. |
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.