Color Key
Read Only
From LMS
Read Only
From Manifest via LMS
Calculated Value
The SCO calculates this
metadata
Metadata specifying permissions,
data type, range, and valid values.
Relationship
Subtopic 1
API 1484_11 Signatures
Topic
boolean "" Initialize("") true
Topic
boolean Terminate("") "" true
Topic
characterstring GetValue(element: CMIElement) "cmi.progress_measure" "0.70"
Topic
boolean SetValue(element: CMIElement, value: string) "cmi.progress_measure", "0.8" true
Topic
boolean Commit("") "" true
Topic
CMIErrorCode GetLastError() Topic "351"
Topic
characterstring SPM: 250 GetErrorString(errorCode: CMIErrorCode) "351" "Unique Identifier Constraint Violated"
Topic
characterstring SPM: 250 GetDiagnostic(errorCode: CMIErrorCode) "0" “The data model element’s value is already in use and is not unique”
Data types
Topic
characterstring thas lists a complete identification of a data model element CMIElement
Topic
characterstring representing the error code of the last error encountered.
(convertible to an integer in the range from 0 to 65536 inclusive) CMIErrorcode
Topic
characterstring that has a maximum length of 255 characters
textual message containing a description of the error code CMIErrorString
Topic
characterstring A string of characters as defined in ISO 10646.
Topic
a characterstring prefixed with the language indicator
of the language the string is written in
default is english {lang=en} localized_string_type
Topic
ISO time
Topic
boolean non-negative integer
Topic
base 10 number, with a precision of 7 decimal places real(10,7)
Topic
CMIErrorCode long_identifier_type
Topic
ISO 3609 time string timeinterval
Topic
A data type used to represent a language
2-letter codes are defined by ISO 639-1 [14]
• 3-letter codes are defined by ISO 639-2 [15]
• The value “i” is reserved and used as a prefix for registrations defined by Internet Assigned Numbers Authority (IANA)
• The value “x” is reserved and used as a prefix for private use
and the subcode:
• 2-letter subcodes are ISO 3166-1 alpha-2 country codes[16]
• subcodes of from 3 to 8 letters are registered with IANA
language_type
Topic
Subtopic 1 request
Topic
Smallest Permitted Maximum - The minimum amount of space that an LMS most provide.
In the case of characterstrings this is the length of the string
In the case of arrays this is the number of elements in the array SPM 4000
Error Code Ranges and Categories
Topic
No error 0
Topic
General Errors 100-199
Topic
Syntax Errors 200-299
Topic
RTS Errors 300-399
Topic
Data Model Errors 400-499
Topic
Implementation defined errors 1000-65535
Reserver Property Delimiters
Topic
{lang=en} {lang=<language type>} {lang=en}
{lang=fr}
{lang=en-US}
{lang=en-CA}
{lang=fr-CA} Subtopic 4
Topic
{case_matters=<boolean>} {case_matters=true}
{case_matters=true}
{case_matters=false}
Topic
{order_matters=<boolean>} {order_matters=true} {order_matters=true}
{order_matters=false} Subtopic 4
Topic
[.] na - needs to be provided 1[.]a Separates a pair of values that are related for an interaction
Topic
[,] na - needs to be provided Separates a pair of values that are related for an interaction 1[.]a[,]2[.]c[,]3[.]b
Topic
[:] na - needs to be provided Used to provide a separator for a range of inclusive numeric values 1[:]100
Response Types
Topic
yes/no or true/false questions "true"
"false" True / False true-false
Topic
{case_matters=<boolean>} multiple choice questions
(the user can select one or more choices) "{lang=en}auto"
"car"
"car[,]automobile" Multiple Choice choice
Topic
{order_matters=<boolean>}
{case_matters=<boolean>}
{lang=en} fill in the blank {order_matters=true}
{order_matters=false} Fill In fill-in
Topic
{lang=en} essay questions “{lang=en}Four score and seven years ago…”
“Four score and seven years ago…” Long Fill In long-fill-in
Topic
[,] drag and drop Matching 1[.]a[,]2[.]c[,]3[.]b matching
Topic
[.] simulations where the user must identify
steps to perform an activity Performance ”step_1[.]inspect wound[,]step_2[.]clean wound[,]step_3[.]apply bandage” performance
Topic
Like RT surveys "strongly_disagree"
"agree" likert
Topic
Numeric numeric fill in the blanks or where the user
responds only with numbers "10.5" numeric [:]
Topic
Sequencing The user puts items in order "a[,]b[,]c" sequencing
Topic
Other anything else... other
cmi
_version
Read Only type: characterstring values: "1.0"
comments_from_learner
_children
Read Only values: comment, location, timestamp
_count
Read Only type: non-negative integer
n []
comment
Read / Write type: localized_string_type (SPM: 4000) format:
location
Read / Write type: characterstring [SPM: 250] format: (controlled by the SCO) value space: ISO 10646-1
timestamp
Read / Write type: time [second(10, 0)] format: second(10, 0)
SPM 250
comments_from_lms
_children
Read Only values: comment, location, timestamp
_count
Read Only type: non-negative integer
n []
comment
Read Only type: localized_string_type [SPM: 4000] value space: ISO 10646-1
location
Read Only type: characterstring [SPM: 250] value space: ISO 10646-1
timestamp
Read Only type: time [second(10, 0)] format: second(10, 0)
SPM 100
completion_status
Read / Write type: state values: complete, incomplete, not attempted, unknown
completion_threshold
Read Only format: real(10,7) range: 0...1 value space: 0.0 <= cmi.completion_threshold <= 1.0
credit
Read Only type: state values: credit, no_credit
entry
Read Only type: state values: ab_initio, resume, ""
exit
Write Only type: state values: timeout, suspend, logout, normal, ""
interactions
_children
Read Only values: id, type, objectives, timestamp, correct_responses, weighting, learner_response, result, latency, description
_count
Read Only type: non-negative integer
n []
id
Read / Write type: long_identifier_type format: SPM: 4000
type
Read / Write type: state values: true-false, choice, fill-in, long-fill-in, matching, performance, sequencing, likert, numeric, other
objectives
_count Read Only type: non-negative integer n [] id Read / Write type: long_identifier_type format: SPM: 4000
timestamp
Read / Write type: time format: second(10, 0)
correct_responses
_count Read Only type: non-negative integer n[] pattern Read / Write format: depends on interaction type
weighting
Read / Write format: real(10,7)
learner_response
Read / Write value: format depends on interaction type
result
Read / Write type: state values: correct, incorrect, unanticipated, neutral, real(10,7)
latency
Read / Write type: timeinterval format: second(10, 2)
description
Read / Write type: localized_string_type format: SPM: 250
launch_data
Read Only type: characterstring limits: SPM: 4000
learner_id
Read Only type: long_identifier_type limits: SPM: 4000
learner_name
Read Only type: localized_string_type limits: SPM: 250
learner_preference
_children
Read Only values: audio_level, language, delivery_speed, audio_captioning
audio_level
Read / Write type: real(10,7) range: 0...*
language
Read / Write type: language_type limits: SPM: 250
delivery_speed
Read / Write type: real(10,7) range: 0...*
audio_captioning
Read / Write type: state values: -1, 0, 1
location
Read / Write type: characterstring limits: SPM: 1000
max_time_allowed
Read Only type: timeinterval (second(10, 2))
mode
Read Only type: state values: browse, normal, review
objectives
_children
Read Only values: id, score, success_status, completion_status, description
_count
Read Only type: non-negative integer
n []
id
Read / Write type: long_identifier_type format: SPM: 4000
score
_children Read Only values: scaled, raw, min, max scaled Read / Write format: real(10,7) range: -1 ... 1 raw Read / Write format: real(10,7) min Read / Write format: real(10,7) max Read / Write format: real(10,7)
success_status
Read / Write type: state values: passed, failed, unknown
completion_status
Read / Write type: state values: complete, incomplete, not attempted, unknown
progress_measure
Read / Write format: real(10,7) range: 0 ... 1
description
Read / Write type: localized_string_type format: SPM: 250
progress_measure
Read / Write format: real(10,7) range: 0 ... 1
scaled_passing_score
Read / Write format: real(10,7) range: -1 ... 1
score
_children
Read Only values: scaled, raw, min, max
scaled
Read / Write format: : real(10,7) range: -1 ... 1
raw
Read / Write format: real(10,7)
min
Read / Write format: real(10,7)
max
Read / Write format: real(10,7)
session_time
Write Only type: timeinterval format: second(10, 2)
success_status
Read / Write type: state values: passed, failed, unknown
suspend_data
Read / Write type: characterstring format: SPM: 64000
time_limit_action
Read / Write type: state values: exit,message, continue,message, exit,no message, continue,no message
total_time
Read / Write type: timeinterval format: second(10, 2)
adl
nav
request
Read \ Write type: request values: continue, previous, choice, exit, exitAll, abandon, abandonAll, _none_
request_valid
continue
Read Only type: state values: true, false, unknown
previous
Read Only type: state values: true, false, unknown
choice
Read Only type: state values: true, false, unknown
peg
learner_preference
locale
Read / Write type: characterstring format: SPM: 4000 standard: rfc-5646
learner_level
Read / Write type: characterstring format: SPM: 4000 standard: open
tracker
items
_children
_count
Read Only type: non-negative integer
n []
id* Read / Write type: long_identifier_type format: SPM: 4000 url* Read / Write type: characterstring format: SPM: 4000 category* Read / Write type: characterstring format: SPM: 4000 title Read / Write type: characterstring format: SPM: 4000 description Read / Write type: characterstring format: SPM: 4000 subcategory Read / Write type: characterstring format: SPM: 4000 height Read / Write type: characterstring format: SPM: 4000 width Read / Write type: characterstring format: SPM: 4000 thumbnailurl Read / Write type: characterstring format: SPM: 4000