SupplementalMaterial

← Back to Schema

Material associated with an instructional component that provides additional information about that component. Examples include Curriculum guides, Family course guides Student study guides.

Class Details

Parent Classes

AssociatedMaterial

Properties

Properties for SupplementalMaterial and its parent classes.

Property	Expected Type	Description
Properties of LearningComponent
forCourse	Course	The Course in which the resource is meant for.
forComponent	LearningComponent	Which LearningComponent the resource supports (inverse of hasComponent)
hasComponent	LearningComponent	Which LearningComponent the InstructionalPattern contains or is supported by (inverse of forComponent)
doTask	Task	Which tasks are to be completed for a LearningComponent
hasLearningObjective	LearningObjective	A LearningObjective gained as a result of an InstructionalPattern .
deliveryFormat	Format or Text	The format used to deliver the resource.
aiUsageConstraint	Text or URL	Specifies or references an external project that indicates restrictive or permissive language clarifying the level of generative technology usage that will enable the completion of the work a learning component sets (a task, an assessment, or a reading or lesson that asks for a response), but without undermining its pedagogical intent. Applies to any LearningComponent, so a constraint set on a unit or lesson covers the work within it unless a part states its own. Can be a URL to a formal framework definition (e.g., https://dmd-program.github.io/aiul/combinations/na-im.html), a short code reference (e.g., AIUL-NA-IM), or plain text description (e.g., 'No AI tools permitted'). Following the pattern of schema.org's license property, URLs are preferred for machine-readable interoperability.
Properties of Resource
parentOf	Resource	A parent in relation to a child resource.
childOf	Resource	A child in relation to a parent resource.
forCourse	Course	The Course in which the resource is meant for.
mainContent	Text	The main content relating to the item.
forTopic	Topic	The Topic the resource is associated with
prerequisite	Resource or CreativeWork	A resource to complete or understand before this one, such as an earlier activity this one builds on or a reading it assumes. For whole-course requirements use coursePrerequisites.

API Access

Access this class through the API

Endpoint:

/api/schema/class/SupplementalMaterial

Available formats:

Example usage:

curl -H "Accept: application/json" /api/schema/class/SupplementalMaterial

Examples

Implementation Examples

Below are examples of how to implement the SupplementalMaterial class in different formats.

{
  "@context": {
    "oer": "http://oerschema.org/",
    "schema": "http://schema.org/"
  },
  "@type": "oer:SupplementalMaterial",
  "oer:name": "ExampleSupplementalMaterial",
  "oer:description": "Material associated with an instructional component that provides additional information about that component. Examples include Curriculum guides, Family course guides Student study guides."
}