POST /api/v1/externalContents/groups/{groupId}/externalPlatforms/{externalPlatform}/courses
Import external contents from an external platform by batch to a specific 360Learning group.
Each piece of external content is linked to a given external platform, a given 360Learning author, and imported into a given group library.
When imported, each piece of external content creates a course in the 360Learning platform.
Request Body
Type: application/json
Property | Type | Mandatory | Description |
---|---|---|---|
authorId | string | Yes | ID of the 360Learning author who will be the owner of the imported content. This ID must exist in the platform. The user must be an author or an admin of the group where the external content is imported. |
externalPlatformLogoUrl | string | No | The URL of the external platform's logo |
externalCourses | Array of externalCourse objects | Yes | The list of externalCourses to import |
externalCourse object
Property | Type | Mandatory | Description |
---|---|---|---|
externalId | string | Yes | ID of the external course, as identified by the external provider |
launchUrl | string | Yes | URL to launch and play the external course from a web browser |
mobileLaunchUrl | string | No | URL to launch and play the external course from a mobile. If not specified, the launchUrl is used for mobile access. |
thumbnailUrl | string | No | URL of the image of the external course |
title | string | Yes | Title of the external course |
description | string | No | Description of the external course (can contain HTML formatting) |
language | string | Yes | Main default language of the external course, using 360Learning language convention |
alternativeLanguages | Array of string | No | List of other languages available for the external course, using 360Learning language convention |
authors | Array of string | No | List of the authors of the external course |
courseDuration | number | No | Duration of the external course (in minutes) |
difficultyLevel | string | No | The level of difficulty of the external course: beginner , intermediate or advanced |
contentType | string | No | The type of the external course: article , audiobook , book , channel , course , curriculum , mooc , podcast , specialization , video . Default value is course . |
numberOfVideos | number | No | The number of videos / activities in the external course |
sources | Array of source objects | No | List of sources of the external course |
subjects | Array of string | No | List of subjects of the external course |
skills | Array of string | No | List of IDs of skills the external course refers to. These skills must exist in the platform. |
Source object
Property | Type | Mandatory | Description |
---|---|---|---|
name | string | Yes | Name of a source of the external course |
logo | string | No | URL of the source's logo |
Returns
Returns the status for each externalCourse imported and a global status report:
coursesCreated
: Total number of external courses importedcoursesUpdated
: Total number of external courses updatedimportErrors
: Total number of external that could not be importedexternalCoursesStatus
: An array ofexternalCoursesStatus
objectsexternalId
:externalId
of the externalCourse that was processed for importstatus
: HTTP status code for the import of the externalCourse:201
: externalCourse created successfully200
: externalCourse updated successfully404
: externalCourse import fails400
: externalCourse import fails because of a duplicated externalId
message
: Description of the HTTP status code:External course created
: HTTP status code 201External course updated
: HTTP status code 200Some skills not found
: HTTP status code 404Duplicated external id
: HTTP status code 400
Servers
- https://app.360learning.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
externalPlatform |
String | Yes |
Name of the external platform to which the external content is attached |
groupId |
String | Yes |
ID of the group where external contents were imported |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
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. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
authorId |
String | No | |
externalPlatformLogoUrl |
String | No | |
externalCourses[] |
Array | No | |
externalCourses[].description |
String | No | |
externalCourses[].thumbnailUrl |
String | No | |
externalCourses[].skills[] |
Array | No | |
externalCourses[].contentType |
String | No | |
externalCourses[].alternativeLanguages[] |
Array | No | |
externalCourses[].authors[] |
Array | No | |
externalCourses[].mobileLaunchUrl |
String | No | |
externalCourses[].numberOfVideos |
Number | No | |
externalCourses[].difficultyLevel |
String | No | |
externalCourses[].sources[] |
Array | No | |
externalCourses[].sources[].logo |
String | No | |
externalCourses[].sources[].name |
String | No | |
externalCourses[].launchUrl |
String | No | |
externalCourses[].externalId |
String | No | |
externalCourses[].title |
String | No | |
externalCourses[].subjects[] |
Array | No | |
externalCourses[].courseDuration |
Number | No | |
externalCourses[].language |
String | No |
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.