List of APIs related to external content (edX)
1. Only LumiNUS admin can call this API.
Format - uuid.
Bad Request
string
string
Login user not authorized to perform this action
string
string
the catalog is not found
string
string
Server Error
string
string
Returns internal course catalog information
1. Only LumiNUS admin can call this API.
Bad Request
string
string
Login user not authorized to perform this action
string
string
the catalog is not found
string
string
Server Error
string
string
Returns internal course catalog information
1. Get all external contents under a resource.
Format - uuid. Module ID
Format - int32.
Format - int32.
Accepted populate entities: creator, lastUpdatedUser, hitCount
Returns List of [API_ExternalLinks.API.ExternalContent]
[
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
]
[
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
1. Get information on single external content.
Format - uuid. External Content ID
Accepted populate entities: creator, lastUpdatedUser.
Returns [API_ExternalLinks.API.ExternalContent]
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Record is not found
string
string
Server Error
string
string
1. Delete an external content which was previously added to the module.
Format - uuid. ExternalContent ID
If delete is success
Bad Request
string
string
Login user not authorized to perform this action
string
string
Record is not found
string
string
Server Error
string
string
1. Get list of all edX courses.
Accepted populate entities: courseruns
Format - int32.
Format - int32.
Returns List of [API_ExternalLinks.API.edXCourseCatalog]
[
{
"uuid": "string",
"course": "string",
"title": "string",
"shortDescription": "string",
"fullDescription": "string",
"contentLanguage": "string",
"enrollmentUrl": "string",
"subjects": "string",
"owners": "string",
"video": "string",
"image": "string",
"contentType": "string",
"marketingUrl": "string",
"courseKey": "string",
"prerequisites": "string",
"programs": "string",
"aggregationKey": "string",
"availability": "string",
"pacingType": "string",
"dyom": true
}
]
[
{
"uuid": "string",
"course": "string",
"title": "string",
"shortDescription": "string",
"fullDescription": "string",
"contentLanguage": "string",
"enrollmentUrl": "string",
"subjects": "string",
"owners": "string",
"video": "string",
"image": "string",
"contentType": "string",
"marketingUrl": "string",
"courseKey": "string",
"prerequisites": "string",
"programs": "string",
"aggregationKey": "string",
"availability": "string",
"pacingType": "string",
"dyom": true
}
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
1. Get external contents/courses enrolled by logon user.
Format - int32.
Format - int32.
Returns List of [API_ExternalLinks.API.edXCourseCatalog]
[
{
"uuid": "string",
"courseKey": "string",
"title": "string",
"enrollmentUrl": "string",
"image": "string"
}
]
[
{
"uuid": "string",
"courseKey": "string",
"title": "string",
"enrollmentUrl": "string",
"image": "string"
}
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
1. Search by course title, course description, course key.
searched text
subject_subjectfilter, availability_availabilityfilter, pacingtype_pacingtypefilter or modularcredits_value. One item per filter.
Format - date-time (as date-time in RFC3339). start date of course run
Format - date-time (as date-time in RFC3339). end date of course run
Accepted populate entities: courseruns
Format - int32.
Format - int32.
Searched courses
{
"uuid": "string",
"course": "string",
"title": "string",
"shortDescription": "string",
"fullDescription": "string",
"contentLanguage": "string",
"enrollmentUrl": "string",
"subjects": "string",
"owners": "string",
"video": "string",
"image": "string",
"contentType": "string",
"marketingUrl": "string",
"courseKey": "string",
"prerequisites": "string",
"programs": "string",
"aggregationKey": "string",
"availability": "string",
"pacingType": "string",
"dyom": true
}
{
"uuid": "string",
"course": "string",
"title": "string",
"shortDescription": "string",
"fullDescription": "string",
"contentLanguage": "string",
"enrollmentUrl": "string",
"subjects": "string",
"owners": "string",
"video": "string",
"image": "string",
"contentType": "string",
"marketingUrl": "string",
"courseKey": "string",
"prerequisites": "string",
"programs": "string",
"aggregationKey": "string",
"availability": "string",
"pacingType": "string",
"dyom": true
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
1. To update details for the external content added in a module.
The information of the external contents to be edited
{
"id": "string",
"name": "string",
"publish": true,
"uuid": "string",
"url": "string",
"description": "string",
"remarks": "string",
"source": "string",
"owner": "string",
"type": "string"
}
{
"id": "string",
"name": "string",
"publish": true,
"uuid": "string",
"url": "string",
"description": "string",
"remarks": "string",
"source": "string",
"owner": "string",
"type": "string"
}
{
"id": "string",
"name": "string",
"publish": true,
"uuid": "string",
"url": "string",
"description": "string",
"remarks": "string",
"source": "string",
"owner": "string",
"type": "string"
}
{
"id": "string",
"name": "string",
"publish": true,
"uuid": "string",
"url": "string",
"description": "string",
"remarks": "string",
"source": "string",
"owner": "string",
"type": "string"
}
The updated [API_ExternalLinks.API.ExternalContent] record
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Record is not found
string
string
Server Error
string
string
1. Add an external content in module, or creating an external content in learning flow.
{
"resourceID": "string",
"lessonID": "string",
"name": "string",
"publish": true,
"uuid": "string",
"url": "string",
"description": "string",
"remarks": "string",
"source": "string",
"owner": "string",
"type": "string"
}
{
"resourceID": "string",
"lessonID": "string",
"name": "string",
"publish": true,
"uuid": "string",
"url": "string",
"description": "string",
"remarks": "string",
"source": "string",
"owner": "string",
"type": "string"
}
{
"resourceID": "string",
"lessonID": "string",
"name": "string",
"publish": true,
"uuid": "string",
"url": "string",
"description": "string",
"remarks": "string",
"source": "string",
"owner": "string",
"type": "string"
}
{
"resourceID": "string",
"lessonID": "string",
"name": "string",
"publish": true,
"uuid": "string",
"url": "string",
"description": "string",
"remarks": "string",
"source": "string",
"owner": "string",
"type": "string"
}
the added record
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
Delete multiple external contents from module.
{
"iDs": [
"string"
]
}
{
"iDs": [
"string"
]
}
{
"iDs": [
"string"
]
}
{
"iDs": [
"string"
]
}
Success
0
0
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
No Content
1. Add multiple external contents in module.
{
"resourceID": "string",
"iDs": [
"string"
],
"source": "string",
"lessonID": "string"
}
{
"resourceID": "string",
"iDs": [
"string"
],
"source": "string",
"lessonID": "string"
}
{
"resourceID": "string",
"iDs": [
"string"
],
"source": "string",
"lessonID": "string"
}
{
"resourceID": "string",
"iDs": [
"string"
],
"source": "string",
"lessonID": "string"
}
the added record
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"hitCount": 0,
"uuid": "string",
"url": "string",
"imageUrl": "string",
"description": "string",
"remarks": "string",
"owner": "string",
"type": "string",
"source": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
1. To log user hits on the external content in modules.
{
"id": "string"
}
{
"id": "string"
}
{
"id": "string"
}
{
"id": "string"
}
No Content
Bad Request
string
string
Login user not authorized to perform this action
string
string
Record not found
string
string
Server Error
string
string
1. To log user hits on self enrolled external content.
uuid
{
"id": "string"
}
{
"id": "string"
}
{
"id": "string"
}
{
"id": "string"
}
No Content
Bad Request
string
string
Login user not authorized to perform this action
string
string
Record not found
string
string
Server Error
string
string
1. To add courses listed on edX search page to Dashboard edX modules.
2. For purpose of self-enrolled courses.
{
"id": "string"
}
{
"id": "string"
}
{
"id": "string"
}
{
"id": "string"
}
No Content
Bad Request
string
string
Login user not authorized to perform this action
string
string
Record not found
string
string
Server Error
string
string
1. Delete enrolled external course from Dashboard.
Format - uuid. UUID to delete.
Returns the number of records deleted
0
0
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
1. Sync course runs information.
2. Only LumiNUS admin can call this API.
Returns internal course catalog information
{
"id": "string",
"courserunKey": "string",
"uuid": "string",
"startDate": "string",
"endDate": "string",
"enrollmentStart": "string",
"enrollmentEnd": "string",
"minEffort": 0,
"maxEffort": 0,
"pacingType": "string",
"weeksToComplete": 0,
"availability": "string",
"marketingUrl": "string",
"enrollmentUrl": "string",
"price": "string",
"type": "string",
"modularCredit": 0
}
{
"id": "string",
"courserunKey": "string",
"uuid": "string",
"startDate": "string",
"endDate": "string",
"enrollmentStart": "string",
"enrollmentEnd": "string",
"minEffort": 0,
"maxEffort": 0,
"pacingType": "string",
"weeksToComplete": 0,
"availability": "string",
"marketingUrl": "string",
"enrollmentUrl": "string",
"price": "string",
"type": "string",
"modularCredit": 0
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
the catalog is not found
string
string
Server Error
string
string
1. Get list of all edX subjects.
Returns List of [API_ExternalLinks.API.edXCourseCatalog]
[
"string"
]
[
"string"
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string
1. Sync course runs information.
2. Only LumiNUS admin can call this API.
Format - uuid.
Returns internal course catalog information
{
"id": "string",
"courserunKey": "string",
"uuid": "string",
"startDate": "string",
"endDate": "string",
"enrollmentStart": "string",
"enrollmentEnd": "string",
"minEffort": 0,
"maxEffort": 0,
"pacingType": "string",
"weeksToComplete": 0,
"availability": "string",
"marketingUrl": "string",
"enrollmentUrl": "string",
"price": "string",
"type": "string",
"modularCredit": 0
}
{
"id": "string",
"courserunKey": "string",
"uuid": "string",
"startDate": "string",
"endDate": "string",
"enrollmentStart": "string",
"enrollmentEnd": "string",
"minEffort": 0,
"maxEffort": 0,
"pacingType": "string",
"weeksToComplete": 0,
"availability": "string",
"marketingUrl": "string",
"enrollmentUrl": "string",
"price": "string",
"type": "string",
"modularCredit": 0
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
the catalog is not found
string
string
Server Error
string
string
1. Get list of all edX course filters with count.
Returns List of [API_ExternalLinks.API.edXCourseCatalog]
{
"subjects": [
{
"text": "string",
"count": 0
}
],
"pacingType": [
{
"text": "string",
"count": 0
}
],
"availability": [
{
"text": "string",
"count": 0
}
],
"modularCredits": [
{
"text": "string",
"count": 0
}
]
}
{
"subjects": [
{
"text": "string",
"count": 0
}
],
"pacingType": [
{
"text": "string",
"count": 0
}
],
"availability": [
{
"text": "string",
"count": 0
}
],
"modularCredits": [
{
"text": "string",
"count": 0
}
]
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Server Error
string
string