This document was authored by members of the Experience API Working Group (see list on pp. 7-8) in support of the Office of the Deputy Assistant Secretary of Defense (Readiness) Advanced Distributed Learning (ADL) Initiative. Please send all feedback and inquiries to [email protected]
- 1.0. Revision History
- 2.0. Role of the Experience API
- 2.1. ADL's Role in the Experience API
- 2.2. Contributors
- 3.0. Definitions
- 4.0. Statement
- 4.1. Statement Properties
- 4.2. Retrieval of Statements
- 4.3. Voided
- 4.4. Signed Statements
- 5.0. Miscellaneous Types
- 5.1. Document
- 5.2. Language Map
- 5.3. Extensions
- 5.4. Identifier Metadata
- 6.0. Runtime Communication
- 6.1. Encoding
- 6.2. API Versioning
- 6.3. Concurrency
- 6.4. Security
- 6.4.1. Authentication Definitions
- 6.4.2. OAuth Authorization Scope
- 7.0. Data Transfer (REST)
- 7.1. Error Codes
- 7.2. Statement API
- 7.3. Document APIs
- 7.4. State API
- 7.5. Activity Profile API
- 7.6. Agent Profile API
- 7.7. About resource
- 7.8. Cross Origin Requests
- 7.9. Validation
- 7.10. HTTP HEAD
- Appendix A: Bookmarklet
- Appendix B: Creating an "IE Mode" Request
- Appendix C: Example definitions for activities of type "cmi.interaction"
- Appendix D: Example statements
- Appendix E: Converting Statements to 1.0.0
- Appendix F: Example Signed Statement
Rustici Software, who delivered the Project Tin Can API, made modifications to the API prior to the April 2012 Kickoff Meeting. It was voted in this meeting to move those changes into the current specification and revision to 0.9.
"Core" verbs and activity types were removed from the specification. References to these verbs in results, context, interactions, and activity definitions were also removed. It was recommended that implementers prefer community defined verbs to creating their own verbs.
- Verbs, activity types, and extension keys are now URIs
- Restructured and added language around some of the other implementation details and scope.
- Changed from using a person-centric view of agents to a persona-centric view.
- Friend of a Friend (FOAF) agent merging requirement was removed.
- Agent objects must now have exactly 1 uniquely identifying property, instead of at least one.
Various refinements and clarifications including:
- Adding attachments
- Activity metadata is now stored as JSON rather than XML
- Changes to voiding statements
- Clarification and naming of the Document APIs
- Changes to querying the Statement API
- Signed statements
The Experience API is a service that allows for statements of experience to be delivered to and stored securely in a Learning Record Store (LRS). These statements of experience are typically learning experiences, but the API can address statements of any kind of experience. The Experience API is dependent on Learning Activity Providers to create and track these learning experiences; this specification provides a data model and associated components on how to accomplish these tasks.
Specifically, the Experience API provides:
-
The structure and definition of statement, state, learner, activity and objects, which are the means by which experiences are conveyed by a Learning Activity Provider.
-
Data Transfer methods for the storage and retrieval (but not validation) of these objects to/from a Learning Record Store. Note that the systems storing or retrieving records need not be Learning Activity Providers. LRSs may communicate with other LRSs, or reporting systems.
-
Security methods allowing for the trusted exchange of information between the Learning Record Store and trusted sources.
The Experience API is the first of many envisioned technologies that will enable a richer architecture of online learning and training. Authentication services, querying services, visualization services, and personal data services are some examples of additional technologies for which the Experience API is designed to support. While the implementation details of these services are not specified here, the Experience API is designed with this larger architectural vision in mind.
ADL has taken a role of steward and facilitator in the development of the Experience API. The Experience API is seen as one piece of the ADL Training and Learning Architecture, which facilitates learning anytime and anywhere. ADL views the Experience API as an evolved version of SCORM that can support similar use cases, but can also support many of the use cases gathered by ADL and submitted by those involved in distributed learning which SCORM could not enable.
"My thanks to everyone who contributed to the Experience API project. Many of you have called into the weekly meetings and helped to shape the specification into something that is useful for the entire distributed learning community. Many of you assisted in releasing code samples, products, and documentation to aid those who are creating and adopting the specification. I'd also like to thank all of those who were involved in supplying useful, honest information about your organization's use of SCORM and other learning best practices. Through the use-cases, shared experiences, and knowledge you have shared, ADL and the community clearly identified the first step in creating the Training and Learning Architecture--the Experience API. You are truly the community leaders on which we depend to make our training and education the very best."
Kristy S. Murray, Ed.D.
Director, ADL Initiative
OSD, Training Readiness & Strategy (TRS)
| Name: | Organization: |
|---|---|
| Aaron Silvers | ADL |
| Al Bejcek | NetDimensions |
| Ali Shahrazad | SaLTBOX |
| Andrew Downes | Epic |
| Andy Johnson | ADL |
| Andy Whitaker | Rustici Software |
| Anthony Altieri | American Red Cross |
| Anto Valan | Omnivera Learning Solutions |
| Avron Barr | Aldo Ventures, Inc. |
| Ben Clark | Rustici Software |
| Bill McDonald | Boeing |
| Brian J. Miller | Rustici Software |
| Chad Udell | Float Mobile Learning |
| Chris Sawwa | Meridian Knowledge Solutions |
| Dan Allen | Litmos |
| Dan Kuemmel | Sentry Insurance |
| Dave Mozealous | Articulate |
| David Ells | Rustici Software |
| Doug Hagy | Twin Lakes Consulting Corporation |
| Eric Johnson | Planning and Learning Technologies, Inc. |
| Fiona Leteney | Feenix e-learning |
| Greg Tatka | Menco Social Learning |
| Ingo Dahn | University Koblenz-Landau |
| Jason Haag | ADL |
| Jeff Place | Questionmark |
| Jennifer Cameron | Sencia Corporate Web Solutions |
| Jeremy Brockman | |
| Jhorlin De Armas | Riptide Software |
| Joe Gorup | CourseAvenue |
| John Kleeman | Questionmark |
| Jonathan Archibald | Brightwave |
| Jonathan Poltrack | ADL |
| Kris Miller | edcetra Training |
| Kris Rockwell | Hybrid Learning Systems |
| Lang Holloman | |
| Lou Wolford | ADL |
| Luke Hickey | dominKnow |
| Marcus Birtwhistle | ADL |
| Mark Davis | Exambuilder |
| Matteo Scaramuccia | |
| Megan Bowe | Rustici Software |
| Melanie VanHorn | ADL |
| Michael Flores | Here Everything's Better |
| Michael Roberts | vTrainingRoom |
| Mike Palmer | OnPoint Digital |
| Mike Rustici | Rustici Software |
| Nick Washburn | Riptide Software |
| Nikolaus Hruska | ADL |
| Patrick Kedziora | Kedzoh |
| Paul Esch | Nine Set |
| Paul Roberts | Questionmark |
| Rich Chetwynd | Litmos |
| Richard Fouchaux | Ontario Human Rights Commission |
| Richard Lenz | Organizational Strategies, Inc. |
| Rick Raymer | |
| Rob Chadwick | ADL |
| Robert Lowe | NetDimensions |
| Russell Duhon | SaLTBOX |
| Stephen Trevorrow | Problem Solutions, LLC. |
| Steve Baumgartner | |
| Steve Flowers | XPConcept |
| Thomas Ho | |
| Tim Martin | Rustici Software |
| Tom Creighton | ADL |
| Walt Grata | ADL |
In collection of requirements for the Experience API, many people and organizations provided invaluable feedback to the Sharable Content Object Reference Model (SCORM®), distributed learning efforts, and learning technology efforts in general. While not an exhaustive listing, the white papers gathered in 2008 by the Learning Education and Training Standards Interoperability (LETSI) group, the Rustici Software UserVoice website, one-on-one interviews and various blogs were important sources from which requirements were gathered for the Experience API specification.
This is a definitive document which describes how the Experience API is to be implemented across a variety of systems. It is a technical document authored specifically for individuals and organizations implementing this technology with the intent of such individuals developing interoperable tools, systems and services that are independent of each other and interoperable with each other.
Whenever possible, the language and formatting used in this document is intended to be considerate of non-technical readers because various tools, systems and services are based on the specification set described below. For this reason, sections that provide a high-level overview of a given facet of the Experience API are labeled description or rationale. Items in this document labeled as details or examples are more technical.
- Activity
- Activity Provider (AP)
- Actor
- Authentication
- Authorization
- Community of Practice
- Experience API (xAPI)
- Immutable
- Internationalized Resource Idenfier (IRI)
- Inverse Functional Identifier
- Learning Management System (LMS)
- Learning Record Store (LRS)
- MUST / SHOULD / MAY
- Profile
- Registration
- Representational State Transfer (REST)
- Service
- Statement
- Tin Can API (TCAPI)
- Verb
Activity: A thing with which to be interacted. An Activity can be a unit of instruction, experience, or performance that is to be tracked in meaningful combination with a Verb. Interpretation of 'Activity' is broad, meaning that Activities can even be tangible objects. In the statement "Anna tried a cake recipe," the recipe constitutes the Activity in terms of the xAPI statement. Other examples include a book, an e-learning course, a hike or a meeting.
Activity Provider (AP): The software object that is communicating with the LRS to record information about a learning experience. May be similar to a SCORM package in that it is possible to bundle learning assets with the software object that performs this communication, but an Activity Provider may also be separate from the experience it is reporting about.
Actor: An identity or persona of an individual or group tracked using Statements as doing an
action (Verb) within an Activity.
Authentication: The concept of verifying the identity of a user or system. Authentication allows interactions between the two "trusted" parties.
Authorization: The affordance of permissions based on a user or system's role; the process of making one user or system "trusted" by another.
Community of Practice: A group, usually connected by a common cause, role or purpose, which operates in a common modality.
Experience API (xAPI): The API defined in this document, the product of "Project Tin Can". A simple, lightweight way for any permitted actor to store and retrieve extensible learning records, learner and learning experience profiles, regardless of platform.
Immutable: Adjective used to describe things which cannot be changed. With some exceptions, statements in the xAPI are immutable. This ensures that when statements are shared between LRSs, multiple copies of the statement remain the same.
Internationalized Resource Idenfiers (IRI): A unique identifier which may be a URL. In the xAPI, all IRIs should be a full absolute IRI including a scheme. Relative IRIs should not be used. URLs should be defined within a domain controlled by the person creating the URL.
Inverse Functional Identifier: An identifier which is unique to a particular persona or group. Used to identify Agents and Groups.
Learning Management System (LMS): "A software package
used to administer one or more courses to one or more learners. An LMS is typically a web-based
system that allows learners to authenticate themselves, register for courses, complete courses and take
assessments" (LSAL, 2004 in Gallagher, 2007). In this document the term will be used in the context of
existing systems implementing learning standards.
Learning Record Store (LRS): A system that stores learning information. Prior to the xAPI most LRSs were Learning Management Systems (LMSs), however this document uses the term LRS to be clear that a full LMS is not necessary to implement the xAPI. The xAPI is dependent on an LRS to function.
MUST / SHOULD / MAY: Three levels of obligation with regards to conformance to the xAPI specification. A system that fails to implement a MUST (or a MUST NOT) requirement is non-conformant. Failing to meet a SHOULD requirement is not a violation of conformity, but goes against best practices. MAY indicates an option, to be decided by the developer with no consequences for conformity.
Profile: A construct where information about the learner or activity is kept, typically in name/document pairs that have meaning to an instructional system component.
Registration: An instance of a learner experiencing a particular Activity.
Representational State Transfer (REST): An architecture for designing networked web Services. It relies on HTTP methods and uses current web best practices.
Service: A software component responsible for one or more aspects of the distributed learning process. An LMS typically combines many services to design a complete learning experience.
Statement: A simple construct consisting of <Actor (learner)> <verb> <object>,
with <result>, in <context> to track an aspect of a learning experience. A set of
several statements may be used to track complete details about a learning experience.
Tin Can API (TCAPI): The previous name of the API defined in this document, often used in informal references to the Experience API.
Verb: Defines the action being done by the Actor within the Activity within a Statement.
The statement is the core of the xAPI. All learning events are stored as statements. A statement is akin to a sentence of the form "I did this".
Actor, verb, and object are required, all other properties are optional. Properties can occur in any order, but are limited to one use each. Each property is discussed below.
| Property | Type | Description |
|---|---|---|
| id | UUID | UUID assigned by LRS if not set by the Learning Activity Provider. |
| actor | Object | Who the statement is about, as an Agent or Group object. Represents the "I" in "I Did This". |
| verb | Object | Action of the Learner or Team object. Represents the "Did" in "I Did This". |
| object | Object | Activity, agent, or another statement that is the object of the statement. Represents the "This" in "I Did This". Note that objects which are provided as a value for this field should include an "objectType" field. If not specified, the object is assumed to be an activity. |
| result | Object | Result object, further details representing a measured outcome relevant to the specified verb. |
| context | Object | Context that gives the statement more meaning. Examples: a team the actor is working with, altitude at which a scenario was attempted in a flight simulator. |
| timestamp | Date/Time | Timestamp (Formatted according to ISO 8601) of when the events described within this statement occurred. If not provided, LRS should set this to the value of "stored" time. |
| stored | Date/Time | Timestamp (Formatted according to ISO 8601) of when this statement was recorded. Set by LRS. |
| authority | Object | Agent who is asserting this statement is true. Verified by the LRS based on authentication, and set by LRS if left blank. |
| version | Version | toThe statement’s associated xAPI version, formatted according to [Semantic Versioning 1.0.0](http://semver.org/spec/v1.0.0.html) |
| attachments | Array of attachment objects | Headers for attachments to the statement |
An example of the simplest possible statement using all properties that MUST or SHOULD be used:
{
"id": "12345678-1234-5678-1234-567812345678",
"actor":{
"mbox":"mailto:[email protected]"
},
"verb":{
"id":"http://adlnet.gov/expapi/verbs/created",
"display":{
"en-US":"created"
}
},
"object":{
"id":"http://example.adlnet.gov/xapi/example/activity"
}
}
See Appendix D: Example Statements for more examples.
A UUID (see RFC 4122 for requirements, and the UUID must be in standard string form).
- Ids SHOULD be generated by the Learning Activity Provider.
- Ids MUST be generated by the LRS if a statement is received without an ID.
A mandatory Agent or Group object.
An Agent (an individual) is a persona or system.
- An agent MUST be identified by one (1) of the four types of inverse functional identifiers (see 4.1.2.3 Inverse functional Identifier);
- An agent MUST NOT include more than one (1) inverse functional identifier;
- An agent SHOULD NOT use inverse functional identifiers that are also used as a Group identifier;
The table below lists the properties of Agent objects.
| Property | Type | Description | Required |
|---|---|---|---|
| objectType | string | "Agent". This property is optional except when the Agent is used as a statement's Object. | no |
| name | string | Full name of the Agent. | no |
| see 4.1.2.3 Inverse Functional Identifier | An inverse functional identifier unique to the Agent. | yes | |
A Group represents a collection of Agents and can be used in most of the same situations an Agent can be used. There are two types of Groups, anonymous and identified.
An anonymous Group is used describe a cluster of people where there is no ready identifier for this cluster, e.g. an ad hoc team;
- An anonymous Group MUST include a 'member' property listing constituent Agents;
- An anonymous Group MUST NOT contain Group objects in the 'member' property;
- An anonymous Group MUST NOT include any inverse functional identifiers
The table below lists all properties of an anonymous Group.
| Property | Type | Description | Required |
|---|---|---|---|
| objectType | String | "Group". | yes |
| name | String | Name of the group. | no |
| member | Array of Agent objects | The members of this Group. | yes |
| see 4.1.2.3 Inverse Functional Identifier | An inverse functional identifier unique to the Group. | yes | |
An identified Group is used to uniquely identify a cluster of Agents.
- An identified Group MUST include exactly one (1) inverse functional identifier;
- An identified Group MAY include a 'member' property listing constituent Agents;
- An identified Group MUST NOT contain Group objects in the 'member' property;
- An identified Group SHOULD NOT use inverse functional identifiers that are also used as Agent identifiers.
The table below lists all properties of an identified Group.
| Property | Type | Description | Required |
|---|---|---|---|
| objectType | String | "Group". | yes |
| name | String | Name of the group. | no |
| member | Array of Agent objects | The members of this Group. | yes |
| see 4.1.2.3 Inverse Functional Identifier | An inverse functional identifier unique to the Group. | yes | |
- A system consuming Statements MUST consider each anonymous Group distinct even if it has an identical set of members;
- A system consuming Statements MUST NOT assume that Agents in the 'member' property comprise an exact list of agents in a given anonymous or identified Group.
An "inverse functional identifier" is a value of an Agent or identified Group that is guaranteed to only ever refer to that Agent or identified Group.
Learning experiences become meaningless if they cannot be attributed to identifiable individuals and/or groups. In an xAPI statement this is accomplished with a set of inverse functional identifiers loosely inspired on the widely accepted FOAF principle (see: Friend Of A Friend).
The table below lists all possible inverse functional identifier properties.
| Property | Type | Description |
|---|---|---|
| mbox | mailto URI | The required format is "mailto:email address". The local part of the email address must be URI encoded. Only email addresses that have only ever been and will ever be assigned to this Agent, but no others, should be used for this property and mbox_sha1sum. |
| mbox_sha1sum | string | The SHA1 hash of a mailto URI (i.e. the value of an mbox property). An LRS MAY include Agents with a matching hash when a request is based on an mbox. |
| openID | URI | An openID that uniquely identifies the Agent. |
| account | account object | A user account on an existing system e.g. an LMS or intranet. |
A user account on an existing system, such as a private system (LMS or intranet) or a public system (social networking site).
- If the system that provides the account Object uses OpenID, the Learning Activity Provider SHOULD use the openID property instead of an account Object.
- If the Learning Activity Provider is concerned about revealing personally identifiable information about an Agent or Group, it SHOULD use an opaque account name (for example an account number) to identify all statements about a person while maintaining anonymity.
The table below lists all properties of Account objects.
| Property | Type | Description |
|---|---|---|
| homepage | URL | The canonical home page for the system the account is on. This is based on FOAF's accountServiceHomePage. |
| name | string | The unique ID or name used to log in to this account. This is based on FOAF's accountName. |
This example shows an agent identified by an opaque account:
{
"objectType": "Agent",
"account": {
"homePage": "http://www.example.com",
"name": "1625378"
}
}
The verb defines the action between actor and activity. It asserts what is done by the actor in relation to the activity. Verbs appear in statements as objects consisting of a URI and a set of display names.
The verb in an xAPI statement describes the learning experience. The xAPI does not specify any particular verbs. (With one exception, namely the reserved verb 'http://adlnet.gov/expapi/verbs/voided'). Instead, it defines how to create verbs so that communities of practice can coin their own meaningful verbs and make them available for use by anyone. A predefined list of verbs would be limited by definition and they might not be able to effectively capture all possible future learning experiences.
The Verb URI identifies the particular semantics of a word, not the word itself.
For example, the English word "fired" could mean different things depending on context, such as "fired a weapon", "fired a kiln", or "fired an employee". In this case, a URI MUST identify one of these specific meanings, not the word "fired".
A verb in the Experience API is a URI, and denotes a specific meaning not tied to any particular language.
For example, a particular verb URI such as http://example.org/firearms#fire might denote the action of firing a gun, or the verb URI http://example.com/فعل/خواندن might denote the action of reading a book.
The person who coins a new verb...
- MUST own the URI, or...
- MUST have permission from the owner to use it to denote an xAPI verb;
- SHOULD make a human-readable description of the intended usage of the verb accessible at the URI.
ADL released a set of recommended verbs. Other lists have been published by other groups and organisations. If the meaning of one of the verbs on these lists is intended, Learning Activity Providers...
- SHOULD use the corresponding existing verb;
- MAY create and use their own verbs where a suitable verb does not already exist.
In some future version, this specification might specify additional machine-readable information about the verb be made available, but the choice to do so is postponed to monitor emerging practices.
The verb object is the representation of a verb that is actually included in a statement. It consists of:
- a reference the verb itself via a URI;
- a display property which provides the human-readable meaning of the verb in one or more languages.
The display property:
- MUST be used to illustrate the meaning which is already determined by the verb URI;
- MUST NOT be used to alter the meaning of a verb;
- SHOULD be used by all statements.
A system reading a statement:
- MUST use the verb URI to infer meaning;
- MUST NOT use the display property to infer any meaning from the statement;
- MUST NOT use the display property for any purpose other than display to a human. For example, the display property MUST NOT be used for aggregation or categorization of statements.
The table below lists all properties of the Verb object.
| Property | Type | Description | Example |
|---|---|---|---|
| id | URI | Corresponds to a verb definition. Each verb definition corresponds to the meaning of a verb, not the word. The URI should be human-readable and contain the verb meaning. | id : "http://www.adlnet.gov/XAPIprofile/ran(travelled_a_distance)" |
| display | Language Map | The human readable representation of the verb in one or more languages. This does not have any impact on the meaning of the statement, but serves to give a human-readable display of the meaning already determined by the chosen verb. | display : { "en-US" : "ran"} display : { "en-US" : "ran", "es" : "corrió" } |
The verb in the table above is included for illustrative purposes only. This is not intended to imply that a verb with this meaning has been defined with this id. This applies to all example verbs given in this specification document, with the exception of the reserved verb 'http://adlnet.gov/expapi/verbs/voided'.
####4.1.4 Object
The object of a statement is the Activity, Agent, or Statement that is the object of the statement. It is the "this" part of the statement, cf. "I did this".
Objects which are provided as a value for this field SHOULD include an "objectType" field. If not specified, the object is assumed to be an Activity. Other valid values are: Agent, Statement or StatementRef.
Objects in a statement may be either an Activity, an Agent or another statement. Some examples:
-
The object is an Activity: "Jeff wrote an essay about hiking."
-
The Object is an Agent: "Nellie interviewed Jeff."
-
The Object is a Statement: "Nellie commented on 'Jeff wrote an essay about hiking.'"
Statements as objects are typically, but not exclusively, used in scenarios where some existing activity is graded, reviewed or commented on.
A statement may represent an Activity as the object of the statement. An activity is any thing which is interacted with. See Section 3.0 Definitions.
| Property | Type | Description |
|---|---|---|
| objectType | String | MUST be "Activity" when present. Optional in all cases. |
| id | URI | Required. MAY be a URL, which points to the logical definition of the activity. This MAY point to metadata or the URL for the activity |
| definition | Optional Activity Definition Object | Metadata, See below |
An activity ID must always refer to a single unique activity. There may be corrections to that activity's definition. Spelling fixes would be appropriate, for example, but changing correct responses would not.
The activity ID is unique, and any reference to it always refers to the same activity. Activity Providers must ensure this is true and the LRS may not attempt to treat multiple references to the same ID as references to different activities, regardless of any information which indicates two authors or organizations may have used the same activity ID.
When defining an activity ID, care must be taken to make sure it will not be re-used. It should use a domain the creator controls or has been authorized to use for this purpose, according to a scheme the domain owner has adopted to make sure activity IDs within that domain remain unique.
Any state or statements stored against an activity ID must be compatible and consistent with any other state or statements that are stored against the same activity ID, even if those statements were stored in the context of a new revision or platform.
The prohibition against an LRS treating references to the same activity ID as two different activities, even if the LRS can positively determine that was the intent, is crucial to prevent activity ID creators from creating IDs that could be easily duplicated, as intent would be indeterminable should a conflict with another system arise.
Activity definitions SHOULD include populated name, description, and type properties. Other properties defined below MAY be included.
<td>type</td>
<td>URI</td>
<td>the type of activity. Note, URI fragments (sometimes called
relative URLs) are not valid URIs. <a href="#verb-lists-and-repositories">As with verbs</a>, we recommend
that Learning Activity Providers look for and use established,
widely adopted, activity types.
</td>
</tr>
<tr>
<td>url</td>
<td>URL</td>
<td>A url which SHOULD resolve to human-readable information about the activity,
which MAY include a way to 'launch' the activity.
</td>
</tr>
<tr>
<td>interactionType | correctResponsesPattern | choices | scale |
source | target | steps</td>
<td colspan="2"><a href="#interactionacts">See "Interaction Activities"</a></td>
</tr>
<tr>
<td>extensions</td>
<td>Extensions Object</td>
<td>A map of other properties as needed (see: <a href="#miscext">Extensions</a>)</td>
</tr>
| Property | Type | Description |
|---|---|---|
| name | Language Map | The human readable/visual name of the activity |
| description | Language Map | A description of the activity |
An LRS should update its internal representation of an activity's definition upon receiving a statement with a different definition of the activity from the one stored, but only if it considers the Learning Activity Provider to have the authority to do so.
-
Activities with URL identifiers MAY host metadata using the activity definition JSON format which is used in statements, with a Content-Type of "application/json"
-
If the activity URI is a URL, LRS's SHOULD attempt to GET that URL, and include in HTTP headers: "Accept: application/json, /". This SHOULD be done as soon as practical after the LRS first encounters the activity id.
-
If the LRS loads JSON which is a valid activity definition from a URL used as an activity id, the LRS SHOULD incorporate the loaded definition into its internal definition for that activity, while preserving names or definitions not included in the loaded definition.
-
If the LRS loads any document from which the LRS can parse an activity definition from a URL used as an activity id, then the LRS MAY consider this definition when determining its internal representation of that activity's definition.
Traditional e-learning has included structures for interactions or assessments. As a way to allow these practices and structures to extend Experience API's utility, this specification include built in definitions for interactions which borrows from the CMI data model. These definitions are intended to provide a simple and familiar utility for recording interaction data. These definitions are simple to use, and consequently limited. It is expected that communities of practice requiring richer interactions definitions will do so through the use of extensions to an activity's type and definition.
When defining interaction activities, the activity type: "http://adlnet.gov/expapi/activities/cmi.interaction" SHOULD be used, and a valid interactionType MUST be specified. If interactionType is specified, an LRS processing MAY validate the remaining properties as specified in the table below, and return HTTP 400 "Bad Request" if the remaining properties are not valid for the interaction type.
| Property | Type | Description |
|---|---|---|
| interactionType | String | As in "cmi.interactions.n.type" as defined in the SCORM 2004 4th edition Runtime Environment. |
| correctResponsesPattern | An array of strings | Corresponds to "cmi.interactions.n.correct_responses.n.pattern" as defined in the SCORM 2004 4th edition Runtime Environment, where the final n is the index of the array. |
| choices | scale | source | target | steps | Array of interaction components | Specific to the given interactionType (see below). |
Interaction components are defined as follows:
| Property | Type | Description |
|---|---|---|
| id | String | As in "cmi.interactions.n.id" as defined in the SCORM 2004 4th edition Runtime Environment |
| description | Language Map | a description of the interaction component (for example, the text for a given choice in a multiple-choice interaction) |
The following table shows the supported lists of CMI interaction components for an interaction activity with the given interactionType.
| interactionType | supported component list(s) |
|---|---|
| choice, sequencing | choices |
| likert | scale |
| matching | source, target |
| performance | steps |
| true-false, fill-in, numeric, other | [No component lists defined] |
See Appendix C for examples of activity definitions for each of the cmi.interaction types.
Statements that specify an Agent or Group as an Object...
- MUST specify an 'objectType' property.
See Section 4.1.2 Actor for details regarding Agents.
A statement that is the object in another statement can either be existing or new. For example, when grading or commented on an experience that is tracked as an independant event, the existing statement about that experience will be the object of the statement. Also, in the special case of voiding, the object is an already existing statement. In these situations, a Statement Reference is used.
When the object is an experience that would be misleading as an independent statement, that experience can be tracked as a statement within a statement. These are called Sub-Statements. An example is given further below.
A statement reference is a pointer to another pre-existing statement.
The table below lists all properties of a Statement Reference object:
| Property | Type | Description |
|---|---|---|
| objectType | string | MUST be "StatementRef". |
| id | UUID | MUST be set to the UUID of a statement which is present on the system. |
Assuming that some statement has already been stored with the ID 8f87ccde-bb56-4c2e-ab83-44982ef22df0, the following example shows how a comment could be issued on the original statement, using a new statement:
{
"actor" : {
"objectType": "Agent",
"mbox":"mailto:[email protected]"
},
"verb" : {
"id":"http://example.com/commented",
"display": {
"en-US":"commented"
}
},
"object" : {
"objectType":"StatementRef",
"id":"8f87ccde-bb56-4c2e-ab83-44982ef22df0"
},
"result" : {
"response" : "Wow, nice work!"
}
}
A Sub-Statement is a new statement included as part of a parent statement.
A Sub-Statement...
- MUST specify an "objectType" property with the value "SubStatement";
- MUST NOT have the "id", "stored", or "authority" properties;
- MUST NOT contain a sub-statement of their own i.e. cannot be nested.
Implementations MUST validate the sub-statement as they would other statements, with the addition of these rules.
One interesting use of sub-statements is in creating statements of intention.
For example, using sub-statements we can create statements of the form
"<I> <planned> (<I> <did> <this>)" to indicate that we've planned to take some
action. The concrete example that follows logically states that
"I planned to visit 'Some Awesome Website'".
{
"actor": {
"objectType": "Agent",
"mbox":"mailto:[email protected]"
},
"verb" : {
"id":"http://example.com/planned",
"display":{
"en-US":"planned"
}
},
"object": {
"objectType": "SubStatement",
"actor" : {
"objectType": "Agent",
"mbox":"mailto:[email protected]"
},
"verb" : {
"id":"http://example.com/visited",
"display":{
"en-US":"will visit"
}
},
"object": {
"id":"http://example.com/website",
"definition": {
"name" : {
"en-US":"Some Awesome Website"
}
}
}
}
}
Whilst the verb display MAY take the future tense, the verb id SHOULD remain past tense. Later, when 'I' actually visit 'Some Awesome Website', reporting tools can thereby match the verb ids.
An optional field that represents a measured outcome related to the statement in which it is included.
A result can be completion, success, score, etc. The 'Result' field may also contain arbitrary measurements if needed by the Learning Activity Provider.
| property | type | description |
|---|---|---|
| score | Score object | The score of the agent in relation to the success or quality of the experience. |
| success | Boolean | Was the learning activity successful? |
| completion | Boolean | Was the learning activity completed? |
| response | String | A response appropriately formatted for the given activity. |
| duration | Formatted according to ISO 8601 with a precision of 0.01 seconds | Period of time over which the statement occurred. |
| Extensions | Extensions object | A map of other properties as needed. |
An optional numeric field that represents the outcome of a graded activity achieved by an agent.
The table below defines the score object.
| Property | Type | Description |
|---|---|---|
| scaled | Decimal number between -1 and 1, inclusive | Cf. 'cmi.score.scaled' in SCORM 2004 4th Edition |
| raw | Decimal number between min and max (if present, otherwise unrestricted), inclusive | Cf. 'cmi.score.raw' |
| min | Decimal number less than max (if present) | Cf. 'cmi.score.min' |
| max | Decimal number greater than min (if present) | Cf. 'cmi.score.max' |
The Score property...
- SHOULD include 'scaled' if a logical percent based score is known;
- SHOULD NOT be used for scores relating to progress or completion. Consider using an extension from an extension profile instead.
An optional field that provides a place to add contextual information to a statement. All its field properties are optional.
The "context" field provides a place to add some contextual information to a statement. It can store information such as the instructor for an experience, if this experience happened as part of a team activity, or how an experience fits into some broader activity.
| property | type | description |
|---|---|---|
| registration | UUID | The registration that the statement is associated with. See 4.1.6.1 |
| instructor | Agent (may be a group) | Instructor that the statement relates to, if not included as the Actor of the statement. |
| team | Group | Team that this statement relates to, if not included as the Actor of the statement. |
| contextActivities | contextActivities object | A map of the types of learning activity context that this statement is related to. Valid context types are: "parent", "grouping", "category", "other". See 4.1.6.2 |
| revision | String | Revision of the learning activity associated with this statement. Format is free. - SHOULD be used to track fixes of minor issues (like a spelling error), - SHOULD NOT be used if there is a major change in learning objectives, pedagogy, or assets of an activity. (Use a new activity ID instead). - MUST NOT be used if the statement's object is an Agent or Group. |
| platform | String | Platform used in the experience of this learning activity. - MUST NOT be used if the statement's object is an Agent or Group. Defined vocabulary, TBD. |
| language | String (as defined in RFC 5646) | Code representing the language in which the experience being recorded in this statement (mainly) occurred in, if
applicable and known. - MUST NOT be used if not applicable or unknown. |
| statement | Statement by reference or by object | Another statement (either existing or new), which should be considered as context for this statement. See Section 4.1.4.3 for details about including statements within other statements. |
| extensions | Extensions object | A map of any other domain-specific context relevant to this statement. For example, in a flight simulator altitude, airspeed, wind, attitude, GPS coordinates might all be relevant (See Section 5.3) |
An instance of a learner undertaking a particular learning activity.
When an LRS is an integral part of an LMS, the LMS likely supports the concept of registration. For example all the statements about one time a person took a test might have one registration. If the learner takes the test again, the statements from this second occasion would have a different registration from the first occasion.
The LMS may also close the registration at some point when it considers the learning experience complete. For Experience API purposes, a registration may be applied more broadly; an LMS could assign a group of students to a group of activities and track all related statements in one registration.
A map of the types of learning activity context that this statement is related to.
Many statements do not just involve one object activity that is the focus, but relate to other contextually relevant activities. "Context activities" allow for these related activities to be represented in a structured manner.
- every key in the contextActivities object MUST be one of parent, grouping, category, or other.
- every value in the contextActivities object MUST be either a single Activity object or an array of Activity objects.
- every value in the contextActivities object SHOULD be an array of Activity objects instead of a single Activity object.
- every value in the contextActivities object MUST be returned as an array, even if it arrived as a single Activity object (in which case it MUST be returned as an array of length one containing the same Activity).
There are four valid context types. All, any or none of these MAY be used in a given statement:
-
Parent : an activity with a direct relation to the activity which is the object of the statement. In almost all cases there is only one sensible parent or none, not multiple. For example: a statement about a quiz question would have the quiz as its parent activity.
-
Grouping : an activity with an indirect relation to the activity which is the object of the statement. For example: a course that is part of a qualification. The course has several classes. The course relates to a class as the parent, the qualification relates to the class as the grouping.
-
Category : an activity used to categorize the statement. "Tags" would be a synonym. Category SHOULD be used to indicate a "profile" of xAPI behaviors, as well as other categorizations. For example: Anna attempts a biology exam, and the statement is tracked using the CMI-5 profile. The statement's activity refers to the exam, and the category is the CMI-5 profile.
-
Other : a context activity that doesn't fit one of the other fields. For example: Anna studies a textbook for a biology exam. The statement's activity refers to the textbook, and the exam is a context activity of type "other".
Single Activity objects are allowed as values so that 0.95 statements will be compatible with 1.0.0.
The values in this section are not for expressing all the relationships the statement object has. Instead, they are for expressing relationships appropriate for the specific statement (though the nature of the object will often be important in determining that). For instance, it is appropriate in a statement about a test to include the course the test is part of as parent, but not to include every possible degree program the course could be part of in the grouping value.
{
"other" : [{
"id" : "http://example.adlnet.gov/xapi/example/test"
}]
}
Consider the following hierarchical structure: "Questions 1 to 6" are part of "Test 1" which in turn belongs to the course "Algebra 1". The six questions are registered as part of the test by declaring "Test 1" as their parent. Also they are grouped with other statements about "Algebra 1" to fully mirror the hierarchy. This is particularly useful when the object of the statement is an agent, not an activity. "Andrew mentored Ben with context Algebra I".
{
"parent" : [{
"id" : "http://example.adlnet.gov/xapi/example/test 1"
}],
"grouping" : [{
"id" : "http://example.adlnet.gov/xapi/example/Algebra1"
}]
}
The time at which a statement about an experience took place.
A timestamp:
- MUST be formatted according to ISO 8601;
- MAY be truncated or rounded to a precision of at least 3 decimal digits for seconds (millisecond precision MUST be preserved)
- SHOULD include the timezone;
- MAY be a moment in the future, to denote a deadline for planned learning, provided it is included inside a SubStatement;
- SHOULD be the current or a past time when it is outside of a SubStatement.
A reporting tool:
- MAY consider timestamps from different timezones that represent the same logical time to be equivalent.
A timestamp in a statement related to learning that occurs outside of the system can differ from 4.1.8. Stored (the system time of the event). Namely, there can be delays between the occurrence of the experience and the reception of the corresponding statement by the LRS. Another cause is when statements are propagated to other systems.
The time at which a statement is stored by the LRS.
Stored time:
- MUST be formatted according to ISO 8601;
- MAY be truncated or rounded to a precision of at least 3 decimal digits for seconds (millisecond precision MUST be preserved)
- SHOULD include the timezone;
- SHOULD be the current or a past time
A reporting tool:
- MAY consider stored time from different timezones that represent the same logical time to be equivalent.
The authority property provides information about who or what has asserted that this statement is true. Consequently, the asserting authority may be an Agent (representing the authenticating user or some system or application), or in the case of 3-legged OAuth workflows, a Group of two Agents representing an application and user together. Unless used in the aforementioned 3-legged OAuth workflow, a Group MUST NOT be used to assert authority.
-
The LRS SHOULD overwrite the authority on all stored received statements, based on the credentials used to send those statements.
-
The LRS MAY leave the submitted authority unchanged but SHOULD do so only where a strong trust relationship has been established, and with extreme caution.
-
The LRS MUST ensure that all statements stored have an authority.
If a statement is stored using a validated OAuth connection, and the LRS creates or modifies the authority property of the statement, the authority MUST contain an agent object that represents the OAuth consumer, either by itself, or as part of a group in the case of 3-legged OAuth. This agent MUST be identified by account, and MUST use the consumer key as the account name field. If the OAuth consumer is a registered application, then the token request endpoint MUST be used as the account homePage, otherwise the temporary credentials endpoint must be used as the account homePage.
Except as specified in the paragraph above, agent objects MUST NOT use any OAuth endpoint as an account homePage.
The behavior of an LRS SHOULD NOT rely on Agents with an account using the temporary credentials endpoint as the homePage and with matching account names coming from the same source, as there is no way to verify that, since multiple unregistered applications could choose the same consumer key. Each unregistered consumer SHOULD pick a unique consumer key.
If a user connects directly (using HTTP Basic Authentication) or is included as part of a 3-legged OAuth workflow, the LRS MUST include the user as an Agent in the authority, and MAY identify the user with any of the legal identifying properties.
In a 3-legged OAuth workflow, authentication involves both an OAuth consumer and a user of the OAuth service provider. For instance, requests made by an authorized Twitter plugin on your Facebook account will include credentials that are specific not only to Twitter as a client application, or you as a user, but the unique combination of both.
To support this concept, an LRS preparing the authority of a statement received via 3-legged OAuth MUST use a pairing of an application and a user. Below is a concrete example which represents a pairing of an OAuth consumer and a user.
"authority": {
"objectType" : "group",
"member": [
{
"account": {
"homePage":"http://example.com/xAPI/OAuth/Token",
"name":"oauth_consumer_x75db"
}
},
{
"mbox":"mailto:[email protected]"
}
]
}
Version information in statements helps systems that process data from an LRS get their bearings. Since the statement data model is guaranteed consistent through all 1.0.x versions, in order to support data flow among such LRSs the LRS is given some flexibility on statement versions that are accepted.
- Version MUST be formatted as laid out for the API version header in API Versioning
- An LRS MUST accept all statements where their version starts with "1.0." if they otherwise validate;
- An LRS MUST reject all statements with a version specified that does not start with "1.0;"
- Statements returned by an LRS MUST retain the version they are accepted with. If they lack a version, the version MUST be set to 1.0.0.
- Clients SHOULD NOT set the statement version;
- If clients set the statement version, they MUST set it to 1.0.0
A digital artefact providing evidence of a learning experience.
In some cases an attachment may logically be an important part of a learning record. Think of a simulated communication with ATC, an essay, a video, etc. Another example of such an attachment is (the image of) a certificate that was granted as a result of an experience. It is useful to have a way to store these attachments in and retrieve them from an LRS.
The table below lists all properties of the Attachment object.
<td>usageType</td>
<td>URI</td>
<td>Identifies the usage of this attachment. For example: one expected use case
for attachments is to include a "completion certificate". A type URI corresponding
to this usage should be coined, and used with completion certificate attachments.</td>
<td>yes</td>
</tr>
<tr>
<td>display</td>
<td><a href="#misclangmap">Language Map</a></td>
<td>Display name (title) of this attachment.</td>
<td>yes</td>
</tr>
<tr>
<td>description</td>
<td><a href="#misclangmap">Language Map</a></td>
<td>A description of the attachment</td>
<td>no</td>
</tr>
<tr>
<td>contentType</td>
<td><a href="https://www.ietf.org/rfc/rfc2046.txt?number=2046">Internet Media Type</a></td>
<td>The content type of the attachment.</td>
<td>yes</td>
</tr>
<tr>
<td>length</td>
<td>integer</td>
<td>The length of the attachment data in octets</td>
<td>yes</td>
</tr>
<tr>
<td>sha2</td>
<td>base64</td>
<td>The SHA-2 hash of the attachment data. A minimum key size of 256 bits is recommended.</td>
<td>yes</td>
</tr>
<tr>
<td>fileUrl</td>
<td>URL</td>
<td>A URL at which the attachment data may be retrieved, or from which it used to be retrievable. </td>
<td>no</td>
</tr>
| Property | Type | Description | Required |
|---|---|---|---|
Since these attachments may lead to very large statements, it should be possible for a client to filter out attachments when retrieving statements, by following this procedure:
-
A statement including an attachment is construed according to the Transmission Format described below.
-
The statement is sent to the receiving system using a content-Type of "multipart/mixed". The attachments are placed at the end of such transmissions.
-
The receiving system decides whether to accept or reject the statement based on the
information in the first part. -
If it accepts the attachment, it can match the raw data of an attachment with the attachment header in a statement by comparing the SHA-2 of the raw data to the SHA-2 declared in the header.
A statement batch that includes attachments:
- MUST be of type "application/json" and include a fileUrl for every attachment or
- MUST conform to the definition of multipart/mixed in RFC 1341 and:
- The first part of the multipart document MUST contain the statements themselves, with type "applicaton/json";
- Each additional part contains the raw data for an attachment and forms a logical part of the statement. This capability will be available when issuing PUT or POST against the statement resource.
- SHOULD only include one copy of an attachment's data when the same attachment is used in multiple statements that are sent in one batch;
- SHOULD include a Content-type field in each part's header, for the first part this MUST be "application/json";
- MUST include a X-Experience-API-Hash field in each part's header after the first (statements) part;
- This field MUST be set to match the "sha2" property of the attachment declaration corresponding to the attachment included in this part.
- MUST include a Content-Transfer-Encoding field with a value of "binary" in each part's header after the first (statements) part;
- MUST NOT pull statements from another LRS without requesting attachments;
- MUST NOT push statements into another LRS without including attachment data received, if any, for those attachments;
- MUST include attachments in the Transmission Format described above when requested by the client (see Section 7.2 "Statement API");
- MAY reject (batches of) statements that are larger than the LRS is configured to allow;
- When receiving a PUT or POST with a document type of "application/json"
- MUST accept batches of statements which contain either no attachment objects, or only attachment objects with a populated fileUrl;
- Otherwise:
- MUST accept batches of statements via the statements resource PUT or POST that contain attachments in the Transmission Format described above;
- MUST reject batches of statements having attachments that neither contain a fileUrl nor match a received attachment part based on their hash;
- SHOULD assume a Content-Transfer-Encoding of binary for attachment parts.
Note: There is no requirement that statement batches using the mime/multipart format contain attachments.
- MAY send statements with attachments as described above;
- MAY send multiple statements where some or all have attachments if using "POST".
- MAY send batches of type "application/json" where every attachment object has a fileUrl, ignoring all requirements based on the "multipart/mixed" format.
Below is an example of a very simple statement with an attachment. Please note the following:
- The boundary in the sample was chosen to demonstrate valid character classes;
- The selected boundary does not appear in any of the parts;
- For readability the sample attachment is text/plain. Even if it had been a 'binary' type like 'image/jpeg' no encoding would be done, the raw octets would be included;
- Per RFC 1341, the boundary is followed by -- followed by the boundary string declared in the header.
Don't forget the <CRLF> when building or parsing these messages.
Headers:
Content-Type: multipart/mixed; boundary=abcABC0123'()+_,-./:=?
X-Experience-API-Version:1.0.0
Content:
--abcABC0123'()+_,-./:=?
Content-Type:application/json
{
"actor": {
"mbox": "mailto:[email protected]",
"name": "Sample Agent",
"objectType": "Agent"
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/answered",
"display": {
"en-US": "answered"
}
},
"object": {
"id": "http://www.example.com/tincan/activities/multipart",
"objectType": "Activity",
"definition": {
"name": {
"en-US": "Multi Part Activity"
},
"description": {
"en-US": "Multi Part Activity Description"
}
}
},
"attachments": [
{
"usageType": "http://example.com/attachment-usage/test",
"display": { "en-US": "A test attachment" },
"description": { "en-US": "A test attachment (description)" },
"contentType": "text/plain; charset=ascii",
"length": 27,
"sha2": "495395e777cd98da653df9615d09c0fd6bb2f8d4788394cd53c56a3bfdcd848a"
}
]
}
--abcABC0123'()+_,-./:=?
Content-Type:text/plain
Content-Transfer-Encoding:binary
X-Experience-API-Hash:495395e777cd98da653df9615d09c0fd6bb2f8d4788394cd53c56a3bfdcd848a
here is a simple attachment
--abcABC0123'()+_,-./:=?--
All the properties used in statements are restricted to certain types, and those types constrain the behavior of systems processing statements. For clarity, certain key requirements are documented here, emphasizing where compliant systems have a responsibility to act in certain ways.
The following requirements reiterate especially important requirements already included elsewhere, to emphasize, clarify, and provide implementation guidance.
- Values requiring IRIs MUST be sent with valid IRIs. Please use a library to construct them instead of string concatenation. Complete IRI validation is extremely difficult, so much of the burden for ensuring data portability is on the client.
- For similar reasons, keys of language maps MUST be sent with valid RFC 5646 language tags.
- MUST reject statements
- with any null values (except inside extensions).
- with strings where numbers are required, even if those strings contain numbers.
- with strings where booleans are required, even if those strings contain booleans.
- with any non-format-following key or value, including the empty string, where a. string with a particular format (such as mailto URI, UUID, or IRI) is required.
- where the case of a key does not match the case specified in the standard.
- where the case of a value restricted to enumerated values does not match an enumerated value given in the standard exactly.
- MAY use best-effort validation for URL, URI, and IRI formats to satisfy the non-format-following rejection requirement.
- MUST reject statements containing URL, URI, or IRI values without a scheme.
- MAY use best-effort validation for language map keys to satisfy the non-format-following rejection requirement.
- MUST at least validate that the sequence of token lengths for language map keys matches the RFC 5646 standard.
- MUST process and store numbers with at least the precision of IEEE 754 32-bit floating point numbers.
- MUST validate parameter values to the same standards required for values of the same types in statements. Note: string parameter values are not quoted as they are in JSON.
A collection of statements can be retrieved by performing a query on the "statements" endpoint, see Section 7.2 "Statement API" for details.
| Property | Type | Description |
|---|---|---|
| statements | Array of Statements | List of statements. If the list returned has been limited (due to pagination), and there are more results, they will be located at the "statements" property within the container located at the URL provided by the "more" element of this statement result object. |
| more | URL | Relative URL that may be used to fetch more results, including the full path
and optionally a query string but excluding scheme, host, and port.
Empty string if there are no more results to fetch. |
The certainty that an LRS has an accurate and complete collection of data is guaranteed by the fact that statements cannot be logically changed or deleted. This immutability of statements is a key factor in enabling the distributed nature of Experience API. However, not all statements are perpetually valid once they have been issued. Mistakes or other factors could require that a previously made statement is marked as invalid. This is called "voiding a statement" and the reserved verb “http://adlnet.gov/expapi/verbs/voided" is used for this purpose.
When issuing a statement that voids another, the object of that voiding statement...
- MUST have the "objectType" field set to "StatementRef;"
- MUST specify the ID of the statement-to-be-voided by its "id" field.
Upon receiving a statement that voids another, the LRS...
- MAY roll back any changes to activity or agent definitions which were introduced by the statement that was just voided;
- SHOULD return a descriptive error if the target statement cannot be found;
- MUST NOT report the voided statement when queried, but MUST report the voiding statement (see StatementRef in 7.2 Statement API).
{
"actor" : {
"objectType": "Agent",
"name" : "Example Admin",
"mbox" : "mailto:[email protected]"
},
"verb" : {
"id":"http://adlnet.gov/expapi/verbs/voided",
"display":{
"en-US":"voided"
}
},
"object" : {
"objectType":"StatementRef",
"id" : "e05aa883-acaf-40ad-bf54-02c8ce485fb0"
}
}
This example statement voids a previous statement which it identifies with the statement ID "e05aa883-acaf-40ad-bf54-02c8ce485fb0".
Any statement that voids another cannot itself be voided. An activity provider that wants to "unvoid" a previously voided statement...
- SHOULD issue that statement again under a new ID
A reporting system...
- SHOULD NOT show voided or voiding statements by default.
See "Statement References" in Section 4.1.4.3 When the "Object" is a Statement for details about making references to other statements.
A statement may include a digital signature to provide strong and durable evidence of the authenticity and integrity of the statement.
Some statements will have regulatory or legal significance, or otherwise require strong and durable evidence of their authenticity and integrity. It may be necessary to verify these statements without trusting the system they were first recorded in, or perhaps without access to that system. Digital signatures will enable a third-party system to validate such statements.
Signed statements include a JSON web signature (JWS) as an attachment. This allows the original serialization of the statement to be included along with the signature. For interoperability, the "RSA + SHA" series of JWS algorithms have been selected, and for discoverability of the signer X.509 certificates SHOULD be used.
- MUST include a JSON web signature (JWS) as defined here: http://tools.ietf.org/html/draft-ietf-jose-json-web-signature, as an attachment with a usageType of "http://adlnet.gov/expapi/attachments/signature" and a contentType of "application/octet-stream".
- The JWS signature MUST have a payload of a valid JSON serialization of the statement generated before the signature was added.
- The JWS signature MUST use an algorithm of "RS256","RS384", or "RS512"
- The JWS signature SHOULD have been created based on the private key associated with an X.509 certificate.
- If X.509 was used to sign, the JWS header SHOULD include the "x5c" property containing the associated certificate chain.
LRS requirements when receiving a signed statement:
- The LRS MUST reject requests to store statements that contain malformed signatures,
with HTTP 400 and SHOULD include a message describing the problem in the response.
In order to verify signatures are well formed, the LRS MUST do the following:
- Decode the JWS signature, and load the signed serialization of the statement from the JWS signature payload.
- Validate that the "original" statement is logically equivalent to the received statement.
- If the JWS header includes an X.509 certificate, validate the signature against that certificate as defined in JWS.
Note: The step of validating against the included X.509 certificate is intended as a way to catch mistakes in the signature, not as a security measure. Clients MUST NOT assume a signature is valid simply because an LRS has accepted it. The steps to authenticate a signed statement will vary based on the degree of certainty required and are outside the scope of this specification.
See Appendix F: Example Signed Statement for an example.
The Experience API provides a facility for Activity Providers to save arbitrary data in the form of documents, which may be related to an Activity, Agent, or combination of both.
| Property | Type | Description |
|---|---|---|
| id | String | Set by AP, unique within state scope (learner, activity). |
| updated | Timestamp | When the document was most recently modified. |
| contents | Arbitrary binary data | The contents of the document |
A language map is a dictionary where the key is a RFC 5646 Language Tag, and the value is a string in the language specified in the tag. This map should be populated as fully as possible based on the knowledge of the string in question in different languages.
Extensions are defined by a map. The keys of that map MUST be URLs, and the values MAY be any JSON value or data structure. The meaning and structure of extension values under a URL key are defined by the person who coined the URL, who SHOULD be the owner of the URL, or have permission from the owner. The owner of the URL SHOULD make a human-readable description of the intended meaning of the extension supported by the URL accessible at the URL. A learning record store MUST NOT reject an Experience API statement based on the values of the extensions map.
Extensions are available as part of activity definitions, as part of statement context, or as part of some statement result. In each case, they're intended to provide a natural way to extend those elements for some specialized use. The contents of these extensions might be something valuable to just one application, or it might be a convention used by an entire community of practice.
Extensions should logically relate to the part of the statement where they are present. Extensions in statement context should provide context to the core experience, while those in the result should provide elements related to some outcome. For activities, they should provide additional information that helps define an activity within some custom application or community.
A statement should not be totally defined by its extensions, and be meaningless otherwise. Experience API statements should be capturing experiences among actors and objects, and SHOULD always strive to map as much information as possible into the built in elements, in order to leverage interoperability among Experience API conformant tools.
There are several types of URI identifiers used in this specification:
For activity ids, see activity definition.
For all other identifiers, metadata MAY be provided in the following JSON format:
| Property | Type | Description |
|---|---|---|
| name | Language Map | The human readable/visual name |
| description | Language Map | description |
If metadata is provided, both name and description SHOULD be included.
- For any of the identifier URIs above, if the URI is a URL that was coined for use with this specification, the owner of that URL SHOULD make this JSON metadata available at that URL when the URL is requested and a Content-Type of "application/json" is requested.
- If this metadata is provided as described above, it is the canonical source of information about the identifier it describes
- Other sources of information MAY be used to fill in missing details, such as translations, or take the place of this metadata entirely if it was not provided or can not be loaded. This MAY include metadata in other formats stored at the URL of an identifier, particularly if that identifier was not coined for use with this specification.
As with verbs, we recommend that Learning Activity Providers look for and use established, widely adopted identifiers for all types of URI identifier other than activity id. Where an identifier already exists, the Learning Activity Provider:
- SHOULD use the corresponding existing identifier;
- MAY create and use their own verbs where a suitable identifier does not already exist.
Sections 6 and 7 detail the more technical side of the Experience API, dealing with how statements are transferred between Activity Provider and LRS. A number of libraries are under development for a range of technologies (including JavaScript) which handle this part of the specification. It therefore may not be necessary for content developers to fully understand every detail of this part of the specification.
All strings must be encoded and interpreted as UTF-8.
Every request from a client and every response from the LRS must include an HTTP header with the name “X-Experience-API-Version" and the version as the value. Starting with 1.0.0, xAPI will be versioned according to Semantic Versioning 1.0.0
Example: X-Experience-API-Version : 1.0.0
Future revisions of the specification may introduce changes such as properties added to statements.
Systems retrieving statements may then receive responses that include statements of different versions. The version header allows for these version differences to be handled correctly, and to ascertain that no partial or mixed LRS version implementations exist.
Using Semantic Versioning will allow clients and LRSs to reliably know whether they're compatible or not as the specification changes.
Requirements for the LRS:
- MUST include the "X-Experience-API-Version" header in every response;
- MUST set this header to ""1.0.0"";
- MUST reject requests with version header prior to "1.0.0" unless such requests are routed to a fully conformant implementation of the prior version specified in the header;
- MUST reject requests with a version header of "1.1.0" or greater;
- MUST make these rejects by responding with an HTTP 400 error including a short description of the problem.
Requirements for the client:
- SHOULD tolerate receiving responses with a version of "1.0.0" or later;
- SHOULD tolerate receiving data structures with additional properties;
- SHOULD ignore any properties not defined in version 1.0.0 of the spec.
Converting statements to other versions:
- Systems MUST NOT convert statements of newer versions into a prior version format e.g. in order to handle version differences.
- Systems MAY convert statements of older versions into a newer version only by following the methods described in Appendix E: Converting Statements to 1.0.0.
In order to prevent "lost edits" due to API consumers PUT-ing changes based on old data, xAPI will use HTTP 1.1 entity tags (ETags) to implement optimistic concurrency control in the portions of the API where PUT may overwrite existing data. (State API, Actor and Activity Profile APIs). The requirements in the rest of this "Concurrency" section only apply to those APIs.
When responding to a GET request, the LRS will add an ETag HTTP header to the response. The value of this header must be a hexidecimal string of the SHA-1 digest of the contents, and must be enclosed in quotes.
The reason for specifying the LRS ETag format is to allow API consumers that can't read the ETag header to calculate it themselves.
When responding to a PUT request, the LRS must handle the If-Match header or If-None-Match header as described in RFC2616, HTTP 1.1, if the If-Match header contains an ETag, or the If-None-Match header contains "*". In the first case, this is to detect modifications made after the consumer last fetched the document, and in the second case, this is to detect when there is a resource present that the consumer is not aware of.
In either of the above cases, if the header precondition specified fails, the LRS must return HTTP status 412 "Precondition Failed", and make no modification to the resource.
xAPI consumers should use these headers to avoid concurrency problems. The State API will permit PUT statements without concurrency headers, since state conflicts are unlikely. For other APIs that use PUT (Actor and Activity Profile), the headers are required. If a PUT request is received without either header for a resource that already exists, the LRS must return HTTP status 409 "Conflict", and return a plain text body explaining that the consumer must check the current state of the resource and set the "If-Match" header with the current ETag to resolve the conflict. In this case, the LRS must make no modification to the resource.
The LRS MUST support authentication using at least one of the following methods:
- OAuth 1.0 (rfc5849), with signature methods of "HMAC-SHA1", "RSA-SHA1", and "PLAINTEXT"
- HTTP Basic Authentication
- Common Access Cards (implementation details to follow in a later version)
The LRS is always responsible for making, or delegating, decisions on the validity of statements, and determining what operations may be performed based on the credentials used.
The below matrix describes the possible authentication scenarios.
A registered application is an application that will authenticate to the LRS as an OAuth consumer that has been registered with the LRS. A known user is a user account on the LRS, or on a system which the LRS trusts to define users.
| Known user | User unknown | |
|---|---|---|
| Application is registered | Standard workflow for OAuth. | LRS trusts application to access xAPI without additional user credentials. OAuth token steps are not invoked |
| Application is not registered | The application Agent is not identified as a registered Agent and the LRS cannot make assumptions on its identity. | |
| No application | HTTP Basic Authentication is used instead of OAuth, since no application is involved. | |
| No authentication | MAY be supported by the LRS, possibly for testing purposes. | |
- The LRS must record the application's name and a unique consumer key (identifier);
- The LRS must provide a mechanism to complete this registration, or delegate to another system that provides such a mechanism; The means by which this registration is accomplished are not defined by OAuth or the xAPI.
- Use endpoints below to complete the standard workflow.
- If this form of authentication is used to record statements and no authority is specified, the LRS should record the authority as a group consisting of an Agent representing the registered application, and an Agent representing the known user.
- LRS will honor requests that are signed using OAuth with the registered application's credentials and with an empty token and token secret.
- If this form of authentication is used to record statements and no authority is specified, the LRS should record the authority as the Agent representing the registered application.
- Use a blank consumer secret;
- Call "Temporary Credential" request;
- Specify "consumer_name" and other usual parameters; User will then see "consumer_name" plus a warning that the identity of the application requesting authorization cannot be verified.
- the LRS MUST record an authority that includes both that application and the authenticating user, as a group, since OAuth specifies an application.
- Use username/password combination that corresponds to an LRS login.
- Authority to be recorded as the Agent identified by the login, unless…
- other Authority is specified and…
- LRS trusts the known user to specify this Authority.
- Requests should include headers for HTTP Basic Authentication based on a blank username and password, in order to distinguish an explicitly unauthenticated request from a request that should be given a HTTP Basic Authentication challenge.
Requirements for the LRS:
- MUST be able to be configured for complete support of the xAPI
- With any of the above methods;
- In any of the workflow scenarios above.
- MAY (for security reasons):
- Support a subset of the above methods;
- Limit the known users or registered applications.
- SHOULD at a minimum supply Oauth with "HMAC-SHA1" and "RSA-SHA1" signatures.
The LRS will accept a scope parameter as defined in OAuth 2.0. If no scope is specified, a requested scope of "statements/write" and "statements/read/mine" will be assumed. The list of scopes determines the set of permissions that is being requested. An API client should request only the minimal needed scopes, to increase the chances that the request will be granted.
LRSs are not required to support any of these scopes except "all." These are recommendations for scopes which should enable an LRS and an application communicating using the xAPI to negotiate a level of access which accomplishes what the application needs while minimizing the potential for misuse. The limitations of each scope are in addition to any security limitations placed on the user account associated with the request.
For example, an instructor might grant "statements/read" to a reporting tool, but the LRS would still limit that tool to statements that the instructor could read if querying the LRS with their credentials directly (such as statements relating to their students).
xAPI scope values:
| Scope | Permission |
|---|---|
| statements/write | write any statement |
| statements/read/mine | read statements written by "me", that is with an authority matching what the LRS would assign if writing a statement with the current token. |
| statements/read | read any statement |
| state | read/write state data, limited to activities and actors associated with the current token to the extent it is possible to determine this relationship. |
| define | (re)Define activities and actors. If storing a statement when this is not granted, IDs will be saved and the LRS may save the original statement for audit purposes, but should not update its internal representation of any actors or activities. |
| profile | read/write profile data, limited to activities and actors associated with the current token to the extent it is possible to determine this relationship. |
| all/read | unrestricted read access |
| all | unrestricted access |
Note that the parameters "consumer_name" and "scope" are not part of OAuth 1.0, and therefore if used should be passed as query string or form parameters, not in the OAuth header.
| Name | Endpoint | Example |
|---|---|---|
| Temporary Credential Request | OAuth/initiate | http://example.com/xAPI/OAuth/initiate |
| Resource Owner Authorization | OAuth/authorize | http://example.com/xAPI/OAuth/authorize |
| Token Request | OAuth/token | http://example.com/xAPI/OAuth/token |
This section describes The xAPI consists of 4 sub-APIs: Statement, State, Learner, and Activity Profile. These four sub-APIs of the Experience API are handled via RESTful HTTP methods. The Statement API can be used by itself to track learning records.
Note: In all of the example endpoints given in the specification, "http://example.com/xAPI/" is the example URL of the LRS and everything after this represents the endpoint which MUST be used.
The LRS MUST reject with HTTP 400 Bad Request status (see below) any request to any of
these APIs using any parameters...
-
the LRS does not recognize (Note: LRSs may recognize and act on parameters not in this specification);
-
that match parameters described in this specification in all but case.
The list below offers some general guidance on HTTP error codes that could be returned from various methods in the API. An LRS MUST return the error code most appropriate to the error condition based on the list below, and SHOULD return a message in the response explaining the cause of the error.
-
400 Bad Request- Indicates an error condition caused by an invalid or missing argument. The term "invalid arguments" includes malformed JSON or invalid object structures. -
401 Unauthorized- Indicates that authentication is required, or in the case authentication has been posted in the request, that the given credentials have been refused. -
403 Forbidden- Indicates that the request is unauthorized for the given credentials. Note this is different than refusing the credentials given. In this case, the credentials have been validated, but the authenticated client is not allowed to perform the given action. -
404 Not Found- Indicates the requested resource was not found. May be returned by any method that returns a uniquely identified resource, for instance, any State or Agent Profile or Activity Profile API call targeting a specific document, or the method to retrieve a single statement. -
409 Conflict- Indicates an error condition due to a conflict with the current state of a resource, in the case of State API, Agent Profile or Activity Profile API calls, or in the statement PUT call. See Section 6.3 Concurrency for more details. -
412 Precondition Failed- Indicates an error condition due to a failure of a precondition posted with the request, in the case of State or Agent Profile or Activity Profile API calls. See Section 6.3 Concurrency for more details. -
413 Request Entity Too Large- Indicates that the LRS has rejected the statement or document because it's size is larger than the maximum allowed by the LRS. The LRS is free to choose any limit and MAY vary this limit on any basis e.g. per authority, but MUST be configurable to accept statements of any size. -
500 Internal Server Error- Indicates a general error condition, typically an unexpected exception in processing on the server.
The basic communication mechanism of the Experience API.
Example endpoint: http://example.com/xAPI/statements
Stores statement with the given ID.
Returns: 204 No Content
| Parameter | Type | Default | Description |
|---|---|---|---|
| statementId | String | ID of statement to record |
Example endpoint: http://example.com/xAPI/statements
Stores a statement, or a set of statements. Since the PUT method targets a specific statement ID, POST must be used rather than PUT to save multiple statements, or to save one statement without first generating a statement ID. An alternative for systems that generate a large amount of statements is to provide the LRS side of the API on the AP, and have the LRS query that API for the list of updated (or new) statements periodically. This will likely only be a realistic option for systems that provide a lot of data to the LRS.
Returns: 200 OK, statement ID(s) (UUID).
An LRS MUST NOT make any modifications to its state based on a receiving a statement
with a statementID that it already has a statement for. Whether it responds with
409 Conflict or 204 No Content, it MUST NOT modify the statement or any other
object.
If the LRS receives a statement with an ID it already has a statement for, it SHOULD
verify the received statement matches the existing one and return 409 Conflict if they
do not match.
The LRS MAY respond before statements that have been stored are available for retrieval.
Example endpoint: http://example.com/xAPI/statements
This method may be called to fetch a single statement or multiple statements. If the statementId or voidedStatementId parameter is specified a single statement is returned.
Otherwise returns: A StatementResult object, a list of statements in reverse chronological order based on "stored" time, subject to permissions and maximum list length. If additional results are available, a URL to retrieve them will be included in the StatementResult object.
Returns: 200 OK, statement or Statement Result (See Section 4.2 for details)
| Parameter | Type | Default | Description |
|---|---|---|---|
| statementId | String | ID of statement to fetch | |
| voidedStatementId | String | ID of voided statement to fetch. see Voided Statements | |
| agent | Agent or identified Group Object (JSON) | Filter, only return statements for which the specified agent or group is the actor or object of the statement.
See agent/group object definition for details. |
|
| verb | String | Filter, only return statements matching the specified verb id. | |
| activity | Activity id (URI) | Filter, only return statements for which the object of the statement is an activity with the specified id. | |
| registration | UUID | Filter, only return statements matching the specified registration ID. Note that although frequently a unique registration ID will be used for one actor assigned to one activity, this should not be assumed. If only statements for a certain actor or activity should be returned, those parameters should also be specified. | |
| related_activities | Boolean | False | Apply the activity filter broadly. Include statements for which the object, any of the context activities, or any of those properties in a contained SubStatement match the activity parameter, instead of that parameter's normal behavior. Matching is defined in the same way it is for the 'activity' parameter." |
| related_agents | Boolean | False | Apply the agent filter broadly. Include statements for which the actor, object, authority, instructor, team, or any of these properties in a contained SubStatement match the agent parameter, instead of that parameter's normal behavior. Matching is defined in the same way it is for the 'agent' parameter. |
| since | Timestamp | Only statements stored since the specified timestamp (exclusive) are returned. | |
| until | Timestamp | Only statements stored at or before the specified timestamp are returned. | |
| limit | Nonnegative Integer | 0 | Maximum number of statements to return. 0 indicates return the maximum the server will allow. |
| format | {"ids", "exact", "canonical"} | exact | If "ids", only include minimum information necessary in agent and
activity objects to identify them, If "exact", return agent and
activity objects populated exactly as they were when the statement was received. |
The LRS MUST reject with an HTTP 400 error any requests to this resource which:
-
contain both statementId and voidedStatementId parameters
-
contain statementId or voidedStatementId parameters, and also contain any other parameter besides "attachments" or "format".
The LRS MUST include the header "X-Experience-API-Consistent-Through", in ISO 8601 combined date and time format, on all responses to statements requests, with a value of the timestamp for which all statements that have or will have a "stored" property before that time are known with reasonable certainty to be available for retrieval. This time SHOULD take into account any temporary condition, such as excessive load, which might cause a delay in statements becoming available for retrieval.
Due to query string limits, this method MAY be called using POST and form fields if necessary. The LRS MUST differentiate a POST to add a statement or to list statements based on the parameters passed.
For filter parameters which are not time or sequence based (that is, other than since, until, or limit), statements which target another statement (by using a StatementRef as the object of the statement) will meet the filter condition if the targeted statement meets the condition. The time and sequence based parameters must still be applied to the statement making the StatementRef in this manner. This rule applies recursively, so that "statement a" is a match when a targets b which targets c and the filter conditions described above match for "statement c".
For example, consider the statement "Ben passed explosives training", and a follow up statement: "Andrew confirmed <StatementRef to original statement>". The follow up statement will not mention "Ben" or "explosives training", but when fetching statements with an actor filter of "Ben" or an activity filter of "explosives training", both statements match and will be returned so long as they fall into the time or sequence being fetched.
This section does not apply when retrieving statements with statementId or voidedStatementId.
The LRS MUST not return any statement which has been voided, unless that statement has been requested by voidedStatementId. The LRS MUST still return any statements targetting the voided statement when retrieving statements using explicit or implicit time or sequence based retrieval, unless they themselves have been voided, as described in the section on filter conditions for StatementRefs. This includes the voiding statement, which cannot be voided. Reporting tools can identify the presence and statementId of any voided statements by the target of the voiding statement. Reporting tools wishing to retrieve voided statements SHOULD request these individually by voidedStatementId.
The three Document APIs provide document storage for learning activity providers and agents. The details of each API are found in the following sections, and the information in this section applies to all three APIs.
An Activity Provider MAY send documents to any of the document APIs for activities and agents that the LRS does not have prior knowledge of. The LRS MUST NOT reject documents on the basis of not having prior knowledge of the activity and/or agent.
| API | Method | Endpoint | Example |
|---|---|---|---|
| State API | POST | activities/state | http://example.com/xAPI/activities/state |
| Activity Profile API | POST | activities/profile | http://example.com/xAPI/activities/profile |
| Agent Profile API | POST | agent/profile | http://example.com/xAPI/agents/profile |
APs MAY use Documents of content type "application/json" to store sets of variables. For example a document contains:
{
"x" : "foo",
"y" : "bar"
}
When an LRS receives a POST request with content type application/json for an existing document also of content type application/json, it MUST merge the posted document with the existing document. In this context merge is defined as:
- de-serialize the objects represented by each document
- for each property directly defined on the object being posted, set the corresponding property on the existing object equal to the value from the posted object.
- store any valid json serialization of the existing object as the document referenced in the request
Note that only top-level properties are merged, even if a top-level property is an object the entire contents of each original property are replaced with the entire contents of each new property.
For example, this document is POSTed with the same id as the existing document above:
{
"x" : "bash",
"z" : "faz"
}
the resulting document stored in the LRS is:
{
"x" : "bash",
"y" : "bar",
"z" : "faz"
}
If the original document exists, and the original document or the document being posted do not have a Content-Type: of "application/json", or if either document can not be parsed as JSON objects, the LRS MUST respond with HTTP status code 400 "Bad Request", and MUST NOT update the target document as a result of the request.
If the original document does not exist, the LRS MUST treat the request the same as it would a PUT request and store the document being posted.
If the merge is successful, the LRS MUST respond with HTTP status code 204 "No Content".
If an AP needs to delete a property, it SHOULD use a PUT request to replace the whole document as described below.
Generally, this is a scratch area for activity providers that do not have their own internal storage, or need to persist state across devices. When using the State API, be aware of how the stateId parameter affects the semantics of the call. If it is included, the GET and DELETE methods will act upon a single defined state document identified by "stateId". Otherwise, GET will return the available IDs, and DELETE will delete all state in the context given through the other parameters.
Example endpoint: http://example.com/xAPI/activities/state
Stores, fetches, or deletes the document specified by the given stateId that exists in the context of the specified activity, agent, and registration (if specified).
Returns: (PUT | POST | DELETE) 204 No Content, (GET) 200 OK - State Content
| Parameter | Type | Required | Description |
|---|---|---|---|
| activityId | String | yes | The activity ID associated with this state |
| agent | (JSON/XML) | yes | The agent associated with this state |
| registration | UUID | no | The registration ID associated with this state. |
| stateId | String | yes | The id for this state, within the given context. |
Example endpoint: http://example.com/xAPI/activities/state
Fetches IDs of all state data for this context (activity + agent [ + registration if specified]). If "since" parameter is specified, this is limited to entries that have been stored or updated since the specified timestamp (exclusive).
Returns: 200 OK, Array of IDs
| Parameter | Type | Required | Description |
|---|---|---|---|
| activityId | String | yes | The activity ID associated with these states. |
| agent | (JSON/XML) | yes | The actor associated with these states. |
| registration | UUID | no | The registration ID associated with these states. |
| since | Timestamp | no | Only IDs of states stored since the specified timestamp (exclusive) are returned. |
Example endpoint: http://example.com/xAPI/activities/state
Deletes all state data for this context (activity + agent [+ registration if specified]).
Returns: 204 No Content
| Parameter | Type | Required | Description |
|---|---|---|---|
| activityId | String | yes | The activity ID associated with this state |
| agent | (JSON/XML) | yes | The actor associated with this state |
| registration | UUID | no | The registration ID associated with this state. |
The Activity Profile API is much like the State API, allowing for arbitrary key / document pairs to be saved which are related to an Activity. When using the Activity Profile API for manipulating documents, be aware of how the profileId parameter affects the semantics of the call. If it is included, the GET and DELETE methods will act upon a single defined document identified by "profileId". Otherwise, GET will return the available IDs, and DELETE will delete all state in the context given through the other parameters.
The Activity Profile API also includes a method to retrieve a full description of an activity from the LRS.
Example endpoint: http://example.com/xAPI/activities
Loads the complete activity object specified.
Returns: 200 OK - Content
| Parameter | Type | Required | Description |
|---|---|---|---|
| activityId | String | yes | The ID associated with the activities to load. |
Example endpoint: http://example.com/xAPI/activities/profile
Saves/retrieves/deletes the specified profile document in the context of the specified activity.
Returns: (PUT | POST | DELETE) 204 No Content, (GET) 200 OK - Profile Content
| Parameter | Type | Required | Description |
|---|---|---|---|
| activityId | String | yes | The activity ID associated with this profile. |
| profileId | String | yes | The profile ID associated with this profile. |
Example endpoint: http://example.com/xAPI/activities/profile
Loads IDs of all profile entries for an activity. If "since" parameter is specified, this is limited to entries that have been stored or updated since the specified timestamp (exclusive).
Returns: 200 OK - List of IDs
| Parameter | Type | Required | Description |
|---|---|---|---|
| activityId | String | yes | The activity ID associated with these profiles. |
| since | Timestamp | no | Only IDs of profiles stored since the specified timestamp (exclusive) are returned. |
The Agent Profile API is much like the State API, allowing for arbitrary key / document pairs to be saved which are related to an Agent. When using the Agent Profile API for manipulating documents, be aware of how the profileId parameter affects the semantics of the call. If it is included, the GET and DELETE methods will act upon a single defined document identified by "profileId". Otherwise, GET will return the available IDs, and DELETE will delete all state in the context given through the other parameters.
The Agent Profile API also includes a method to retrieve a special object with combined information about an Agent derived from an outside service, such as a directory service.
Example endpoint: http://example.com/xAPI/agents
Return a special, Person object for a specified agent. The Person object is very similar to an Agent object, but instead of each attribute having a single value, each attribute has an array value, and it is legal to include multiple identifying properties. Note that the argument is still a normal Agent object with a single identifier and no arrays. Note that this is different from the FOAF concept of person, person is being used here to indicate a person-centric view of the LRS agent data, but agents just refer to one persona (a person in one context).
An LRS capable of returning multiple identifying properties for an Person SHOULD require the connecting credentials have increased, explicitly given permissions. An LRS SHOULD reject insufficiently privileged requests with 403 "Forbidden". If an LRS does not have any additional information about an Agent to return, the LRS MUST still return a Person when queried, but that Person object will only include the information associated with the requested Agent.
All array properties must be populated with members with the same definition as the similarly named property from Agent objects.
| Property | Type | Description |
|---|---|---|
| objectType | String | "Person". Required. |
| name | Array of strings. | Optional. List of names of Agents to retrieve. |
| mbox* | Array of URIs in the form "mailto:email address". | List of e-mail addresses of Agents to retrieve. |
| mbox_sha1sum* | Array of strings. | List of the SHA1 hashes of mailto URIs (such as go in an mbox property) |
| openid* | Array of strings. | List of openids that uniquely identify the agents to retrieve. |
| account* | Array of account objects. | List of accounts to match. Complete account objects (homePage and name) must be provided. |
See also: Section 4.1.2.1 Agent.
Returns: 200 OK - Expanded Agent Object
| Parameter | Type | Required | Description |
|---|---|---|---|
| agent | Object (JSON) | yes | The agent representation to use in fetching expanded agent information. |
Example endpoint: http://example.com/xAPI/agents/profile
Saves/retrieves/deletes the specified profile document in the context of the specified agent.
Returns: (PUT | POST | DELETE) 204 No Content, (GET) 200 OK - Profile Content
| Parameter | Type | Required | Description |
|---|---|---|---|
| agent | Object (JSON) | yes | The agent associated with this profile. |
| profileId | String | yes | The profile ID associated with this profile. |
Example endpoint: http://example.com/xAPI/agents/profile
Loads IDs of all profile entries for an agent. If "since" parameter is specified, this is limited to entries that have been stored or updated since the specified timestamp (exclusive).
Returns: 200 OK - List of IDs
| Parameter | Type | Required | Description |
|---|---|---|---|
| agent | Object (JSON) | yes | The agent associated with this profile. |
| since | Timestamp | no | Only IDs of profiles stored since the specified timestamp (exclusive) are returned |
Example endpoint: http://example.com/xAPI/about
Returns JSON object containing information about this LRS, including the xAPI version supported.
Primarily this resource exists to allow clients that suport multiple xAPI versions to decide which version to use when communicating with the LRS. Extensions are included to allow other uses to emerge.
Returns: 200 OK - Single 'about' JSON document.
| property | type | description |
|---|---|---|
| version | array of version strings | xAPI versions this LRS supports |
| Extensions | Extensions object | A map of other properties as needed. |
- MUST return the JSON document described above, with a version property that includes the
the latest minor and patch version the LRS conforms to, for each major version.
- For version 1.0.0 of this specification, this means that "1.0.0" MUST be included; "0.9" and "0.95" MAY be included. (For the purposes of this requirement, "0.9" and "0.95" are considered major versions.)
- SHOULD allow unauthenticated access to this resource
- MUST NOT reject requests based on their version header as would otherwise be required by 6.2 API Versioning.
One of the goals of the xAPI is to allow cross-domain tracking, and even though xAPI seeks to enable tracking from applications other than browsers, browsers still need to be supported. Internet Explorer 8 and 9 do not implement Cross Origin Resource Sharing, but rather use their own Cross Domain Request API, which cannot use all of the xAPI as described above due to only supporting "GET" and "POST", and not allowing HTTP headers to be set.
The following describes alternate syntax for consumers to use only when unable to use the usual syntax for specific calls due to the restrictions mentioned above. All LRSs must support this syntax.
Method: All xAPI requests issued must be POST. The intended xAPI method must be included as the only query string parameter on the request. (example: http://example.com/xAPI/statements?method=PUT)
Headers: Any required parameters which are expected to appear in the HTTP header must instead be included as a form parameter with the same name.
Content: If the xAPI call involved sending content, that content must now be encoded and included as a form parameter called "content". The LRS will interpret this content as a UTF-8 string, storing binary data is not supported with this syntax.
Attachments: Sending attachment data requires sending a multipart/mixed request, therefore sending attachment data is not supported with this syntax. See 4.1.11. Attachments
See Appendix B for an example function written in Javascript which transforms a normal request into one using this alternate syntax.
It should also be noted that versions of Internet Explorer lower than 10 do not support Cross Domain Requests between HTTP and HTTPS. This means that for IE9 and lower, if the LRS is on an HTTPS domain, the client sending the statement must also be on HTTPS. If the LRS is on HTTP, the client must be too.
There may be cases where there is a requirement for the client activity provider to support IE8 and IE9 where the client code is hosted on a different scheme (HTTP or HTTPS) from the LRS. In these cases, proxy is needed to communicate to the LRS. Two simple solutions might be to 1) set up a proxy pass through on the same scheme as the client code to the LRS or 2) to host an intermediary server side LRS on the same scheme as the client code to route statements to the target LRS. An LRS MAY choose to provide both HTTP and HTTPS endpoints to support this use case. HTTP is inherently less secure than HTTPS, and both LRS and client should consider the security risks before making the decision to use this scheme.
The function of the LRS within the xAPI is to store and retrieve statements. As long as it has sufficient information to perform these tasks, it is expected that it does them. Validation of statements in the Experience API is focused solely on syntax, not semantics. It SHOULD enforce rules regarding structure, but SHOULD NOT enforce rules regarding meaning. Enforcing the rules that ensure valid meaning among verb definitions, activity types, and extensions is the responsibility of the Activity Provider sending the statement.
The LRS will respond to HEAD requests by returning the meta information only, using the HTTP headers, and not the actual document.
Clients accessing the LRS may need to check if a particular statement exists, or determine the modification date of documents such as state or activity or agent profile. Particularly for large documents it's more efficient not to get the entire document just to check its modification date.
- The LRS MUST respond to any HTTP HEAD request as it would have responded to an otherwise
identical HTTP GET request except:
- The message-body MUST be omitted
- The Content-Length header MAY be omitted, in order to avoid wasting LRS resources
An xAPI Bookmarklet enables individual user tracking with base authentication. Examples could be an "I think this," "I learned this," "I like this," or "I don't like this" statement that allows self-reporting. The following is an example of such a bookmarklet, and the statement that this bookmarklet would send if used on the page: http://adlnet.gov/xapi.
The bookmarklet MAY be provided by the LRS to track a specific user for behavior analytics.
Therefore the LRS URL, authentication, and actor information is hard coded into the bookmarklet. Note that since the authorization token must be included in the bookmarklet, the LRS should provide a token with limited privileges, Ideally the token should enable the storage of self-reported learning statements only.
The UUID SHOULD be included as part of the bookmarklet PUT statement. If a statement is POSTed without a UUID, the LRS MUST generate one.
In order to allow cross-domain reporting of statements, a browser that supports the "Access-Control-Allow-Origin" and "Access-Control-Allow-Methods" headers must be used, such as IE 8+, FF 3.5+, Safari 4+, Safari iOS Chrome, or Android browser. Additionally the server must set the required headers.
In the example below, the following values in the first few lines should be replaced with your own values. All other values should be left as they are.
| Value in example | Explanation |
|---|---|
| http://localhost:8080/xAPI/ | Endpoint of the LRS to send the statements to. |
| dGVzdDpwYXNzd29yZA== | Base 64 encoded username and password, usually in the form "username : password". |
| [email protected] | Email address of the learner using the bookmarklet. |
var url = "http://localhost:8080/xAPI/statements?statementId="+_ruuid();
var auth = "Basic dGVzdDpwYXNzd29yZA==";
var statement = {
actor:{
"objectType": "Agent",
"mbox" : "mailto:[email protected]"
},
verb:"",
object:{
id:""
}
};
var definition = statement.object.definition;
statement.verb='http://adlnet.gov/expapi/verbs/experienced';
statement.object.id = window.location.toString();
definition.type="http://adlnet.gov/expapi/activities/link";
var xhr = new XMLHttpRequest();
xhr.open("PUT", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", auth);
xhr.onreadystatechange = function() {
if(xhr.readyState == 4) {
alert(xhr.status + " : " + xhr.responseText);
}
};
xhr.send(JSON.stringify(statement));
/*!
Modified from: Math.uuid.js (v1.4)
http://www.broofa.com
mailto:[email protected]
Copyright (c) 2010 Robert Kieffer
Dual licensed under the MIT and GPL licenses.
*/
function _ruuid() {
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
var r = Math.random()*16|0, v = c == 'x' ? r : (r&0x3|0x8);
return v.toString(16);
});
}{
"content-type": "application/json; charset=UTF-8",
"authorization": "d515309a-044d-4af3-9559-c041e78eb446",
"referer": "http://adlnet.gov/xapi/",
"content-length": "###",
"origin": "http://adlnet.gov"
}
PUT : /xAPI/Statements/?statementId=ed1d064a-eba6-45ea-a3f6-34cdf6e1dfd9
Body:
{
"actor": {
"objectType": "Agent",
"mbox": "mailto:[email protected]"
},
"verb": "http://adlnet.gov/expapi/verbs/experienced",
"object": {
"id": "http://adlnet.gov/xapi/ ",
"definition": {
"type": "http://adlnet.gov/expapi/activities/link"
}
}
}
function getIEModeRequest(method, url, headers, data){
var newUrl = url;
// Everything that was on query string goes into form vars
var formData = new Array();
var qsIndex = newUrl.indexOf('?');
if(qsIndex > 0){
formData.push(newUrl.substr(qsIndex+1));
newUrl = newUrl.substr(0, qsIndex);
}
// Method has to go on querystring, and nothing else
newUrl = newUrl + '?method=' + method;
// Headers
if(headers !== null){
for(var headerName in headers){
formData.push(
headerName + "=" +
encodeURIComponent(
headers[headerName]));
}
}
// The original data is repackaged as "content" form var
if(data !== null){
formData.push('content=' + encodeURIComponent(data));
}
return {
"method":"POST",
"url":newUrl,
"headers":{},
"data":formData.join("&")
};
}"definition": {
"description": {
"en-US": "Does the xAPI include the concept of statements?"
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "true-false",
"correctResponsesPattern": [
"true"
]
}
"definition": {
"description": {
"en-US": "Which of these prototypes are available at the beta site?"
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "choice",
"correctResponsesPattern": [
"golf[,]tetris"
],
"choices": [
{
"id": "golf",
"description": {
"en-US": "Golf Example"
}
},
{
"id": "facebook",
"description": {
"en-US": "Facebook App"
}
},
{
"id": "tetris",
"description": {
"en-US": "Tetris Example"
}
},
{
"id": "scrabble",
"description": {
"en-US": "Scrabble Example"
}
}
]
}
"definition": {
"description": {
"en-US": "Ben is often heard saying: "
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "fill-in",
"correctResponsesPattern": [
"Bob's your uncle"
]
}
"definition": {
"description": {
"en-US": "How awesome is Experience API?"
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "likert",
"correctResponsesPattern": [
"likert_3"
],
"scale": [
{
"id": "likert_0",
"description": {
"en-US": "It's OK"
}
},
{
"id": "likert_1",
"description": {
"en-US": "It's Pretty Cool"
}
},
{
"id": "likert_2",
"description": {
"en-US": "It's Damn Cool"
}
},
{
"id": "likert_3",
"description": {
"en-US": "It's Gonna Change the World"
}
}
]
}
"definition": {
"description": {
"en-US": "Match these people to their kickball team:"
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "matching",
"correctResponsesPattern": [
"ben[.]3[,]chris[.]2[,]troy[.]4[,]freddie[.]1"
],
"source": [
{
"id": "ben",
"description": {
"en-US": "Ben"
}
},
{
"id": "chris",
"description": {
"en-US": "Chris"
}
},
{
"id": "troy",
"description": {
"en-US": "Troy"
}
},
{
"id": "freddie",
"description": {
"en-US": "Freddie"
}
}
],
"target": [
{
"id": "1",
"description": {
"en-US": "Swift Kick in the Grass"
}
},
{
"id": "2",
"description": {
"en-US": "We got Runs"
}
},
{
"id": "3",
"description": {
"en-US": "Duck"
}
},
{
"id": "4",
"description": {
"en-US": "Van Delay Industries"
}
}
]
}
"definition": {
"description": {
"en-US": "This interaction measures performance over a day of RS sports:"
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "performance",
"correctResponsesPattern": [
"pong[.]1:[,]dg[.]:10[,]lunch[.]"
],
"steps": [
{
"id": "pong",
"description": {
"en-US": "Net pong matches won"
}
},
{
"id": "dg",
"description": {
"en-US": "Strokes over par in disc golf at Liberty"
}
},
{
"id": "lunch",
"description": {
"en-US": "Lunch having been eaten"
}
}
]
}
"definition": {
"description": {
"en-US": "Order players by their pong ladder position:"
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "sequencing",
"correctResponsesPattern": [
"tim[,]mike[,]ells[,]ben"
],
"choices": [
{
"id": "tim",
"description": {
"en-US": "Tim"
}
},
{
"id": "ben", "description": {
"en-US": "Ben"
}
},
{
"id": "ells",
"description": {
"en-US": "Ells"
}
},
{
"id": "mike",
"description": {
"en-US": "Mike"
}
}
]
}
"definition": {
"description": {
"en-US": "How many jokes is Chris the butt of each day?"
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "numeric",
"correctResponsesPattern": [
"4:"
]
}
"definition": {
"description": {
"en-US": "On this map, please mark Franklin, TN"
},
"type": "http://adlnet.gov/expapi/activities/cmi.interaction",
"interactionType": "other",
"correctResponsesPattern": [
"(35.937432,-86.868896)"
]
}
Example of a simple statement (line breaks are for display purposes only):
{
"id":"fd41c918-b88b-4b20-a0a5-a4c32391aaa0",
"actor":{
"objectType": "Agent",
"name":"Project Tin Can API",
"mbox":"mailto:[email protected]"
},
"verb":{
"id":"http://adlnet.gov/expapi/verbs/created",
"display":{
"en-US":"created"
}
},
"object":{
"id":"http://example.adlnet.gov/xapi/example/simplestatement",
"definition":{
"name":{
"en-US":"simple statement"
},
"description":{
"en-US":"A simple Experience API statement. Note that the LRS
does not need to have any prior information about the actor (learner), the
verb, or the activity/object."
}
}
}
}
Typical simple completion with verb "attempted":
{
"actor":{
"objectType": "Agent",
"name":"Example Learner",
"mbox":"mailto:[email protected]"
},
"verb":{
"id":"http://adlnet.gov/expapi/verbs/attempted",
"display":{
"en-US":"attempted"
}
},
"object":{
"id":"http://example.adlnet.gov/xapi/example/simpleCBT",
"definition":{
"name":{
"en-US":"simple CBT course"
},
"description":{
"en-US":"A fictitious example CBT course."
}
}
},
"result":{
"score":{
"scaled":0.95
},
"success":true,
"completion":true
}
}
######Rationale: This is a 1.0.0 specification, and as such implementers should not have to consider prior versions of the specification. However, prior versions did see notable adoption. This data conversion is specified in order to preserve the data tracked using earlier versions, and make it available to new implementers in a consistant manner.
######Details:
######Conversion of statements created based on version 0.9
A 1.0.0 system converting a statement created in 0.9 MUST follow the steps below:
- If the statement has been voided or uses verbs, activity types, or properties not included in the 0.9 specification, do not convert it.
- Prefix "verb" with "http://adlnet.gov/expapi/verbs/".
- Prefix any activity ids which are not full absolute URIs with "tag:adlnet.gov,2013:expapi:0.9:activities:"
- Prefix any extension keys which are not full absolute URIs with "tag:adlnet.gov,2013:expapi:0.9:extensions:"
- Prefix activity types with "http://adlnet.gov/expapi/activities/"
- for each agent (actor):
- Search for inverse functional identifiers in this order: "mbox, mbox_sha1sum, openId, account". Keep the first populated inverse functional identifier found and discard the rest.
- For the above inverse functional identifier, take the first element in the array and use that as the value of that inverse functional identifier property, discarding any remaining elements.
- If the "name" property is present, set it equal to the first element in the "name" array, discard the remaining elements.
- Remove all remaining properties.
- Remove the "voided" property from the statement, if present. Remember, if the value of the voided property is true, then the statement MUST NOT be converted
- Add "version": "1.0.0"
- If an authority was not previously set, set the authority to an agent identified by an account with a homePage set to the home page corresponding to the system performing the conversion and an accountName of "unknown".
- Preserve all other fields without modification, including "stored". Stored should still be updated if the statement is passed to another system.
######Conversion of statements created based on version 0.95
A 1.0.0 system converting a statement created in 0.95 MUST follow the steps below:
- If the statement is voided, do not convert it.
- Remove the "voided" property from the statement, if present. Remember, if the value of the voided property is true, then the statement MUST NOT be converted
- Add "version": "1.0.0"
- If an authority was not previously set, set the authority to an agent identified by an account with a homePage set to the home page corresponding to the system performing the conversion and an accountName of "unknown".
- Preserve all other fields without modification, including "stored". Stored should still be updated if the statement is passed to another system.
######Example:
A 0.9 statement:
{
"id": "d1eec41f-1e93-4ed6-acbf-5c4bd0c24269",
"actor": {
"objectType": "Person",
"name": [
"Joe Schmoe",
"Joseph Schmoseph"
],
"mbox": [
"mailto:[email protected]"
],
"openid": [
"http://openid.com/joe-schmoe"
]
},
"verb": "completed",
"inProgress": false,
"object": {
"objectType": "Activity",
"id": "http://www.example.com/activities/001",
"definition": {
"name": {
"en-US": "Example Activity"
},
"type": "course"
}
},
"result": {
"completion": true
},
"context": {
"instructor": {
"objectType": "Person",
"lastName": [
"Dad"
],
"firstName": [
"Joe's"
],
"mbox": [
"mailto:[email protected]"
]
},
"contextActivities": {
"parent": {
"objectType": "Activity",
"id": "non-absolute-activity-id",
"definition": {
"name": {
"en-US": "Another Activity"
}
}
}
}
},
"timestamp": "2012-06-01T19:09:13.245Z",
"stored": "2012-06-29T15:41:39.165Z"
}
Converted to 1.0.0:
{
"version": "1.0.0",
"id": "d1eec41f-1e93-4ed6-acbf-5c4bd0c24269",
"actor": {
"objectType": "Agent",
"name": "Joe Schmoe",
"mbox": "mailto:[email protected]"
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/completed",
"display": {
"en-US": "completed"
}
},
"object": {
"objectType": "Activity",
"id": "http://www.example.com/activities/001",
"definition": {
"name": {
"en-US": "Example Activity"
},
"type": "http://adlnet.gov/expapi/activities/course"
}
},
"result": {
"completion": true
},
"context": {
"instructor": {
"objectType": "Agent",
"mbox": "mailto:[email protected]"
},
"contextActivities": {
"parent": [
{
"objectType": "Activity",
"id": "tag:adlnet.gov,2013:expapi:0.9:activities:non-absolute-activity-id",
"definition": {
"name": {
"en-US": "Another Activity"
}
}
}
]
}
},
"timestamp": "2012-06-01T19:09:13.245Z",
"stored": "2012-06-29T15:41:39.165Z",
"authority": {
"objectType": "Agent",
"account": {
"homePage": "http://www.example.com",
"name": "unknown"
}
}
}
The original statement serialization to be signed:
{
"version": "1.0.0",
"id": "33cff416-e331-4c9d-969e-5373a1756120",
"actor": {
"mbox": "mailto:[email protected]",
"name": "Example Learner",
"objectType": "Agent"
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/experienced",
"display": {
"en-US": "experienced"
}
},
"object": {
"id": "https://www.youtube.com/watch?v=xh4kIiH3Sm8",
"objectType": "Activity",
"definition": {
"name": {
"en-US": "Tax Tips & Information : How to File a Tax Return "
},
"description": {
"en-US": "Filing a tax return will require filling out either a 1040, 1040A or 1040EZ form"
}
}
},
"timestamp": "2013-04-01T12:00:00Z"
}
Example private key for X.590 certificate that will be used for signing:
-----BEGIN RSA PRIVATE KEY-----
MIICXAIBAAKBgQDjxvZXF30WL4oKjZYXgR0ZyaX+u3y6+JqTqiNkFa/VTnet6Ly2
OT6ZmmcJEPnq3UnewpHoOQ+GfhhTkW13j06j5iNn4obcCVWTL9yXNvJH+Ko+xu4Y
l/ySPRrIPyTjtHdG0M2XzIlmmLqm+CAS+KCbJeH4tf543kIWC5pC5p3cVQIDAQAB
AoGAOejdvGq2XKuddu1kWXl0Aphn4YmdPpPyCNTaxplU6PBYMRjY0aNgLQE6bO2p
/HJiU4Y4PkgzkEgCu0xf/mOq5DnSkX32ICoQS6jChABAe20ErPfm5t8h9YKsTfn9
40lAouuwD9ePRteizd4YvHtiMMwmh5PtUoCbqLefawNApAECQQD1mdBW3zL0okUx
2pc4tttn2qArCG4CsEZMLlGRDd3FwPWJz3ZPNEEgZWXGSpA9F1QTZ6JYXIfejjRo
UuvRMWeBAkEA7WvzDBNcv4N+xeUKvH8ILti/BM58LraTtqJlzjQSovek0srxtmDg
5of+xrxN6IM4p7yvQa+7YOUOukrVXjG+1QJBAI2mBrjzxgm9xTa5odn97JD7UMFA
/WHjlMe/Nx/35V52qaav1sZbluw+TvKMcqApYj5G2SUpSNudHLDGkmd2nQECQFfc
lBRK8g7ZncekbGW3aRLVGVOxClnLLTzwOlamBKOUm8V6XxsMHQ6TE2D+fKJoNUY1
2HGpk+FWwy2D1hRGuoUCQAXfaLSxtaWdPtlZTPVueF7ZikQDsVg+vtTFgpuHloR2
6EVc1RbHHZm32yvGDY8IkcoMfJQqLONDdLfS/05yoNU=
-----END RSA PRIVATE KEY-----
Example public X.509 certificate
-----BEGIN CERTIFICATE-----
MIIDATCCAmqgAwIBAgIJAMB1csNuA6+kMA0GCSqGSIb3DQEBBQUAMHExCzAJBgNV
BAYTAlVTMRIwEAYDVQQIEwlUZW5uZXNzZWUxGDAWBgNVBAoTD0V4YW1wbGUgQ29t
cGFueTEQMA4GA1UEAxMHRXhhbXBsZTEiMCAGCSqGSIb3DQEJARYTZXhhbXBsZUBl
eGFtcGxlLmNvbTAeFw0xMzA0MDQxNTI4MzBaFw0xNDA0MDQxNTI4MzBaMIGWMQsw
CQYDVQQGEwJVUzESMBAGA1UECBMJVGVubmVzc2VlMREwDwYDVQQHEwhGcmFua2xp
bjEYMBYGA1UEChMPRXhhbXBsZSBDb21wYW55MRAwDgYDVQQLEwdFeGFtcGxlMRAw
DgYDVQQDEwdFeGFtcGxlMSIwIAYJKoZIhvcNAQkBFhNleGFtcGxlQGV4YW1wbGUu
Y29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDjxvZXF30WL4oKjZYXgR0Z
yaX+u3y6+JqTqiNkFa/VTnet6Ly2OT6ZmmcJEPnq3UnewpHoOQ+GfhhTkW13j06j
5iNn4obcCVWTL9yXNvJH+Ko+xu4Yl/ySPRrIPyTjtHdG0M2XzIlmmLqm+CAS+KCb
JeH4tf543kIWC5pC5p3cVQIDAQABo3sweTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIB
DQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQUVs3v
5afEdOeoYeVajAQE4v0WS1QwHwYDVR0jBBgwFoAUyVIc3yvra4EBz20I4BF39IAi
xBkwDQYJKoZIhvcNAQEFBQADgYEAgS/FF5D0Hnj44rvT6kgn3kJAvv2lj/fyjztK
IrYS33ljXGn6gGyA4qtbXA23PrO4uc/wYCSDICDpPobh62xTCd9qObKhgwWOi05P
SBLqUu3mwfAe15LJBJBqPVZ4K0kppePBU8m6aIZoH57L/9t4OoaL8yKs/qjKFeI1
OFWZxvA=
-----END CERTIFICATE-----
Example certificate authority certificate
-----BEGIN CERTIFICATE-----
MIIDNzCCAqCgAwIBAgIJAMB1csNuA6+jMA0GCSqGSIb3DQEBBQUAMHExCzAJBgNV
BAYTAlVTMRIwEAYDVQQIEwlUZW5uZXNzZWUxGDAWBgNVBAoTD0V4YW1wbGUgQ29t
cGFueTEQMA4GA1UEAxMHRXhhbXBsZTEiMCAGCSqGSIb3DQEJARYTZXhhbXBsZUBl
eGFtcGxlLmNvbTAeFw0xMzA0MDQxNTI1NTNaFw0yMzA0MDIxNTI1NTNaMHExCzAJ
BgNVBAYTAlVTMRIwEAYDVQQIEwlUZW5uZXNzZWUxGDAWBgNVBAoTD0V4YW1wbGUg
Q29tcGFueTEQMA4GA1UEAxMHRXhhbXBsZTEiMCAGCSqGSIb3DQEJARYTZXhhbXBs
ZUBleGFtcGxlLmNvbTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA1sBnBWPZ
0f7WJUFTJy5+01SlS5Z6DDD6Uye9vK9AycgV5B3+WC8HC5u5h91MujAC1ARPVUOt
svPRs45qKNFIgIGRXKPAwZjawEI2sCJRSKV47i6B8bDv4WkuGvQaveZGI0qlmN5R
1Eim2gUItRj1hgcC9rQavjlnFKDY2rlXGukCAwEAAaOB1jCB0zAdBgNVHQ4EFgQU
yVIc3yvra4EBz20I4BF39IAixBkwgaMGA1UdIwSBmzCBmIAUyVIc3yvra4EBz20I
4BF39IAixBmhdaRzMHExCzAJBgNVBAYTAlVTMRIwEAYDVQQIEwlUZW5uZXNzZWUx
GDAWBgNVBAoTD0V4YW1wbGUgQ29tcGFueTEQMA4GA1UEAxMHRXhhbXBsZTEiMCAG
CSqGSIb3DQEJARYTZXhhbXBsZUBleGFtcGxlLmNvbYIJAMB1csNuA6+jMAwGA1Ud
EwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEADhwTebGk735yKhm8DqCxvNnEZ0Nx
sYEYOjgRG1yXTlW5pE691fSH5AZ+T6fpwpZcWY5QYkoN6DnwjOxGkSfQC3/yGmcU
DKBPwiZ5O2s9C+fE1kUEnrX2Xea4agVngMzR8DQ6oOauLWqehDB+g2ENWRLoVgS+
ma5/Ycs0GTyrECY=
-----END CERTIFICATE-----
JWS Header. Note that along with specifying the algorithm, the certificate chain for the signing certificate has been included.
{
"alg": "RS256",
"x5c": [
"MIIDATCCAmqgAwIBAgIJAMB1csNuA6+kMA0GCSqGSIb3DQEBBQUAMHExCzAJBgNVBAYTAlVTMRIwEAYDVQQIEwlUZW5uZXNzZWUxGDAWBgNVBAoTD0V4YW1wbGUgQ29tcGFueTEQMA4GA1UEAxMHRXhhbXBsZTEiMCAGCSqGSIb3DQEJARYTZXhhbXBsZUBleGFtcGxlLmNvbTAeFw0xMzA0MDQxNTI4MzBaFw0xNDA0MDQxNTI4MzBaMIGWMQswCQYDVQQGEwJVUzESMBAGA1UECBMJVGVubmVzc2VlMREwDwYDVQQHEwhGcmFua2xpbjEYMBYGA1UEChMPRXhhbXBsZSBDb21wYW55MRAwDgYDVQQLEwdFeGFtcGxlMRAwDgYDVQQDEwdFeGFtcGxlMSIwIAYJKoZIhvcNAQkBFhNleGFtcGxlQGV4YW1wbGUuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDjxvZXF30WL4oKjZYXgR0ZyaX+u3y6+JqTqiNkFa/VTnet6Ly2OT6ZmmcJEPnq3UnewpHoOQ+GfhhTkW13j06j5iNn4obcCVWTL9yXNvJH+Ko+xu4Yl/ySPRrIPyTjtHdG0M2XzIlmmLqm+CAS+KCbJeH4tf543kIWC5pC5p3cVQIDAQABo3sweTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQUVs3v5afEdOeoYeVajAQE4v0WS1QwHwYDVR0jBBgwFoAUyVIc3yvra4EBz20I4BF39IAixBkwDQYJKoZIhvcNAQEFBQADgYEAgS/FF5D0Hnj44rvT6kgn3kJAvv2lj/fyjztKIrYS33ljXGn6gGyA4qtbXA23PrO4uc/wYCSDICDpPobh62xTCd9qObKhgwWOi05PSBLqUu3mwfAe15LJBJBqPVZ4K0kppePBU8m6aIZoH57L/9t4OoaL8yKs/qjKFeI1OFWZxvA=",
"MIIDNzCCAqCgAwIBAgIJAMB1csNuA6+jMA0GCSqGSIb3DQEBBQUAMHExCzAJBgNVBAYTAlVTMRIwEAYDVQQIEwlUZW5uZXNzZWUxGDAWBgNVBAoTD0V4YW1wbGUgQ29tcGFueTEQMA4GA1UEAxMHRXhhbXBsZTEiMCAGCSqGSIb3DQEJARYTZXhhbXBsZUBleGFtcGxlLmNvbTAeFw0xMzA0MDQxNTI1NTNaFw0yMzA0MDIxNTI1NTNaMHExCzAJBgNVBAYTAlVTMRIwEAYDVQQIEwlUZW5uZXNzZWUxGDAWBgNVBAoTD0V4YW1wbGUgQ29tcGFueTEQMA4GA1UEAxMHRXhhbXBsZTEiMCAGCSqGSIb3DQEJARYTZXhhbXBsZUBleGFtcGxlLmNvbTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA1sBnBWPZ0f7WJUFTJy5+01SlS5Z6DDD6Uye9vK9AycgV5B3+WC8HC5u5h91MujAC1ARPVUOtsvPRs45qKNFIgIGRXKPAwZjawEI2sCJRSKV47i6B8bDv4WkuGvQaveZGI0qlmN5R1Eim2gUItRj1hgcC9rQavjlnFKDY2rlXGukCAwEAAaOB1jCB0zAdBgNVHQ4EFgQUyVIc3yvra4EBz20I4BF39IAixBkwgaMGA1UdIwSBmzCBmIAUyVIc3yvra4EBz20I4BF39IAixBmhdaRzMHExCzAJBgNVBAYTAlVTMRIwEAYDVQQIEwlUZW5uZXNzZWUxGDAWBgNVBAoTD0V4YW1wbGUgQ29tcGFueTEQMA4GA1UEAxMHRXhhbXBsZTEiMCAGCSqGSIb3DQEJARYTZXhhbXBsZUBleGFtcGxlLmNvbYIJAMB1csNuA6+jMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEADhwTebGk735yKhm8DqCxvNnEZ0NxsYEYOjgRG1yXTlW5pE691fSH5AZ+T6fpwpZcWY5QYkoN6DnwjOxGkSfQC3/yGmcUDKBPwiZ5O2s9C+fE1kUEnrX2Xea4agVngMzR8DQ6oOauLWqehDB+g2ENWRLoVgS+ma5/Ycs0GTyrECY="
]
}
JWS signature
ew0KICAgICJhbGciOiAiUlMyNTYiLA0KICAgICJ4NWMiOiBbDQogICAgICAgICJNSUlEQVRDQ0FtcWdBd0lCQWdJSkFNQjFjc051QTYra01BMEdDU3FHU0liM0RRRUJCUVVBTUhFeEN6QUpCZ05WQkFZVEFsVlRNUkl3RUFZRFZRUUlFd2xVWlc1dVpYTnpaV1V4R0RBV0JnTlZCQW9URDBWNFlXMXdiR1VnUTI5dGNHRnVlVEVRTUE0R0ExVUVBeE1IUlhoaGJYQnNaVEVpTUNBR0NTcUdTSWIzRFFFSkFSWVRaWGhoYlhCc1pVQmxlR0Z0Y0d4bExtTnZiVEFlRncweE16QTBNRFF4TlRJNE16QmFGdzB4TkRBME1EUXhOVEk0TXpCYU1JR1dNUXN3Q1FZRFZRUUdFd0pWVXpFU01CQUdBMVVFQ0JNSlZHVnVibVZ6YzJWbE1SRXdEd1lEVlFRSEV3aEdjbUZ1YTJ4cGJqRVlNQllHQTFVRUNoTVBSWGhoYlhCc1pTQkRiMjF3WVc1NU1SQXdEZ1lEVlFRTEV3ZEZlR0Z0Y0d4bE1SQXdEZ1lEVlFRREV3ZEZlR0Z0Y0d4bE1TSXdJQVlKS29aSWh2Y05BUWtCRmhObGVHRnRjR3hsUUdWNFlXMXdiR1V1WTI5dE1JR2ZNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0R05BRENCaVFLQmdRRGp4dlpYRjMwV0w0b0tqWllYZ1IwWnlhWCt1M3k2K0pxVHFpTmtGYS9WVG5ldDZMeTJPVDZabW1jSkVQbnEzVW5ld3BIb09RK0dmaGhUa1cxM2owNmo1aU5uNG9iY0NWV1RMOXlYTnZKSCtLbyt4dTRZbC95U1BScklQeVRqdEhkRzBNMlh6SWxtbUxxbStDQVMrS0NiSmVINHRmNTQza0lXQzVwQzVwM2NWUUlEQVFBQm8zc3dlVEFKQmdOVkhSTUVBakFBTUN3R0NXQ0dTQUdHK0VJQkRRUWZGaDFQY0dWdVUxTk1JRWRsYm1WeVlYUmxaQ0JEWlhKMGFXWnBZMkYwWlRBZEJnTlZIUTRFRmdRVVZzM3Y1YWZFZE9lb1llVmFqQVFFNHYwV1MxUXdId1lEVlIwakJCZ3dGb0FVeVZJYzN5dnJhNEVCejIwSTRCRjM5SUFpeEJrd0RRWUpLb1pJaHZjTkFRRUZCUUFEZ1lFQWdTL0ZGNUQwSG5qNDRydlQ2a2duM2tKQXZ2MmxqL2Z5anp0S0lyWVMzM2xqWEduNmdHeUE0cXRiWEEyM1ByTzR1Yy93WUNTRElDRHBQb2JoNjJ4VENkOXFPYktoZ3dXT2kwNVBTQkxxVXUzbXdmQWUxNUxKQkpCcVBWWjRLMGtwcGVQQlU4bTZhSVpvSDU3TC85dDRPb2FMOHlLcy9xaktGZUkxT0ZXWnh2QT0iLA0KICAgICAgICAiTUlJRE56Q0NBcUNnQXdJQkFnSUpBTUIxY3NOdUE2K2pNQTBHQ1NxR1NJYjNEUUVCQlFVQU1IRXhDekFKQmdOVkJBWVRBbFZUTVJJd0VBWURWUVFJRXdsVVpXNXVaWE56WldVeEdEQVdCZ05WQkFvVEQwVjRZVzF3YkdVZ1EyOXRjR0Z1ZVRFUU1BNEdBMVVFQXhNSFJYaGhiWEJzWlRFaU1DQUdDU3FHU0liM0RRRUpBUllUWlhoaGJYQnNaVUJsZUdGdGNHeGxMbU52YlRBZUZ3MHhNekEwTURReE5USTFOVE5hRncweU16QTBNREl4TlRJMU5UTmFNSEV4Q3pBSkJnTlZCQVlUQWxWVE1SSXdFQVlEVlFRSUV3bFVaVzV1WlhOelpXVXhHREFXQmdOVkJBb1REMFY0WVcxd2JHVWdRMjl0Y0dGdWVURVFNQTRHQTFVRUF4TUhSWGhoYlhCc1pURWlNQ0FHQ1NxR1NJYjNEUUVKQVJZVFpYaGhiWEJzWlVCbGVHRnRjR3hsTG1OdmJUQ0JuekFOQmdrcWhraUc5dzBCQVFFRkFBT0JqUUF3Z1lrQ2dZRUExc0JuQldQWjBmN1dKVUZUSnk1KzAxU2xTNVo2RERENlV5ZTl2SzlBeWNnVjVCMytXQzhIQzV1NWg5MU11akFDMUFSUFZVT3RzdlBSczQ1cUtORklnSUdSWEtQQXdaamF3RUkyc0NKUlNLVjQ3aTZCOGJEdjRXa3VHdlFhdmVaR0kwcWxtTjVSMUVpbTJnVUl0UmoxaGdjQzlyUWF2amxuRktEWTJybFhHdWtDQXdFQUFhT0IxakNCMHpBZEJnTlZIUTRFRmdRVXlWSWMzeXZyYTRFQnoyMEk0QkYzOUlBaXhCa3dnYU1HQTFVZEl3U0JtekNCbUlBVXlWSWMzeXZyYTRFQnoyMEk0QkYzOUlBaXhCbWhkYVJ6TUhFeEN6QUpCZ05WQkFZVEFsVlRNUkl3RUFZRFZRUUlFd2xVWlc1dVpYTnpaV1V4R0RBV0JnTlZCQW9URDBWNFlXMXdiR1VnUTI5dGNHRnVlVEVRTUE0R0ExVUVBeE1IUlhoaGJYQnNaVEVpTUNBR0NTcUdTSWIzRFFFSkFSWVRaWGhoYlhCc1pVQmxlR0Z0Y0d4bExtTnZiWUlKQU1CMWNzTnVBNitqTUF3R0ExVWRFd1FGTUFNQkFmOHdEUVlKS29aSWh2Y05BUUVGQlFBRGdZRUFEaHdUZWJHazczNXlLaG04RHFDeHZObkVaME54c1lFWU9qZ1JHMXlYVGxXNXBFNjkxZlNINUFaK1Q2ZnB3cFpjV1k1UVlrb042RG53ak94R2tTZlFDMy95R21jVURLQlB3aVo1TzJzOUMrZkUxa1VFbnJYMlhlYTRhZ1ZuZ016UjhEUTZvT2F1TFdxZWhEQitnMkVOV1JMb1ZnUyttYTUvWWNzMEdUeXJFQ1k9Ig0KICAgIF0NCn0.ew0KICAgICJ2ZXJzaW9uIjogIjEuMCIsDQogICAgImlkIjogIjMzY2ZmNDE2LWUzMzEtNGM5ZC05NjllLTUzNzNhMTc1NjEyMCIsDQogICAgImFjdG9yIjogew0KICAgICAgICAibWJveCI6ICJtYWlsdG86ZXhhbXBsZUBleGFtcGxlLmNvbSIsDQogICAgICAgICJuYW1lIjogIkV4YW1wbGUgTGVhcm5lciIsDQogICAgICAgICJvYmplY3RUeXBlIjogIkFnZW50Ig0KICAgIH0sDQogICAgInZlcmIiOiB7DQogICAgICAgICJpZCI6ICJodHRwOi8vYWRsbmV0Lmdvdi9leHBhcGkvdmVyYnMvZXhwZXJpZW5jZWQiLA0KICAgICAgICAiZGlzcGxheSI6IHsNCiAgICAgICAgICAgICJlbi1VUyI6ICJleHBlcmllbmNlZCINCiAgICAgICAgfQ0KICAgIH0sDQogICAgIm9iamVjdCI6IHsNCiAgICAgICAgImlkIjogImh0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9eGg0a0lpSDNTbTgiLA0KICAgICAgICAib2JqZWN0VHlwZSI6ICJBY3Rpdml0eSIsDQogICAgICAgICJkZWZpbml0aW9uIjogew0KICAgICAgICAgICAgIm5hbWUiOiB7DQogICAgICAgICAgICAgICAgImVuLVVTIjogIlRheCBUaXBzICYgSW5mb3JtYXRpb24gOiBIb3cgdG8gRmlsZSBhIFRheCBSZXR1cm4gIg0KICAgICAgICAgICAgfSwNCiAgICAgICAgICAgICJkZXNjcmlwdGlvbiI6IHsNCiAgICAgICAgICAgICAgICAiZW4tVVMiOiAiRmlsaW5nIGEgdGF4IHJldHVybiB3aWxsIHJlcXVpcmUgZmlsbGluZyBvdXQgZWl0aGVyIGEgMTA0MCwgMTA0MEEgb3IgMTA0MEVaIGZvcm0iDQogICAgICAgICAgICB9DQogICAgICAgIH0NCiAgICB9LA0KICAgICJ0aW1lc3RhbXAiOiAiMjAxMy0wNC0wMVQxMjowMDowMFoiDQp9.gT42g4MGqXz2VpcY18-lUrLrG2-v9Y808TJOSRuda3XlcWXpHVekvdgINaHe2BzCWceoPAxgCQ87ItHBvkv37jvYPcB8H9x5eOoIgDrv4iojU_m7xkhSqEPxvbGF3HqqW1ElNPT1GChj-5b9OGeoXY-O4mbXtaNiViy0bi5Bp6A
Signed Statement
{
"version": "1.0.0",
"id": "33cff416-e331-4c9d-969e-5373a1756120",
"actor": {
"mbox": "mailto:[email protected]",
"name": "Example Learner",
"objectType": "Agent"
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/experienced",
"display": {
"en-US": "experienced"
}
},
"object": {
"id": "https://www.youtube.com/watch?v=xh4kIiH3Sm8",
"objectType": "Activity",
"definition": {
"name": {
"en-US": "Tax Tips & Information : How to File a Tax Return "
},
"description": {
"en-US": "Filing a tax return will require filling out either a 1040, 1040A or 1040EZ form"
}
}
},
"timestamp": "2013-04-01T12:00:00Z",
"attachments": [
{
"usageType": "http://adlnet.gov/expapi/attachments/signature",
"display": { "en-US": "Signature" },
"description": { "en-US": "A test signature" },
"contentType": "application/octet-stream",
"length": 4235,
"sha2": "dc9589e454ff375dd5dfd6f556d2583e231e8cafe55ef40102ddd988b79f86f0"
}
]
}
Note: Attached signature not shown, see attachments for attachment message format.