Docs home

Get Text/HTML Teaching Material

Returns one teaching material. This example is a text/HTML material (`material_source` = `html_text`), whose content is in `html_text`.

GET/tutor/materials/{materialID}
Get Text/HTML Teaching Material
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/tutor/materials/{materialID}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Teaching material retrieved successfully",
  "material": {
    "material_id": 2531259,
    "description": "",
    "file_name": "",
    "material_name": "fsd",
    "type": "",
    "material_source": "html_text",
    "is_lti": 0,
    "lti_tool_registration_id": null,
    "external_url": null,
    "is_active": 1,
    "section_id": 540097,
    "is_downloadable": 0,
    "is_watermarked": 0,
    "is_drm": 0,
    "watermark_text": null,
    "max_views": -1,
    "free_preview_limit": null,
    "external_video_play": 0,
    "ispring_cloud_link": null,
    "drm_url": "",
    "drm_transcoding_status": 0,
    "vimeo_url": 0,
    "is_vimeo_drm": 0,
    "vimeo_transcoding_status": 1,
    "html_text": "<p><a href=\"https://demoacademy.edmingle.com/contact-us\" target=\"_blank\" rel=\"noopener\">CLICK HERE TO KNOW MORE</a></p>\n",
    "is_prerequisite": 0,
    "platform_type": 1,
    "drm_library_id": 44173,
    "is_enterprise_drm": 0,
    "vdocipher_video_id": null,
    "vdocipher_transcoding_status": 1,
    "file_size": null,
    "is_videocrypt_drm": 0,
    "videocrypt_video_id": null,
    "videocrypt_transcoding_status": 1,
    "vdocipher_video_id_for_direct_upload": null,
    "scorm_status": 0,
    "feedback_form_id": null,
    "material_language_id": null,
    "thumbnail_url": null,
    "custom_thumbnail_file_id": null,
    "url": "",
    "video_completion_percentage": 30
  }
}

Access: Institute admins, tutors who contribute to the material's course, learners and parents, plus custom roles that can view curriculum.

Path parameters
materialIDintegerrequired
Teaching material ID. Must belong to your institute.
Query parameters
is_editinteger
1 returns SCORM package setup details instead of a launch link. Only matters for SCORM materials.
For institutes with multilingual materials: return the version in this language. Defaults to the default language.
device_idinteger
Your device ID. Used only to issue Secure DRM video playback details.
Device or browser name, for Secure DRM videos.
device_osstring
Operating system, for Secure DRM videos.
1 skips generating Secure DRM and Vimeo DRM playback details.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Teaching material retrieved successfully
materialobject
Show child attributesHide child attributes
Example: 2531259
Example: fsd
MIME type
file, external_url, html_text, feedback_form, lti
Example: html_text
Example: 0
Example: 1
Example: 540097
Example: 0
Example: 0
Example: 0
-1 = unlimited
Example: -1
Example: 0
Example: 0
Example: 0
Example: 1
Example: 44173
Example: 0
Share of a video a learner must watch for it to count as done; default 30
Example: 30

Notes: Fails with "Invalid Teaching Material provided" if the ID is not in your institute, and "File does not exist !" if the stored file is missing. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI