# info.description
List of APIs related to external content (edX)

# paths./edXCatalogs/{catalog_id}.get.description
1. Only LumiNUS admin can call this API.

# paths./edXCatalogs/{catalog_id}.get.responses.403.description
Login user not authorized to perform this action

# paths./edXCatalogs/{catalog_id}.get.responses.200.description
Returns internal course catalog information

# paths./edXCatalogs.get.description
1. Only LumiNUS admin can call this API.

# paths./edXCatalogs.get.responses.403.description
Login user not authorized to perform this action

# paths./edXCatalogs.get.responses.200.description
Returns internal course catalog information

# paths./{ResourceID}/ExternalContent.get.description
1. Get all external contents under a resource.

# paths./{ResourceID}/ExternalContent.get.responses.403.description
Login user not authorized to perform this action

# paths./ExternalContent/{ID}.get.description
1. Get information on single external content.

# paths./ExternalContent/{ID}.get.responses.403.description
Login user not authorized to perform this action

# paths./ExternalContent/{ID}.delete.description
1. Delete an external content which was previously added to the module.

# paths./ExternalContent/{ID}.delete.responses.403.description
Login user not authorized to perform this action

# paths./edXCourseCatalog.get.responses.403.description
Login user not authorized to perform this action

# paths./enrolledexternalcontents.get.description
1. Get external contents/courses enrolled by logon user.

# paths./enrolledexternalcontents.get.responses.403.description
Login user not authorized to perform this action

# paths./searchedXCourseCatalog.get.description
1. Search by course title, course description, course key.

# paths./searchedXCourseCatalog.get.parameters[].description
Format - date-time (as date-time in RFC3339). start date of course run

# paths./searchedXCourseCatalog.get.parameters[].description
Format - date-time (as date-time in RFC3339). end date of course run

# paths./searchedXCourseCatalog.get.responses.403.description
Login user not authorized to perform this action

# paths./ExternalContent.put.description
1. To update details for the external content added in a module.

# paths./ExternalContent.put.requestBody.description
The information of the external contents to be edited

# paths./ExternalContent.put.responses.403.description
Login user not authorized to perform this action

# paths./ExternalContent.post.description
1. Add an external content in module, or creating an external content in learning flow.

# paths./ExternalContent.post.responses.403.description
Login user not authorized to perform this action

# paths./ExternalContent.delete.description
Delete multiple external contents from module.

# paths./ExternalContent.delete.responses.403.description
Login user not authorized to perform this action

# paths./ExternalContents.post.description
1. Add multiple external contents in module.

# paths./ExternalContents.post.responses.403.description
Login user not authorized to perform this action

# paths./Log.post.description
1. To log user hits on the external content in modules.

# paths./Log.post.responses.403.description
Login user not authorized to perform this action

# paths./LogEnrolled.post.description
1. To log user hits on self enrolled external content.

# paths./LogEnrolled.post.responses.403.description
Login user not authorized to perform this action

# paths./SignUp.post.description
1. To add courses listed on edX search page to Dashboard edX modules.
2. For purpose of self-enrolled courses.

# paths./SignUp.post.responses.403.description
Login user not authorized to perform this action

# paths./SignUp/{id}.delete.description
1. Delete enrolled external course from Dashboard.

# paths./SignUp/{id}.delete.responses.403.description
Login user not authorized to perform this action

# paths./edXCourseruns.get.description
1. Sync course runs information.

2. Only LumiNUS admin can call this API.

# paths./edXCourseruns.get.responses.200.description
Returns internal course catalog information

# paths./edXCourseruns.get.responses.403.description
Login user not authorized to perform this action

# paths./edXCourseSubjects.get.responses.403.description
Login user not authorized to perform this action

# paths./edXCourseruns/{catalog_id}.get.description
1. Sync course runs information.

2. Only LumiNUS admin can call this API.

# paths./edXCourseruns/{catalog_id}.get.responses.200.description
Returns internal course catalog information

# paths./edXCourseruns/{catalog_id}.get.responses.403.description
Login user not authorized to perform this action

# paths./edXCourseFilters.get.description
1. Get list of all edX course filters with count.

# paths./edXCourseFilters.get.responses.403.description
Login user not authorized to perform this action

# components.schemas.API_ExternalLinks.API.CourseRun.properties.enrollmentStart.description
The first date and time when this course run is open for learners to enroll. Learners cannot enroll before this date and time.

# components.schemas.API_ExternalLinks.API.CourseRun.properties.enrollmentEnd.description
The last date and time when this course run is open for learners to enroll. Learners cannot enroll after this date and time.

# components.schemas.API_ExternalLinks.API.CourseRun.properties.minEffort.description
The minimum number of estimated hours of effort per week.

# components.schemas.API_ExternalLinks.API.CourseRun.properties.maxEffort.description
The maximum number of estimated hours of effort per week.

# components.schemas.API_ExternalLinks.API.CourseRun.properties.pacingType.description
The pacing of the course. May be self-paced or instructor-paced.

# components.schemas.API_ExternalLinks.API.CourseRun.properties.weeksToComplete.description
The number of weeks required to complete the content item.

# components.schemas.API_ExternalLinks.API.CourseRun.properties.type.description
Type of track. Audit, verified, professional.

# components.schemas.API_ExternalLinks.API.ExternalContent.properties.creatorID.description
the ID of the user who created this record

# components.schemas.API_ExternalLinks.API.ExternalContent.properties.lastUpdatedDate.description
the date this record is edited last time

# components.schemas.API_ExternalLinks.API.ExternalContent.properties.lastUpdatedBy.description
the ID of the user who edited this record last time

# components.schemas.API_ExternalLinks.API.ExternalContent.properties.publish.description
the publish flag which determine whether the resource is published to students.

# components.schemas.API_ExternalLinks.API.ExternalContent.properties.parentID.description
the parent content ID if any. For those contents which do not have a parent content, the parent ID value will be the same as the ID.

# components.schemas.API_ExternalLinks.API.ExternalContent.properties.resourceID.description
the ID of the resource which this content belongs to.

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.uuid.description
The unique identifier for the course. Example: 0dbd8181-8866-47fc...

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.course.description
A unique identifier for the course. Example: edX+DemoX.

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.shortDescription.description
The short description of the content item and its content.

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.fullDescription.description
The long description of the course and its content.

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.subjects.description
The academic subjects that the course covers.

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.contentType.description
Type of learning item. course, courserun, program

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.courseKey.description
An identifier for the course. For example, RITx+PM9003x.

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.prerequisites.description
Any courses a learner must complete before enrolling in the current course.

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.programs.description
Any programs that the course is part of.

# components.schemas.API_ExternalLinks.API.edXCourseCatalog.properties.availability.description
The course availability current or upcoming.

# components.schemas.API_ExternalLinks.API.CourseEnrolled.properties.courseKey.description
An identifier for the course. For example, RITx+PM9003x.

# components.schemas.API_ExternalLinks.API.InputExternalContentForCreate.properties.lessonID.description
Lesson ID if it is created as a lesson activity

# components.schemas.API_ExternalLinks.API.InputExternalContentForCreate.properties.publish.description
the publish flag which determine whether the resource is published to students.

# components.schemas.API_ExternalLinks.API.InputExternalContentForCreate.description
HTTP Post Input class when creating ExternalContent

# components.schemas.API_ExternalLinks.API.InputExternalContentForUpdate.properties.publish.description
the publish flag which determine whether the resource is published to students.

# components.schemas.API_ExternalLinks.API.InputExternalContentForUpdate.description
HTTP Post Input class when updating ExternalContent

# components.schemas.API_ExternalLinks.API.InputBatchExternalContentForCreate.properties.lessonID.description
Lesson ID if it is created as a lesson activity

# components.schemas.API_ExternalLinks.API.InputBatchExternalContentForCreate.description
Input class for batch adding of external contents