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
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.material_language_idinteger
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_namestring
Device or browser name, for Secure DRM videos.
device_osstring
Operating system, for Secure DRM videos.
ignore_device_typeinteger
1 skips generating Secure DRM and Vimeo DRM playback details.Response
codeinteger
Example:
200messagestring
Example:
Teaching material retrieved successfullymaterialobject
Show child attributesHide child attributes
material.material_idinteger
Example:
2531259material.descriptionstring
material.file_namestring
material.material_namestring
Example:
fsdmaterial.typestring
MIME type
material.is_ltiinteger
Example:
0material.is_activeinteger
Example:
1material.section_idinteger
Example:
540097material.is_downloadableinteger
Example:
0material.is_watermarkedinteger
Example:
0material.is_drminteger
Example:
0material.external_video_playinteger
Example:
0material.drm_urlstring
Example:
0material.vimeo_urlinteger
Example:
0material.is_vimeo_drminteger
Example:
0Example:
1material.html_textstring
material.is_prerequisiteinteger
Example:
0material.platform_typeinteger
Example:
1material.drm_library_idinteger
Example:
44173material.is_enterprise_drminteger
Example:
0Example:
1Bytes
material.is_videocrypt_drminteger
Example:
0Example:
1material.scorm_statusinteger
Example:
0material.urlstring
Share of a video a learner must watch for it to count as done; default 30
Example:
30Notes: 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.