Docs home

Create External URL Teaching Material

Adds a link (for example a YouTube video or any web page) as a teaching material in a curriculum section.

POST/tutor/materials
Create External URL Teaching Material
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/tutor/materials' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"material_name":"Youtube Video link","external_url":"https://youtu.be/sMPMiy0NsUs?si=kveJTADO6lovXylK&t=7","platform_type":1,"section_id":6174,"material_source":"external_url","type":"link","file_name":""}'
{
  "code": 200,
  "message": "Teaching material created successfully",
  "material": {
    "material_id": 17489,
    "file_name": null,
    "description": "<p>Teaching Material Description</p>",
    "material_name": "External URL Teaching Material",
    "material_source": "external_url",
    "type": "youtube",
    "external_url": "https://www.youtube.com/watch?v=UWMzKXsY9A4",
    "section_id": "6174",
    "is_drm": 0,
    "is_downloadable": null,
    "is_watermarked": null,
    "watermark_text": null,
    "is_enterprise_drm": 0,
    "display_index": 17489,
    "resource_type": 4
  }
}

Access: Institute admins and tutors of the course the section belongs to. Custom roles need the manage-curriculum permission and must also be an admin or a tutor of that course.

Request body: form-data with one field, JSONString, containing this JSON:

BodyJSONString
section_idintegerrequired
Curriculum section to add the material to. Must be in your institute, otherwise "Invalid Section ID".
material_namestringrequired
Name shown to learners. Letters, digits, spaces and common punctuation.
material_sourcestringrequired
Kind of material: file (uploaded file or video), external_url (link), html_text (text/HTML page), feedback_form, lti (external LTI tool) or vimeo (existing Vimeo video by ID).
descriptionstring (HTML)
Description or instructions shown with the material. External images in it are copied into Edmingle.
1 makes learners finish this material before they can open later items. Default 0.
Purpose unclear from code; it is stored with the material. The web app sends 1.
external_urlstringrequired
The link learners open. Stored as sent; it is not validated.
typestring
Label stored with the link. The web app sends link or youtube; the code does not check the value.

Set material_source to external_url for this request.

Response200application/json
codeinteger
Example: 200
messagestring
Example: Teaching material created successfully
materialobject
Show child attributesHide child attributes
Use it in later calls
Example: 17489
Example: <p>Teaching Material Description</p>
Example: External URL Teaching Material
Example: external_url
Example: youtube
Example: https://www.youtube.com/watch?v=UWMzKXsY9A4
Example: 6174
Example: 0
Position in the section
Example: 17489
Always 4, teaching material
Example: 4

Notes: Links are never downloadable. If the section is already published in a batch, enrolled learners get a "New Material Added" push notification. Errors: "Invalid Section ID" (section not found or not in your institute), and a tutor-only error if you are not an admin or tutor of the course. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI