IMS Global Learning Consortium, Inc.

Caliper Analytics® Specification, version 1.1

IPR and Distribution Notices

Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.

IMS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on IMS’s procedures with respect to rights in IMS specifications can be found at the IMS Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.

The limited permissions granted above are perpetual and will not be revoked by IMS or its successors or assigns.

THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NON INFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER’S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.

1.0. Introduction

Delivering teaching and learning at scale is encouraging adoption of “big data” practices. Cloud computing and machine learning are changing both the learning technology landscape and the business of education. The definition of what constitutes learning is also evolving beyond the formal classroom experience to include informal, social and experiential modes of acquiring knowledge and skills. Opportunities exist to leverage new tools, tap new data sources, ask new questions and pursue new insights.

Consider the enterprising instructor seeking to augment if not transform the classroom environment for her students. She utilizes a video platform to create and post video assignments. Class discussions and Q&A sessions are conducted online using another service. She administers her course using a learning management system. Three services, three vendors, three potential sources of learning data.

Analyzing the viewing behavior of her students in relation to the questions they pose about her course content is vital to understanding student comprehension and performance. Yet exploring such relationships is all too often a challenging exercise. Likely there are significant barriers to overcome. Is the data required for analysis actually collected? If it exists, who owns it? If ownership is not an issue what about privacy concerns? If privacy protocols are in place is the data easy to retrieve? If retrievable how difficult is it to combine with data sourced from other platforms?

The Caliper Analytics® specification seeks to address a number of the issues outlined above by providing a structured approach to describing, collecting and exchanging learning activity data. Establishing a common vocabulary for describing learning interactions is a central objective. Promoting data interoperability, data sharing and data-informed decision making are also important goals.

Caliper also defines an application programming interface (the Sensor API™) for marshalling and transmitting event data from instrumented applications to target endpoints for storage, analysis and use. Industry-wide adoption of Caliper offers the tantalizing prospect of a more unified learning data environment in which to build new and innovative services designed to measure, infer, predict, report and visualize.

1.1 Status of this Document

This document is considered the Final Release. This means that the Caliper Analytics® Specification, version 1.1, is now made available as a public document following acceptance by IMS Global member organizations, a number of whom have successfully achieved conformance certification at the time of the release of this document.

IMS Global strongly encourages its members and the greater public to provide feedback that focuses on improving the Caliper specification. To join the IMS developer and conformance certification community focused on Caliper please visit https://www.imsglobal.org/activity/caliper.

Public comments and questions can be posted at the Caliper Analytics® public forum.

1.2 Summary of Changes

Caliper 1.1 extends as well as refines the Caliper information model and further describes the ways in which Events and Entities can be expressed as Linked Data when authoring documents using JSON-LD.

Regarding property changes, use of the JSON-LD@id and @type keywords have been deprecated in favor of id and type. The Caliper Event now includes an identifier id property as well as new referrer, session and extensions attributes. Entity property additions, name changes and deprecations also feature in this new release.

Sensor and endpoint behaviors are more fully described and the new specification also clarifies how to express Caliper events and entities in a JSON-LD document. A new Caliper JSON-LD context document is also provided to map Caliper terms to their respective IRIs.

1.3 Conventions

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119. A Sensor implementation that fails to implement a MUST/REQUIRED/SHALL requirement or fails to abide by a MUST NOT/SHALL NOT prohibition is considered nonconformant. SHOULD/SHOULD NOT/RECOMMENDED statements constitute a best practice. Ignoring a best practice does not violate conformance but a decision to disregard such guidance should be carefully considered by implementers. MAY/OPTIONAL statements indicate that implementers are entirely free to choose whether or not to implement the option.

1.4 Terminology

Actor: An actor is an Agent capable of initiating or performing an action on a thing or as part of a process. A Caliper Event includes an actor attribute for representing the Agent.

Blank Node Identifier: a string that begins with “_:” that is used to identify an Entity for which an IRI is not provided. An Entity provisioned with a blank node identifier is neither dereferenceable nor has meaning outside the scope of the JSON-LD document within which it resides.

Action: something performed or done to accomplish a purpose. Caliper Event subtypes define a controlled vocabulary of one or more actions relevant to the activity domain. A Caliper Event includes an action attribute for expressing the associated action.

Context: a special JSON-LD keyword that maps the terms employed in a JSON document to IRIs that link to one or more published vocabularies. Inclusion of a JSON-LD context provides an economical way of communicating document semantics to services interested in consuming Caliper event data.

Describe: a Caliper message containing an Entity that is not directly associated with an Event. Entities can be sent asynchronously from events using Describe messages in order to reduce verbosity (e.g. sending a Person entity as a Describe avoids having to repeat the Person object in each Event that includes it).

Endpoint: a receiver or consumer of Caliper data that is bound to a specific network protocol.

Entity: an object or a thing that participates in learning-related activity. Caliper Entity types provide coarsed-grained representations of applications, people, groups and resources that constitute the “stuff” of a Caliper Event. Each Entity corresponds to a node in a directed graph.

Envelope: a data structure that serves as a transport container of Caliper Event and Entity data. The envelope also includes metadata about the emitting Sensor and the data payload.

Event: describes a relationship established between an Agent (the actor) and an Entity (the object) formed as a result of a purposeful action undertaken by the actor in connection to the object at a particular moment in time.

JSON-LD: a specification providing a JSON-based data serialization and messaging format, processing algorithms and API for working with Linked Data. The messages described in this specification are intended to be used in programming environments that support JSON-LD.

IRI: The Internationalized Resource Identifier (IRI) extends the Uniform Resource Identifier (URI) scheme by using characters drawn from the Universal character set rather than US-ASCII per RFC 3987. Linked Data rely on IRIs to refer to most nodes and properties.

ISO 8601: Caliper data and time values are formatted per ISO 8601 with the addition of millisecond precision. The format is yyyy-MM-ddTHH:mm:ss.SSSZ where ‘T’ separates the date from the time while ‘Z’ indicates that the time is set to UTC.

Linked Data: A set of design principles first articulated by Tim Berners-Lee for discovering, connecting, and sharing structured data over the Web. The principles can be summarized as follows: use IRIs/URIs as names for things; use HTTP IRIs/URIs so that information about things (e.g., people, objects, concepts) can be retrieved using a standard format; link out to other relevant things by way of their IRIs/URIs in order to promote discovery of new relationships between things.

LIS: Learning Information Services® (LIS®) is an IMS standard that defines how systems manage the exchange of information that describes people, groups, memberships, courses and outcomes.

Metric Profile: models a learning activity or a supporting activity that helps facilitate learning. Each profile provides a domain-specific set of terms and concepts that application designers and developers can draw upon to describe common user interactions in a consistent manner using a shared vocabulary.

Object: an Entity that an Agent interacts with that becomes the focus, target or object of an interaction. A Caliper Event includes an object attribute for representing the resource.

Sensor: Software assets deployed within a learning application that implement the Sensor API™ for marshalling and transmitting Caliper data to a target endpoint.

Sensor API™: The standard set of methods and supported parameters that a Sensor implements according to this specification in order to transmit Caliper data in an interoperable way.

Term: a word or short expression that expands to an IRI when mapped to a JSON-LD context document. Terms are employed by Caliper as type property string values in order to distinguish between various JSON representations of entities and events defined by the Caliper information model.

Type Coercion: the process of coercing values to a particular data type.

URI: the Uniform Resource Identifier (URI) utilizes the US-ASCII character set to identify a resource. Per RFC 2396 a URI “can be further classified as a locator, a name or both.” Both the Uniform Resource Locator (URL) and the Uniform Resource Name (URN) are considered subspaces of the more general URI space.

URL: A Uniform Resource Locator (URL) is a type of URI that provides a reference to resource that specifies both its location and a means of retrieving a representation of it. An HTTP URI is a URL and using HTTP IRIs/URIs to identify things is fundamental to Linked Data.

URN: A Uniform Resource Name (URN) is a type of URI that provides a persistent identifier for a resource that is bound to a defined namespace. Unlike a URL a URN is location-independent and provides no means of accessing a representation of the named resource.

UUID: a 128-bit identifier that does not require a registration authority to assure uniqueness. However, absolute uniqueness is not guaranteed although the collision probability is considered extremely low. Caliper recommends use of randomly or pseudo-randomly generated version 4 UUIDs. Each Caliper Event MUST be assigned a UUID that is expressed as a URN using the form urn:uuid:<UUID> as described in RFC 4122.

2.0 The Information Model

The Caliper information model defines a set of concepts, rules, and relationships for describing learning activities. Each activity domain modeled is described in a Metric Profile (“profile”). Each profile is composed of one or more Event types. Each Event defines a controlled vocabulary of actions undertaken by learners, instructors, and others, that are scoped to the event. Various Entity types representing people, groups, and resources are provided in order to better describe both the relationships established between participating entities and the contextual elements relevant to the interaction.

2.1 The Caliper Event

A Caliper Event is a generic type that describes the relationship established between an actor and an object, formed as a result of a purposeful action undertaken by the actor at a particular moment in time and within a given learning context. The Event properties actor, action and object form a compact data structure that resembles an RDF triple linking a subject to an object via a predicate. A learner starting an assessment, annotating a reading, pausing a video, or posting a message to a forum, are examples of learning activities that Caliper models as events.

Caliper defines a number of Event subtypes, each scoped to a particular activity domain and distinguishable by a type attribute. The type value is a string that MUST match the Term specified for the Event by the Caliper information model (e.g. “MessageEvent”). Each Event instance is assigned a 128-bit long universally unique identifier (UUID) formatted as a URN per RFC 4122, which describes a URN namespace for UUIDs.

The information model also seeks to describe the learning environment or context in which a learning activity is situated. Group affiliation, membership roles and status, recent navigation history, supporting technology and session information can all be optionally represented. An Entity generated as a result of the interaction between an actor and an object can also be described; annotating a piece of digital content and producing an Annotation is one such example. An extensions property is also provided so that implementers can add custom attributes not described by the model.

Properties

Considered as a data structure an Event constitutes an unordered set of key:value pairs that is semi-structured by design. Optional attributes can be ignored when describing an Event. An Entity participating in an Event can be represented as an object or as a string that corresponds to the IRI defined for the Entity.

The base set of Event properties or attributes is listed below. Each property MUST be referenced only once. The id, type, actor, action, object and eventTime properties are required; all other properties are optional. Custom attributes not described by the model MAY be included but MUST be added to the extensions property as a map of key:value pairs. Properties with a value of null or empty SHOULD be excluded prior to serialization.

A string value corresponding to the Term defined for the Event in the external IMS Caliper JSON-LD context document. For a generic Event set the type to the string value Event. If a subtype of Entity is created, set the type to the Term corresponding to the subtype utilized, e.g., NavigationEvent.

The action or predicate that binds the actor or subject to the object. The action range is limited to the set of actions described in this specification and may be further constrained by the chosen Event type. Only one actionTerm may be specified per Event.

The Entity that comprises the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Event.

Deprecated subtypes

2.2 The Caliper Entity

A Caliper Entity is a generic type that represents objects that participate in learning-related activities. A variety of Entity subtypes have been defined in order to better describe people, groups, organizations, digital content, courses, software applications, and other objects that constitute the “stuff” of a Caliper Event. Each Entity is provisioned with a modest set of properties or attributes that support discovery and description.

Caliper permits Entity values to be expressed either as an object or as a string corresponding to the resource’s IRI.

If the Entity is expressed as an object, both the id and type properties MUST be specified. The type value is a string that MUST match the term specified for the Entity by the Caliper information model (e.g. “Person”). The id value is a string that MUST be expressed as an IRI. The IRI MUST be valid and unique. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource assuming authorization to access the resource is granted. A URI employing the URN scheme MAY be provided although care should be taken when employing a location-independent identifier since it precludes the possibility of utilizing it to retrieve machine-readable data over HTTP.

Other Entity properties are descriptive in nature, or link the Entity to other related entities. Certain Entity subtypes like Annotation, DigitalResource, Message or Organization are provisioned with additional properties that allow for a more complete representation of the object. An extensions property is also defined so that implementers can add custom attributes not described by the model. Optional properties can be ignored when describing an Entity.

Properties

Like an Event, an Entity is considered semi-structured data consisting of an unordered set of key:value pairs. The base set of Entity properties is listed below. Each property MUST be referenced only once. When representing an Entity as an object the id and type properties are required; all other properties are optional and need not be referenced when describing an Entity. Custom attributes not described by the model MAY be included but MUST be added to the extensions property as a map of key:value pairs. Properties with a value of null or empty SHOULD be excluded prior to serialization.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value corresponding to the Term defined for the Entity in the external IMS Caliper JSON-LD context document. For a generic Entity set the type value to the term Entity. If a subtype of Entity is created, set the type to the Term corresponding to the subtype utilized, e.g., Person.

Required

name

string

A string value comprising a word or phrase by which the Entity is known.

Optional

description

string

A string value comprising a brief, written representation of the Entity.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Entity was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Entity was last changed or updated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Entity.

Deprecated subtypes

3.0 Metric Profiles

The Caliper information model defines a number of metric profiles, each of which models a learning activity or a supporting activity that helps facilitate learning. A metric profile’s raison d’etre is to encourage vocabulary standardization and re-use among application providers delivering complementary, albeit competing capabilities that collect learning activity data. Each profile provides a domain-specific set of terms and concepts that application designers and developers can draw upon to describe common user interactions in a consistent manner using a shared vocabulary. Annotating a reading, playing a video, taking a test, or grading an assignment submission represent a few examples of the many activities or events that Caliper’s metric profiles attempt to describe.

Think of each metric profile as a stand-alone, logical container, or collection of one or more Caliper events that together help describe a set of inter-related activities. Each Event type included in a metric profile place constraints on the various entities and actions that can be utilized to describe a learning activity. Vocabulary restrictions are outlined in each profile description under the following headings:

supported events

supported actors

supported actions

supported objects

supported generated entities

supported target entities

other requirements

As an example, the Forum Profile models a set of activities associated with online discussions involving instructors and learners. The profile currently includes a ForumEvent, MessageEvent, NavigationEvent, ThreadEvent and ViewEvent. An action sequence mediated by the Forum Profile might involve a learner navigating to a forum, subscribing to it, viewing a thread, posting a message in reply to an earlier post and then marking the message as read.

3.1 Annotation Profile

The Caliper Annotation Profile models activities related to the annotation of a DigitalResource. Creating a bookmark, highlighting selected text, sharing a resource, tagging a document, and viewing an annotation are modeled. The generated Annotation is also described and is subtyped for greater type specificity.

As an example, instructors can use the places where students are making notes in the course material to determine whether they have the right idea about which material should be highlighted. In addition, if there are students who are asking questions or making notes indicating confusion about a particular piece of content, this can also inform the instructor about the suitability or quality of the material which they have chosen to use.

3.2 Assessment Profile

The Caliper Assessment Profile models assessment-related activities including interactions with individual assessment items. Caliper provides Assessment and AssessmentItem entities for describing the object of these activities, as well as a learner’s Attempt for recording a count of the number of times an assigned resource has been attempted. Five Response types are also provided for capturing individual item responses. Note that the Caliper 1.0 AssessmentItem Profile has been merged into the Assessment Profile.

Tracking patterns using the assessment profile will allow instructors to understand more about how students are interacting with their assessments. Typical ways to make use of this profile are to answer the following questions:

How much time is required to complete and submit an assessment?

How much time is spent answering individual questions?

Which questions are completed?

Which questions are skipped?

If test-taking times are flexible, when do learners start their assessments?

AssessmentItemEvent

NavigationEvent

ViewEvent

Supported Generated Entities

AssessmentEvent

AssessmentItemEvent

Other Requirements

For each AssessmentEvent described, the generatedAttempt SHOULD be specified. If the Attempt is expressed as an object the Attempt SHOULD define, at a minimum, the assignee, the assignable, and the count. Set the Attemptcount values as follows (per action):

Started: set the count value to 1 for a first attempt and increment by 1 for each subsequent attempt.

3.3 Assignable Profile

The Assignable Profile models activities associated with the assignment of digital content to a learner for completion according to specific criteria. Caliper provides a generic AssignableDigitalResource for describing the object of these activities as well as a learner’s Attempt for recording a count of the number of times an assigned resource has been attempted.

This profile would be useful for instructors to gather insight about the relationship between students and their assignments. Answers to the following questions can be enabled using this profile:

Supported Generated Entities

AssignableEvent

Other Requirements

If the Attempt is expressed as an object the Attempt SHOULD define, at a minimum, the assignee, the assignable, and the count. Set the count value to 1 for a first attempt and increment by 1 for each subsequent attempt.

3.4 Forum Profile

The Caliper Forum Profile models learners and others participating in online forum communities. Forums typically encompass one or more threads or topics to which members can subscribe, post messages and reply to other messages if a threaded discussion is permitted. Caliper provides Forum, Thread and Message entities for representing the object of these activities.

Tracking patterns using the forum profile will allow instructors to understand more about how students are engaged within discussion forums. Using this profile, instructors can gain insight in the following areas:

The grading profile allows information to be captured about grade changes for a given assessment or submission. This may be useful to understand the way in which students and teachers may be interacting throughout the course. For example, the grading profile can be used to answer questions such as:

Supported Generated Entities

GradeEvent

Other Requirements

3.6 Media Profile

The Caliper Media Profile models interactions between learners and rich content such as audio, images and video. Implementers can leverage a number of media-related entities including AudioObject, ImageObject and VideoObject, each subtyped from a generic MediaObject. A MediaLocation entity is also provided in order to represent the current location in an audio or video stream.

As an example of how this profile could be used, consider the following scenario: an instructor has decided to incorporate a video player into their course. The video content may or may not be launched via LTI from the Learning Management System (LMS). Since the video player tool is instrumented to emit activity data via Caliper, the instructor will be able to collect useful information about student viewing behavior. In addition, he will be able to compare this data along with other relevent information in the LMS, such as assignment and quiz results. Using data collected via Caliper, instructors (and administrators) can answer key questions, such as:

Who is using the tool?

Which videos are being played the most?

How long are they spending on each video?

Where do they pause the video?

Are there instances of where students are replaying sections of the video?

ViewEvent

Supported Objects

Supported Target Entities

Other Requirements

A Frame MAY be specified as the target in order to indicate an indexed segment or location.

3.8 Session Profile

The Caliper Session Profile models the creation and subsequent termination of a user session established by a Person interacting with a SoftwareApplication. A Session entity is described for representing the user session.

The session profile can facilitate the capture of data about who is logging into the learning environment, and more importantly, which students are not logging in. The following are examples of the information best captured using the session profile:

3.9 Tool Use Profile

The Caliper Tool Use Profile models an intended interaction between a user and a tool. In other words, when a Person utilizes a SoftwareApplication in a manner that the application determines to be its “intended use for learning”, an application that implements the Tool Use Profile can emit a ToolUseEvent indicating such usage.

The Tool Use Profile enables the gathering of basic usage information. It provides an easy way to get started with a base level of instrumentation by allowing the learning tool to make the determination of its own use. Any learning app can be instrumented using this profile to detect when a student accesses the tool and uses it in the way it was intended. Common questions that can be answered by using this profile include:

What tools are being used, and how much?

Who is the most active/least active user of tools?

Does tool usage help/hinder student performance?

Which tools have the greatest impact on student performance?

Supported Events

Supported Actors

Supported Actions

Supported Objects

3.10 Basic Profile

The Caliper Basic Profile provides a generic Event for describing learning or supporting activities that have yet to be modeled by Caliper. Any of the Caliper actions described in this specification can be used to describe the interaction between the actor and the object.

Supported Events

Supported Actors

Supported Actions

Supported Objects

Other Requirements

Use of the Basic Profile is strictly limited to describing interactions not modeled in other profiles. Any events described MUST be expressed using only the Event supertype.

4.0 Serialization of the Model

Over the last decade the advent of cloud-based, networked applications have led to changes in the way data is structured and represented. Data once considered strictly hierarchical, like a curriculum, a course roster, or a transcript now frequently link out to other kinds of data. Modeling bundles of data pointing to other bundles of data now requires thinking in terms of graphs and Linked Data. Caliper Event data presents us with similar structures. A Caliper Event can link to user data, digital content, courses and rosters, grades and credentials, institutional and organizational data, application and session data, and so on, the sources of which are likely diverse and the opportunities for discovering new relationships between the entities represented therein both numerous as well as enlightening.

Exchanging data linked to other data distributed across a wide network requires both a simple, well-understood data-interchange format as well as means of defining unambiguously the underlying semantics or meaning intended for the data structures transmitted from one machine to another. For Caliper, JSON-LD provides the necessary representational horsepower to both describe these kinds of data linkages and specify how data is to be understood when published and shared across a network.

JSON-LD defines an economical syntax for representing learning activity data as Linked Data using JSON as the underlying data-interchange format. JSON-LD also provides an API and set of processing algorithms for working with JSON-LD documents that are based on different contexts. Algorithms have also been developed to serialize RDF as JSON-LD and deserialize a JSON-LD document to an RDF data set.

4.1 JSON-LD Context

JSON-LD documents require inclusion of a context, denoted by the @context keyword, a property employed to map document Terms to IRIs. JSON-LD contexts can be embedded inline or referenced externally in a document. Inclusion of a JSON-LD context provides an economical way for Caliper to communicate document semantics to services interested in consuming Caliper event data.

If the top-level @context value is defined as an array of multiple contexts, the remote Caliper JSON-LD context MUST be listed last in order to ensure that Caliper terms retain their primacy given that JSON-LD parsers rely on a “most-recently-defined-wins” approach when evaluating duplicate terms.

Referencing the remote Caliper JSON-LD context document in the top-level @context is mandatory. The terms it defines MUST NOT be defined inline as an object.

Additional remote or inline local contexts may be referenced any time a JSON object is defined in order to ascribe meaning to terms not described by the model. These contexts are additive in nature and can be defined as a string, object or array. Duplicate context references SHOULD be omitted when serializing the object. Nested local contexts that are added to the active context at processing time MUST NOT override Caliper terms defined by the top-level context.

In the following example, @context is a top-level Event property with a value that references the remote Caliper JSON-LD context document. All of the Event key:value pairings are mapped to [IRIs] in the referenced context.

As noted above, a JSON-LD document can reference more than one context. Subject to the requirements listed above additional contexts MAY be defined for a Caliper Event or Entitydescribe in order to map non-Caliper vocabulary terms to their respective IRIs.

4.2 Identifiers

Linked Data relies on IRIs/URIs for the identification and retrieval of resources. Likewise, JSON-LD specifies the use of IRIs/URIs for identifying most nodes (i.e., JSON objects) and their attributes. Caliper too specifies the use of IRIs for identifying nodes (i.e., the things or entities being described) and their attributes.

IRI values MUST be absolute containing a scheme, path and optional query and fragment segments. A URI employing the URN scheme MAY be used as an identifier although care should be taken when employing a location-independent identifier since it precludes the possibility of utilizing it in future to retrieve machine-readable data over HTTP. If an IRI is deemed inappropriate for the resource a blank node identifier may be assigned.

JSON-LD provides a special @id keyword for assigning identifiers to nodes. For Caliper, the JSON-LD@id keyword is aliased as id in the external IMS Caliper JSON-LD context. This is done in order to avoid the temptation of employing JSON-LD keywords as property names and is aligned with JSON-LD community practice. Thus, each Caliper Event and Entity described by the model is provisioned with an id rather than @id property for identifying the resource.

Every Entity MUST be assigned an identifier in the form of a valid IRI or a blank node identifier. The IRI MUST be unique and persistent. The IRI SHOULD be dereferenceable; i.e., capable of returning a representation of the Entity. A URI employing the URN scheme MAY also be utilized.

Unlike Entities, each Event MUST be assigned a 128-bit long universally unique identifier (UUID) formatted as a URN per RFC 4122, which describes a URN namespace for UUIDs.

4.3 Types and Type Coercion

JSON-LD employs the @type keyword in two ways. Individual nodes (i.e., the thing being described) can be assigned a type. Values can also be associated with or coerced to a particular type. Both node types and typed values are specified in the Caliper JSON-LD context. As with the aliasing of @id as id, the @type keyword is aliased as type in the external IMS Caliper JSON-LD context in keeping with JSON-LD community practice.

Caliper permits Entity values to be expressed either as a JSON object or as a string corresponding to its IRI. JSON-LD also supports the coercion of data values to specified types based on value type mappings defined in a JSON-LD context. For a given @type the keywords @id or @vocab may be assigned as a value in order to signal to a JSON-LD parser that if a term’s instance value is set to a string it is to be interpreted as an IRI. Type coercion of this sort provides representational flexibility that implementers are encouraged to leverage.

The following MessageEvent example utilizes an inline context to illustrate how JSON-LD types can be specified in a context. The MessageEvent, Person and Message terms are all considered node types. Other terms illustrate the coercion of values to specified data types. In the example below, the values of the actor, object and edApp terms are coerced to the @id keyword. Use of this convention informs JSON-LD parsers that string values are to be interpreted as IRIs (as in the case of edApp). In a like manner, the action value is coerced to the @vocab keyword indicating that the value is to be interpreted as a Term defined in the active context or as an IRI; in this case Posted. Terms such as name, description, dateCreated, dateModified and duration are coerced to a particular value type such as a string, integer, boolean or date.

As the abbreviated ForumEvent example below demonstrates, in cases where an Event references the same Entity more than once (e.g., actor, member, user; group, organization), or a property is associated with a specific type (e.g., edApp) or an Entity possesses an IRI that is dereferenceable, consider expressing the value as a string corresponding to the entity’s IRI.

Example: membership and session references to actor and group expressed as IRIs

Indeed, the example ForumEvent could be thinned still further if each referenced Entity is provisioned with a dereferenceable IRI that permits consumers to retrieve a more robust representation of the object if required.

5.0 The Sensor API™

Caliper defines an application programming interface (the Sensor API™) for marshalling and transmitting data to a target endpoints. Adopting one or more metric profiles ensures adherence to the information model; implementing the Sensor provides instrumented platforms, applications and services with a transport interface for communicating with data consumers.

5.1 Behavior

create in-memory object representations of Caliper Event and Entity types as described in Section 2.0. The particular Event and Entity types that a Sensor must be capable of expressing are determined by the Metric Profiles implemented as described in Section 3.0.

express Entity values as either an object or a string corresponding to the resource’s IRI as described in Section 2.2.

A Sensor MAY be assigned other responsibilities such as validating Caliper Event and Entity data but such capabilities need not be exposed to learning data providers.

5.2 Envelope

Caliper Event and Entity data MUST be transmitted inside a Caliper Envelope, a purpose-built JSON data structure that includes metadata about the emitting Sensor and the data payload.

Properties

Caliper Envelope properties are listed below. The sensor, sendTime, dataVersion and data properties are required. Each property MUST be referenced only once. No custom properties are permitted.

Property

Type

Description

Disposition

sensor

string

A unique identifier assigned either to the Sensor or to the instrumented platform, application or service utilizing the Sensor. The identifier SHOULD be in the form of an IRI.

Required

sendTime

DateTime

A date and time string value expressed with millisecond precision that indicates the time at which the Sensor issued the message. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Required

dataVersion

string

A string value indicating which version of the IMS Caliper Analytics® specification governs the form of the Caliper entities and events contained in the data payload. The value MUST be set to the IMS Caliper ContextIRI used to resolve the meanings of the data payload’s terms and values.

5.4 HTTP Requests

A Caliper Sensor MUST be capable of transmitting Caliper data successfully to a Caliper Endpoint. Communication with an Endpoint is limited to message exchanges using the Hypertext Transport Protocol (HTTP) with the connection encrypted with Transport Layer Security (TLS).

Each message request MUST consist of a single JSON representation of a Caliper Envelope. Messages MUST be sent using the POST request method. The HTTP Host and Content-Type request header fields MUST be set.

A Sensor SHOULD also set the Authorization request header field using the “Bearer” authentication scheme described in RFC 6750, Section 2.1. The b64token authorization credential sent by a Sensor MUST be one the Endpoint can validate although the credential MAY be opaque to the emitting Sensor itself.

Request Header

Description

Disposition

Authorization

Set the string value to a bearer token using the “Bearer” authentication scheme described in RFC 6750, Section 2.1 (e.g., Authorization: Bearer <token value>).

Recommended

Content-Type

Set the string value to the IANA media type “application/json”.

Required

Host

Set the string value to the Internet host and port number of the resource being requested.

Required

6.0 Endpoint

A Caliper Endpoint MUST be capable of receiving Caliper data sent over HTTP by a Caliper Sensor using the standard POST request method. The connection MUST be secured with Transport Layer Security (TLS) and a valid TLS certificate provided. The Endpoint MUST be capable of accessing standard HTTP request headers and support message authentication that utilizes the HTTP Authorization request header “Bearer” authentication scheme as described in RFC 6750, Section 2.1.

6.1 HTTP Responses

Following receipt of a Sensor request message the Endpoint MUST reply with a response message. The response will include a three-digit status code indicating whether or not the Endpoint was able to understand and satisfy the request as defined by RFC 7231.

To signal a Sensor that it has successfully received an emitted Envelope an Endpoint MUST reply with a 2xx class status code. The Endpoint SHOULD use the 200 OK response but MAY instead choose to send a 201 Created response (to indicate successful receipt of the message and creation of a new resource) or a 202 Accepted response (to indicate successful acceptance of the message and queueing for further processing). The body of a successful response SHOULD be empty.

If the Sensor sends a message containing events and or entities without an enclosing Envelope, the Endpoint SHOULD reply with a 400 Bad Request response.

If the Sensor sends a malformed Caliper Envelope (it does not contain sensor, sendTime, dataVersion and data properties of the required form), the Endpoint SHOULD reply with a 400 Bad Request response. Note that the Endpoint SHOULD NOT send a 400 Bad Request response if the Envelope contains a dataVersion value that the Endpoint cannot support; in this case, the Endpoint SHOULD send a 422 Unprocessable Entity response instead.

If the Sensor sends a message with a Content-Type other than “application/json”, the Endpoint SHOULD reply with a 415 Unsupported Media Type response.

If the Sensor sends a message without an Authorization request header of the RECOMMENDED form or sends a token credential that the Endpoint is unable to either validate or determine has sufficient privileges to submit Caliper data, the Endpoint SHOULD reply with a 401 Unauthorized response.

The Endpoint MAY respond to Sensor messages with other standard HTTP status codes to indicate result dispositions that vary from the cases described above. The Endpoint MAY also communicate more detailed information about problem states, using the standard method for reporting problem details described in RFC 7807.

6.2 String Lengths and Storage

Certain Caliper data properties are expressed as strings of variable length. JSON-LD also defines a set of processing algorithms for transforming JSON-LD documents in ways that can change the length of keys and values that are expressed as IRIs, compact IRIs or Terms. Many implementers will choose to store each incoming Event and Entitydescribe received as a JSON-LD document or as a graph data structure consisting of nodes, edges and properties. Others may opt to normalize or “flatten” some or all of the nested JSON objects that comprise a Caliper Event or Entity. If the chosen persistence strategy involves normalizing Caliper semi-structured data, care should be taken to ensure that strings of character data can be stored without truncation. See Appendix G. Minimum Supported String Lengths for a list of Caliper data properties and recommended minimum string lengths.

Appendix A. Actions

Caliper includes a vocabulary of actions for describing learning interactions. Each action Term is based on the past-tense form of an English (en-US) verb. An action Term can also indicate a change in a particular characteristic of the object (e.g., resolution, size, speed, volume). Each action Term is mapped to a persistent IRI listed in the external IMS Caliper JSON-LD context. Each action is also linked to a brief definition (“gloss”) derived in whole or in part from Princeton University’s WordNet® project in order to eliminate ambiguity and aid natural language processing.

Each Caliper Event type supports one or more of the actions listed below. The Eventaction property string value MUST be set to the appropriate Term. Only one action may be specified per Event.

IRI

Supertype

Supported Actors

Supported Actions

Deprecated Actions

The following actions are deprecated and targeted for removal from the AnnotationEvent list of supported actions. The actions will be retained as entries in the Caliper actions vocabulary as many are likely to appear in future Metric Profiles.

the Person who initiated the action. The actor value MUST be expressed either as an object or as a string corresponding to the actor’s IRI.

Required

action

string

The action or predicate that binds the actor or subject to the object. The value range is limited to the supported action terms listed above. Only one action term may be specified per Event. DEPRECATED actions SHOULD NOT be utilized.

The annotated DigitalResource that constitutes the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the AnnotationEvent.

The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the AssessmentEvent.

The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the AssessmentItemEvent.

The action or predicate that binds the actor or subject to the object. The value range is limited to the action terms listed above. Only one actionTerm may be specified per Event. DEPRECATED actions SHOULD NOT be utilized.

The AssignableDigitalResource that constitutes the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

For Started, Completed and Reviewed actions, the actor’s Attempt SHOULD be specified. The generated value MUST be expressed either as an object or as a string corresponding to the generated entity’s IRI.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the AssignableEvent.

B.5 ForumEvent

A Caliper ForumEvent models learners and others participating in online forum communities. Forums typically encompass one or more threads or topics to which members can subscribe, post messages and reply to other messages if a threaded discussion is permitted.

The Forum that comprises the object of this interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the ForumEvent.

The completed Attempt. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the GradeEvent.

The MediaObject that constitutes the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

If the MediaEventobject is an AudioObject or VideoObject, a MediaLocation SHOULD be specified in order to provide the currentTime in the audio or video stream that marks the action. If the currentTime is specified, the value MUST be an ISO 8601 formatted duration, e.g., “PT30M54S”. The target value MUST be expressed either as an object or as a string corresponding to the target entity’s IRI.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the MediaEvent.

The Message that constitutes the object of the interaction. If the object represents a Message posted in reply to a previous post, the prior post prompting the Message SHOULD be referenced using the MessagereplyTo property. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI. The session value MUST be expressed either as an object or as a string corresponding to the session’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the MessageEvent.

The DigitalResource or SoftwareApplication that constitutes the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the NavigationEvent.

Optional

Deprecated Properties

The following NavigationEvent properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

The completed Attempt. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the OutcomeEvent.

Optional

B.11 ReadingEvent DEPRECATED

A Caliper ReadingEvent models an actor reading textural content. ReadingEvent is DEPRECATED and will be removed in a future version of the specification. It SHOULD NOT be referenced.

The DigitalResource that constitutes the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the ReadingEvent.

The Agent who initiated the action. For LoggedIn and LoggedOut actions a Person MUST be specified as the actor. For a TimedOut action a SoftwareApplication MUST be specified as the actor. The actor value MUST be expressed either as an object or as a string corresponding to the actor’s IRI.

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

When logging in to a SoftwareApplication, if the actor is attempting to access a particular DigitalResource it MAY be designated as the target of the interaction. The target value MUST be expressed either as an object or as a string corresponding to the target entity’s IRI.

The DigitalResource or SoftwareApplication that constitutes the referring context MAY be specified as the referrer. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the SessionEvent.

The Thread that constitutes the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the ThreadEvent.

The SoftwareApplication that constitutes the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

A SoftwareApplication that represents a particular capability or feature provided by the object. The target value MUST be expressed either as an object or as a string corresponding to the target entity’s IRI.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the ToolUseEvent.

The DigitalResource that constitutes the object of the interaction. The object value MUST be expressed either as an object or as a string corresponding to the object’s IRI.

Required

eventTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that indicates when the Event occurred. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An Entity that represents the referring context. A SoftwareApplication or DigitalResource will typically constitute the referring context. The referrer value MUST be expressed either as an object or as a string corresponding to the referrer’s IRI.

The relationship between the actor and the group in terms of roles assigned and current status. The membership value MUST be expressed either as an object or as a string corresponding to the membership entity’s IRI.

If the Event occurs within the context of an LTI tool launch, the actor’s tool consumer LtiSession MAY be referenced. The federatedSession value MUST be expressed either as an object or as a string corresponding to the federatedSession’s IRI.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the ViewEvent.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Agent is known.

Optional

description

string

A string value comprising a brief, written representation of the Agent.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Agent was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Agent was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Agent.

C.2 Annotation

A Caliper Annotation is a generic type that represents a comment, explanation, highlight, mark, note, question or tag linked to a DigitalResource. The act of sharing a DigitalResource with others is also considered a form of annotation.

Utilize Annotation only if no suitable subtype exists to represent the annotation being described.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The DigitalResource that was annotated by the annotator. The annotated value MUST be expressed either as an object or as a string corresponding to the annotated resource’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Annotation was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Annotation was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Annotation.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Assessment is known.

Optional

description

string

A string value comprising a brief, written representation of the Assessment.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Assessment into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Assessment.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Assessment.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Assessment. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this Assessment as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

items

Array

An ordered collection of AssessmentItem entities. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Assessment was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Assessment was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Assessment. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToActivate

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Assessment was activated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToShow

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Assessment should be shown or made available to learners. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToStartOn

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Assessment can be started. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToSubmit

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Assessment is to be submitted for evaluation. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

maxAttempts

integer

A non-negative integer that designates the number of permitted attempts.

Optional

maxSubmits

integer

A non-negative integer that designates the number of permitted submissions.

Optional

maxScore

decimal

A number with a fractional part denoted by a decimal separator that designates the maximum score permitted.

Optional

version

string

A string value that designates the current form or version of the Assessment.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Assessment.

Optional

Deprecated Properties

The following Assessment properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the AssessmentItem is known.

Optional

description

string

A string value comprising a brief, written representation of the AssessmentItem.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this AssessmentItem into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this AssessmentItem.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the AssessmentItem.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this AssessmentItem. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

isTimeDependent

Boolean

A boolean value indicating whether or not interacting with the item is time dependent.

A related Entity, typically an Assessment, that includes or incorporates the AssessmentItem as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AssessmentItem was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AssessmentItem was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the AssessmentItem. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToActivate

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AssessmentItem was activated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToShow

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AssessmentItem should be shown or made available to learners. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToStartOn

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AssessmentItem can be started. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToSubmit

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AssessmentItem is to be submitted for evaluation. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

maxAttempts

integer

A non-negative integer that designates the number of permitted attempts.

Optional

maxSubmits

integer

A non-negative integer that designates the number of permitted submissions.

Optional

maxScore

decimal

A number with a fractional part denoted by a decimal separator that designates the maximum score permitted.

Optional

version

string

A string value that designates the current form or version of the AssessmentItem.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the AssessmentItem.

Optional

Deprecated Properties

The following AssessmentItem properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this AssignableDigitalResource into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

An ordered collection of one or more string values that represent tags or labels used to identify the AssignableDigitalResource.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this AssignableDigitalResource. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this AssignableDigitalResource as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AssignableDigitalResource was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the resource was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the resource. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToActivate

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the resource was activated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToShow

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the resource should be shown or made available to learners. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToStartOn

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the resource can be started. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateToSubmit

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the resource is to be submitted for evaluation. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

maxAttempts

integer

A non-negative integer that designates the number of permitted attempts.

Optional

maxSubmits

integer

A non-negative integer that designates the number of permitted submissions.

Optional

maxScore

decimal

A number with a fractional part denoted by a decimal separator that designates the maximum score permitted.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

C.6 Attempt

A Caliper Attempt provides a count of the number of times an actor has interacted with an AssignableDigitalResource along with start time, end time and duration information. An Attempt is generated as the result of an action such as starting an Assessment.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The parent Attempt, if one exists. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated attempt’s IRI.

Optional

count

integer

The total number of attempts inclusive of the current attempt that have been registered against the assigned DigitalResource.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Attempt was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Attempt was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Attempt was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Attempt was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the Attempt. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Attempt.

Optional

Deprecated Properties

The following Attempt properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the AudioObject is known.

Optional

description

string

A string value comprising a brief, written representation of the AudioObject.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this AudioObject into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this AudioObject.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the AudioObject.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this AudioObject. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this AudioObject as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

volumeLevel

string

A string value indicating the current volume level.

Optional

volumeMin

string

A string value indicating the minimum volume level permitted.

Optional

volumeMax

string

A string value indicating the maximum volume level permitted.

Optional

muted

Boolean

An optional boolean value indicating whether or not the AudioObject has been muted.

Optional

duration

Duration

An optional time interval that represents the total time required to view and/or listen to the AudioObject at normal speed. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AudioObject was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the AudioObject was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the AudioObject. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the AudioObject.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the AudioObject.

Optional

Deprecated Properties

The following AudioObject properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The DigitalResource that was annotated by the annotator. The annotated value MUST be expressed either as an object or as a string corresponding to the annotated resource’s IRI.

Optional

bookmarkNotes

string

A string value comprising a plain text rendering of the note that accompanies the bookmark.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the BookmarkAnnotation was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the BookmarkAnnotation was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the BookmarkAnnotation.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Chapter is known.

Optional

description

string

A string value comprising a brief, written representation of the Chapter.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Chapter into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Chapter.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Chapter.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Chapter. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this Chapter as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Chapter was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Chapter was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Chapter. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the Chapter.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Chapter.

Optional

Deprecated Properties

The following Chapter properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

C.10 CourseOffering

A Caliper CourseOffering represents the occurrence of a course or a type during a specified time period. CourseOffering is composed of a subset of properties specified in the IMS LTI 2.1 specification, which in turn, draws inspiration from the IMS LIS 1.0 specification.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The parent Organization of this CourseOffering. The subOrganizationOf value MUST be expressed either as an object or as a string corresponding to the parent organization’s IRI.

Optional

members

Array

An ordered collection of Agent entities, typically of type CourseSection, Group and/or Person. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the CourseOffering was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the CourseOffering was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the CourseOffering.

C.11 CourseSection

A Caliper CourseSection represents a specific instance of a CourseOffering occurring during a specific semester, term or period. CourseSection is composed of a subset of properties specified in the IMS LTI 2.1 specification, which in turn, draws inspiration from the IMS LIS 1.0 specification.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The parent Organization of this CourseSection. The subOrganizationOf value MUST be expressed either as an object or as a string corresponding to the parent organization’s IRI.

Optional

members

Array

An ordered collection of Agent entities, typically of type Group and/or Person. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the CourseSection was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the CourseSection was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the CourseSection.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the resource is known.

Optional

description

string

A string value comprising a brief, written representation of the resource.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing resource into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of the resource.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the resource.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with the resource. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates the resource as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the resource was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the resource was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the resource. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the resource.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the DigitalResource.

Optional

Deprecated Properties

The following DigitalResource properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this DigitalResourceCollection into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

An ordered collection of one or more string values that represent tags or labels used to identify the DigitalResourceCollection.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this DigitalResourceCollection. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this DigitalResourceCollection as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

items

Array

An ordered collection of DigitalResource entities. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the collection was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the collection was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the collection. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Document is known.

Optional

description

string

A string value comprising a brief, written representation of the Document.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Document into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Document.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Document.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Document. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this Document as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Document was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Document was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Document. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the Document.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Document.

Optional

Deprecated Properties

The following Document properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

C.15 EpubChapter (DEPRECATED)

A Caliper EpubChapter represents a major structural division of a piece of writing. EpubChapter is a DEPRECATED entity that will be removed in a future version of the specification. It SHOULD NOT be referenced.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the EpubChapter is known.

Optional

description

string

A string value comprising a brief, written representation of the EpubChapter.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this EpubChapter into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this EpubChapter.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the EpubChapter.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this EpubChapter. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this EpubChapter as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the EpubChapter was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the EpubChapter was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the EpubChapter. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the EpubChapter.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the EpubChapter.

Optional

Deprecated Properties

The following EpubChapter properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Optional

C.16 EpubPart (DEPRECATED)

A Caliper EpubPart represents a major structural division of a piece of writing, typically encapsulating a set of related chapters. EpubPart is a DEPRECATED entity that will be removed in a future version of the specification. It SHOULD NOT be referenced.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the EpubPart is known.

Optional

description

string

A string value comprising a brief, written representation of the EpubPart.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this EpubPart into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this EpubPart.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the EpubPart.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this EpubPart. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this EpubPart as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the EpubPart was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the EpubPart was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the EpubPart. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the EpubPart.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the EpubPart.

Optional

Deprecated Properties

The following EpubPart properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Optional

C.17 EpubSubChapter (DEPRECATED)

A Caliper EpubSubChapter represents a major sub-division of an EpubChapter. EpubSubChapter is a DEPRECATED entity that will be removed in a future version of the specification. It SHOULD NOT be referenced.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the EpubSubChapter is known.

Optional

description

string

A string value comprising a brief, written representation of the EpubSubChapter.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this EpubSubChapter into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this EpubSubChapter.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the EpubSubChapter.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this EpubSubChapter. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related EpubChapter that includes or incorporates this EpubSubChapter as a part. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the EpubSubChapter was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the EpubSubChapter was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the EpubSubChapter. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the EpubSubChapter.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the EpubSubChapter.

Optional

Deprecated Properties

The following EpubChapter properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Optional

C.18 EpubVolume (DEPRECATED)

A Caliper EpubVolume represents a component of a collection. EpubVolume inherits all the properties and requirements defined for DigitalResource, its supertype. EpubVolume is a DEPRECATED entity that will be removed in a future version of the specification. It SHOULD NOT be referenced.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the EpubVolume is known.

Optional

description

string

A string value comprising a brief, written representation of the EpubVolume.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this EpubVolume into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this EpubVolume.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the EpubVolume.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this EpubVolume. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this EpubVolume as a part. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the EpubVolume was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the EpubVolume was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the EpubVolume. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the EpubVolume.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the EpubVolume.

Optional

Deprecated Properties

The following EpubVolume properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Optional

C.19 FillinBlankResponse

A Caliper FillinBlankResponse represents a type of Response in which a respondent is asked to provide one or more words, expressions or short phrases that correctly completes a statement.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The associated Attempt. The attempt value MUST be expressed either as an object or as a string corresponding to the attempt’s IRI. If an object representation is provided, the Attempt SHOULD reference both the Person who initiated the FillinBlankResponse and the relevant AssessmentItem.

Optional

values

Array

An ordered collection of one or more string values representing words, expressions or short phrases that constitute the FillinBlankResponse.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the FillinBlankResponse was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the FillinBlankResponse was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the FillinBlankResponse was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the FillinBlankResponse was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the FillinBlankResponse. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the FillinBlankResponse.

Optional

Deprecated Properties

The following FillinBlankResponse properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

C.20 Forum

A Caliper Forum represents a channel or virtual space in which group discussions take place. A Forum typically comprises one or more threaded conversations to which members can subscribe, post messages and reply to other messages.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Forum is known.

Optional

description

string

A string value comprising a brief, written representation of the Forum.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Forum into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Forum.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Forum.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Forum. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this Forum as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

items

Array

An ordered collection of Thread entities. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Forum was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Forum was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Forum. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the Forum.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Forum.

Optional

Deprecated Properties

The following Forum properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Frame is known.

Optional

description

string

A string value comprising a brief, written representation of the Frame.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Frame into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Frame.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Frame.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Frame. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

An ISO 8601 date and time value expressed with millisecond precision that describes when the Frame was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Frame was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Frame. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the Frame.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Frame.

Optional

Deprecated Properties

The following Frame properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

C.22 Group

A Caliper Group represents an ad-hoc, informal or short-lived collection of people organized for some common educational or social purpose. A Group can act as an Agent. It can be linked both to a parent Organization and to its members.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The parent Organization of this Group. The subOrganizationOf value MUST be expressed either as an object or as a string corresponding to the parent organization’s IRI.

Optional

members

Array

An ordered collection of Agent entities, typically of type Group and/or Person. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Group was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Group was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Group.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The start and end positions of the highlighted text segment. The first character in the full text is character position 0. If a TextPositionSelector is defined both its start and end positions MUST be specified.

Optional

selectionText

string

A string value representing a plain-text rendering of the highlighted segment of the annotated DigitalResource.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the HighlightAnnotation was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the HighlightAnnotation was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the HighlightAnnotation.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the ImageObject is known.

Optional

description

string

A string value comprising a brief, written representation of the ImageObject.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this ImageObject into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this ImageObject.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the ImageObject.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this ImageObject. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this ImageObject as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

duration

Duration

An optional time interval that represents the total time required to view and/or listen to the ImageObject at normal speed. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the ImageObject was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the ImageObject was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the ImageObject. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the ImageObject.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the ImageObject.

Optional

Deprecated Properties

The following ImageObject properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

An ISO 8601 date and time value expressed with millisecond precision that describes when the LearningObjective was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the LearningObjective was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the LearningObjective.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

An ISO 8601 date and time value expressed with millisecond precision that describes when the LtiSession was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the LtiSession was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the LtiSession was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the LtiSession was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the LtiSession. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the LtiSession.

Optional

Deprecated Properties

The following LtiSession properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the MediaLocation is known.

Optional

description

string

A string value comprising a brief, written representation of the MediaLocation.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this MediaLocation into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this MediaLocation.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the MediaLocation.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this MediaLocation. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this MediaLocation as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

currentTime

Duration

A time interval or duration that represents the current playback position measured from the beginning of an AudioObject or VideoObject. If a currentTime is specified the value MUST conform to the ISO 8601 duration format.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MediaLocation was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MediaLocation was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the MediaLocation. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the MediaLocation.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the MediaLocation.

Optional

Deprecated Properties

The following MediaLocation properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the MediaObject is known.

Optional

description

string

A string value comprising a brief, written representation of the MediaObject.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this MediaObject into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this MediaObject.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the MediaObject.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this MediaObject. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this MediaObject as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

duration

Duration

An optional time interval that represents the total time required to view and/or listen to the MediaObject at normal speed. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MediaObject was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MediaObject was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the MediaObject. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the MediaObject.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the MediaObject.

Optional

Deprecated Properties

The following MediaObject properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The Person associated with this Membership. The member value MUST be expressed either as an object or as a string corresponding to the member’s IRI.

Optional

roles

Array

An ordered collection of organizational roles assigned to the member. Role values are limited to the list of Caliper defined roles terms. Whenever a subrole is specified, the core context role SHOULD also be included; for example, a role of Instructor#TeachingAssistant should always be accompanied by the Instructor role.

A string value that indicates the current standing of the member. If a status is specified, the value be chosen from the list of Caliper defined statuses.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Membership was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Membership was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Membership.

C.30 Message

A Caliper Message is a digital form of written communication sent to a recipient. A series of messages may constitute a Thread if they share a common subject and are connected by a reply or by date relationships.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Message is known.

Optional

description

string

A string value comprising a brief, written representation of the Message.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Message into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Message.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Message.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Message. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Thread that includes or incorporates this Message as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated thread’s IRI.

A Message that represents the post to which this Message is directed in reply. The replyTo value MUST be expressed either as an object or as a string corresponding to the associated message’s IRI.

Optional

body

string

A string value comprising a plain-text rendering of the body content of the Message.

Optional

attachments

Array

An ordered collection of one or more DigitalResource entities attached to this Message. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Message was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Message was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Message. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the Message.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Message.

Optional

Deprecated Properties

The following Message properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

An ISO 8601 date and time value expressed with millisecond precision that describes when the MultipleChoiceResponse was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MultipleChoiceResponse was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MultipleChoiceResponse was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MultipleChoiceResponse was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the MultipleChoiceResponse. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the MultipleChoiceResponse.

Optional

Deprecated Properties

The following MultipleChoiceResponse properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

An ordered collection of one or more selected options MAY be specified

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MultipleResponseResponse was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MultipleResponseResponse was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MultipleResponseResponse was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the MultipleResponseResponse was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the MultipleResponseResponse. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the MultipleResponseResponse.

Optional

Deprecated Properties

The following MultipleResponseResponse properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

C.33 Organization

A Caliper Organization represents a formal collection of people organized for some common educational, social or administrative purpose. An Organization can act as an Agent. It can be linked both to a parent Organization and to its members.

Required properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The parent Organization of this Organization. The subOrganizationOf value MUST be expressed either as an object or as a string corresponding to the parent organization’s IRI.

Optional

members

Array

An ordered collection of Agent entities. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Organization was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Organization was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Organization.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Page is known.

Optional

description

string

A string value comprising a brief, written representation of the Page.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Page into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Page.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Page.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Page. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this Page as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Page was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Page was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Page. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the Page.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Page.

Optional

Deprecated Properties

The following Page properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Person is known.

Optional

description

string

A string value comprising a brief, written representation of the Person.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Person was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Person was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Person.

C.36 Reading (DEPRECATED)

A Caliper Reading represents an item of paginated content. Reading is a DEPRECATED entity superseded by Document that will be removed in a future version of the specification. It SHOULD NOT be referenced.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Reading is known.

Optional

description

string

A string value comprising a brief, written representation of the Reading.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Reading into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Reading.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Reading.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Reading. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this Reading as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Reading was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Reading was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Reading. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the Reading.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Reading.

Optional

Deprecated Properties

The following Reading properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The associated Attempt. The attempt value MUST be expressed either as an object or as a string corresponding to the attempt’s IRI. If an object representation is provided, the Attempt SHOULD reference both the Person who initiated the Response and the relevant AssessmentItem.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Response was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Response was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Response was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Response was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the Response. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Response.

Optional

Deprecated Properties

The following Response properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The associated Attempt. The attempt value MUST be expressed either as an object or as a string corresponding to the attempt’s IRI. If an object representation is provided, the Attempt SHOULD reference both the Person who generated the Attempt and the assigned DigitalResource.

Optional

maxResultScore

decimal

A number with a fractional part denoted by a decimal separator that designates the maximum result score permitted.

Optional

resultScore

decimal

A number with a fractional part denoted by a decimal separator that designates the actual result score awarded.

The Agent who scored or graded the Attempt. The scoredBy value MUST be expressed either as an object or as a string corresponding to the scorer’s IRI.

Optional

comment

string

Plain text feedback provided by the scorer.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Result was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Result was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Result.

Optional

Deprecated Properties

The following Result properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The associated Attempt. The attempt value MUST be expressed either as an object or as a string corresponding to the attempt’s IRI. If an object representation is provided, the Attempt SHOULD reference both the Person who generated the Attempt and the assigned DigitalResource.

Optional

maxScore

decimal

A number with a fractional part denoted by a decimal separator that designates the maximum score permitted.

Optional

scoreGiven

decimal

A number with a fractional part denoted by a decimal separator that designates the actual score awarded.

The Agent who scored or graded the Attempt. The scoredBy value MUST be expressed either as an object or as a string corresponding to the scorer’s IRI.

Optional

comment

string

Plain text feedback provided by the scorer.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Score was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Score was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Score.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The associated Attempt. The attempt value MUST be expressed either as an object or as a string corresponding to the attempt’s IRI. If an object representation is provided, the Attempt SHOULD reference both the Person who initiated the SelectTextResponse and the relevant AssessmentItem.

Optional

values

Array

An ordered collection of one or more selected options.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the SelectTextResponse was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the SelectTextResponse was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the SelectTextResponse was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the SelectTextResponse was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the SelectTextResponse. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the SelectTextResponse.

Optional

Deprecated Properties

The following SelectTextResponse properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

An ISO 8601 date and time value expressed with millisecond precision that describes when the Session was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Session was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Session was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Session was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the Session. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Session.

Optional

Deprecated Properties

The following Session properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The DigitalResource that was annotated by the annotator. The annotated value MUST be expressed either as an object or as a string corresponding to the annotated resource’s IRI.

Optional

withAgents

Array

An ordered collection of one or more Agent entities, typically of type Person, with whom the annotated DigitalResource has been shared. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the SharedAnnotation was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the SharedAnnotation was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the SharedAnnotation.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

An ISO 8601 date and time value expressed with millisecond precision that describes when the SoftwareApplication was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the SoftwareApplication was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

An optional string value that designates the current form or version of this SoftwareApplication.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the SoftwareApplication.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The DigitalResource that was annotated by the annotator. The annotated value MUST be expressed either as an object or as a string corresponding to the annotated resource’s IRI.

Optional

tags

Array

An ordered collection of one or more string values that represent the tags associated with the annotated DigitalResource.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the TagAnnotation was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the TagAnnotation was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the TagAnnotation.

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the Thread is known.

Optional

description

string

A string value comprising a brief, written representation of the Thread.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this Thread into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this Thread.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the Thread.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this Thread. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Forum that includes or incorporates this Thread as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

items

Array

An ordered collection of Message entities. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Thread was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the Thread was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the Thread. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the Forum.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the Thread.

Optional

Deprecated Properties

The following Thread properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

The associated Attempt. The attempt value MUST be expressed either as an object or as a string corresponding to the attempt’s IRI. If an object representation is provided, the Attempt SHOULD reference both the Person who initiated the TrueFalseResponse and the relevant AssessmentItem.

Optional

value

string

A string value that provides the true/false, yes/no binary selection SHOULD be provided.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the TrueFalseResponse was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the TrueFalseResponse was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

startedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the TrueFalseResponse was commenced. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

endedAtTime

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the TrueFalseResponse was completed or terminated. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

duration

Duration

A time interval that represents the time taken to complete the TrueFalseResponse. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the TrueFalseResponse.

Optional

Deprecated Properties

The following TrueFalseResponse properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

Supertype

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the VideoObject is known.

Optional

description

string

A string value comprising a brief, written representation of the VideoObject.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this VideoObject into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this VideoObject.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the VideoObject.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this VideoObject. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this VideoObject as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

duration

Duration

An optional time interval that represents the total time required to view and/or listen to the VideoObject at normal speed. If a duration is specified the value MUST conform to the ISO 8601 duration format.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the VideoObject was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the VideoObject was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the VideoObject. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the VideoObject.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the VideoObject.

Optional

Deprecated Properties

The following VideoObject properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Properties

A valid IRI MUST be specified. The IRI MUST be unique and persistent. The IRI SHOULD also be dereferenceable, i.e., capable of returning a representation of the resource. A URI employing the URN scheme MAY be provided in cases where a Linked Data friendly HTTP URI is either unavailable or inappropriate.

A string value comprising a word or phrase by which the WebPage is known.

Optional

description

string

A string value comprising a brief, written representation of the WebPage.

Optional

creators

Array

An ordered collection of Agent entities, typically of type Person, that are responsible for bringing this WebPage into being. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

Optional

mediaType

string

A string value drawn from the list of IANA approved media types and subtypes that identifies the file format of this WebPage.

Optional

keywords

Array

An ordered collection of one or more string values that represent tags or labels used to identify the WebPage.

Optional

learningObjectives

Array

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with this WebPage. Each array item MUST be expressed either as an object or as a string corresponding to the item’s IRI.

A related Entity that includes or incorporates this WebPage as a part of its whole. The isPartOf value MUST be expressed either as an object or as a string corresponding to the associated entity’s IRI.

Optional

dateCreated

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the WebPage was created. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

dateModified

DateTime

An ISO 8601 date and time value expressed with millisecond precision that describes when the WebPage was last changed or modified. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

datePublished

DateTime

An ISO 8601 date and time value expressed with millisecond precision that provides the publication date of the WebPage. The value MUST be expressed using the format YYYY-MM-DDTHH:mm:ss.SSSZ set to UTC with no offset specified.

Optional

version

string

A string value that designates the current form or version of the WebPage.

Optional

extensions

Object

A map of additional attributes not defined by the model MAY be specified for a more concise representation of the WebPage.

Optional

Deprecated Properties

The following WebPage properties have been DEPRECATED and MUST NOT be utilized. The properties will be removed in a future version of Caliper.

An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with a DigitalResource. alignedLearningObjective has been DEPRECATED and replaced by learningObjectives.

Appendix D. Selectors

A Caliper Selector represents a fragment, selection or part of an Entity.

D.1 TextPositionSelector

A Caliper TextPositionSelector represents a fragment or selection of textual content, the starting and ending positions of which are determined by the distance in characters from the initial character (position 0) of the enclosing full text.

Appendix E. Roles

Roles

Membership includes an optional roles property for assigning one or more roles to an Eventactor described as a member of an organization. Role values are limited to the list of Caliper role terms derived from the IMS LIS specification. Assigning core context roles should prove sufficient in most cases. Whenever a subrole is specified, the related context role SHOULD also be included. For example, a role of Instructor#TeachingAssistant SHOULD always be accompanied by the Instructor role.