Skip to main content

Show the LMS course link in the participant portal

Goal: a participant who opens their course in the Eduframe participant portal sees a link that takes them straight to the course in your LMS.

Eduframe stores this link on the planned course as external_content_url. Your middleware sets it once, right after it has created the LMS course. Eduframe takes care of showing it in the participant portal.

Feature flag

external_content_url requires the Course edition external link feature to be enabled on your Eduframe environment. Ask support@eduframe.com to switch it on before you test this step.

POST /api/v1/planned_courses/4211/external_content_url HTTP/1.1
Host: api.eduframe.nl
Authorization: Bearer <your api key>
Content-Type: application/json

{
  "url": "https://lms.example.com/course/view.php?id=812",
  "source": "Moodle"
}
FieldMeaning
urlThe deep link to the course in your LMS. Send null to remove the link.
sourceA label for the system the link points to, at most 50 characters. Administrators see it next to the link in Eduframe, so use the LMS name.

A successful call returns 204 No Content. The scope required is courses:modify.

Read the current value back on the planned course itself: GET /api/v1/planned_courses/4211 returns external_content_url.

When to set it​

  • Right after you create the LMS course from planned_course.created, or during the initial import.
  • Again whenever the LMS URL changes, for example after you move to a new LMS domain.
  • With null when the edition is canceled and the LMS course is no longer reachable.

Where it appears​

Participants see the link on their course in the participant portal. Administrators see the link and its source on the course edition in the admin interface. Read more about the portal in Participant and Business Portal.