Skip to content

api-evangelist/scorm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SCORM

SCORM (Sharable Content Object Reference Model) is a set of technical standards for e-learning software products. Originally developed by the Advanced Distributed Learning (ADL) Initiative under the U.S. Department of Defense, SCORM defines how online learning content and Learning Management Systems (LMS) communicate, enabling interoperability between authoring tools, content packages, and LMS platforms. Key versions include SCORM 1.2 and SCORM 2004, with xAPI (Tin Can) as the modern successor.

Specification Site: https://scorm.com/ ADL Initiative: https://adlnet.gov/projects/scorm/ APIs.yml: https://raw.githubusercontent.com/api-evangelist/scorm/refs/heads/main/apis.yml

Scope

  • Type: Standard
  • Position: Consumer
  • Access: 3rd-Party

Tags

  • E-Learning
  • LMS
  • Standards
  • Education
  • Interoperability

Specifications

Specification API Object Description
SCORM 1.2 API JavaScript API with 6 lesson status values (passed, failed, completed, incomplete, browsed, not attempted) and CMI data model
SCORM 2004 API_1484_11 Extended API with separate completion and success status, scaled scores, and IMS Simple Sequencing
xAPI / Tin Can LRS Modern successor using a Learning Record Store (LRS) and statement-based tracking (subject-verb-object)

SCORM API Functions

SCORM 1.2 Functions

Function Description
LMSInitialize("") Initialize the SCORM session
LMSGetValue(element) Read a CMI data model value
LMSSetValue(element, value) Write a CMI data model value
LMSCommit("") Persist data to the LMS
LMSFinish("") End the SCORM session
LMSGetLastError() Get the last error code
LMSGetErrorString(code) Get a human-readable error message
LMSGetDiagnostic(code) Get diagnostic detail for an error

SCORM 2004 Functions (equivalent)

Function Description
Initialize("") Initialize the session
GetValue(element) Read a CMI data model value
SetValue(element, value) Write a CMI data model value
Commit("") Persist data
Terminate("") End the session
GetLastError() Get last error code
GetErrorString(code) Get error message
GetDiagnostic(code) Get error diagnostic

Artifacts

JSON Schema

File Description
json-schema/scorm-cmi-data-schema.json SCORM CMI data model schema covering SCORM 1.2 and SCORM 2004 fields

JSON Structure

File Description
json-structure/scorm-package-structure.json SCORM Package Interchange Format (PIF) structure and manifest

JSON-LD

File Description
json-ld/scorm-context.jsonld JSON-LD context for SCORM vocabulary

Examples

File Description
examples/scorm-api-initialize-example.json SCORM 1.2 API initialization and data exchange sequence

Vocabulary

File Description
vocabulary/scorm-vocabulary.yml SCORM normative vocabulary and e-learning taxonomy

Links

Maintainers

FN: Kin Lane Email: kin@apievangelist.com

About

SCORM - Sharable Content Object Reference Model

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors