Docs home

Get PDF Teaching Material

Returns one teaching material with a time-limited link to its file. This example is a PDF. Use it to show or download a material's content in your own system.

GET/tutor/materials/{materialID}
Get PDF 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": 2531264,
    "description": "<p>The second question then is how to you use the various weights of the font. That is handled via using CSS via font-weight. In the Fiddle you will see I used style_formats to provide a few different classes you can use to apply font-weights to content in TinyMCE (the classes are defined in the content_style</p>",
    "file_name": "119651-Flowcharts.pdf",
    "material_name": "pdf 1.0",
    "type": "application/pdf",
    "material_source": "file",
    "is_lti": 0,
    "lti_tool_registration_id": null,
    "external_url": null,
    "is_active": 1,
    "section_id": 540097,
    "is_downloadable": 1,
    "is_watermarked": 0,
    "is_drm": 0,
    "watermark_text": "",
    "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": null,
    "is_prerequisite": 0,
    "platform_type": 1,
    "drm_library_id": 44173,
    "is_enterprise_drm": 0,
    "vdocipher_video_id": null,
    "vdocipher_transcoding_status": 1,
    "file_size": 57753,
    "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": "https://dme2wmiz2suov.cloudfront.net/User(3846680)/Course(84573)/Section(355798)/3923251-119651-Flowcharts.pdf?Expires=1791965179&Signature=VPut7OZzfsD7UDtM3F8KGc84D~m9-yUCWWNNrXEABf~hGXdP2bpwb9l~pzJC~yERvaivUmJ~LMC5kfsegpomkOsfB8YWxFEdPmkpnlJ0wYFu3rMeVSXioLxIS2VuQ-bSyXcKtSTHeiyKOWUBbnv2Kfl~EkqKOv4hIEHyoDLluTFPpD9UEmBH8ioDSUwoWwUKtUyJ4dXNpL2uvKaZHVl34XUBQVd9HZB4EWioX8MOBl7ZjgLbRqL7fkFDqabISD5KfrgcUeOpDloR8kCp~tWqm-Sjax7U11eB1vrMuaGlFT8~kgYb-IsvBDtu1HvhwmV0JY6y-94gqUvLlOPrT~ggtw__&Key-Pair-Id=APKAIIFZDCEANAVU2VTA",
    "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: 2531264
Example: 119651-Flowcharts.pdf
Example: pdf 1.0
MIME type
Example: application/pdf
file, external_url, html_text, feedback_form, lti
Example: file
Example: 0
Example: 1
Example: 540097
Example: 1
Example: 0
Example: 0
-1 = unlimited
Example: -1
Example: 0
Example: 0
Example: 0
Example: 1
Example: 44173
Bytes
Example: 57753
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