Run-Time Reference

| 26 Jan 2009 | Permalink


API Signature

LMSInitialize( “” ) : boolBegins a communication session with the LMS.
LMSFinish( “” ) : boolEnds a communication session with the LMS.
LMSGetValue( element : CMIElement ) : stringRetrieves a value from the LMS.
LMSSetValue( element : CMIElement, value : string) : stringSaves a value to the LMS.
LMSCommit( “” ) : boolIndicates to the LMS that all data should be persisted (not required).
LMSGetLastError() : CMIErrorCodeReturns the error code that resulted from the last API call.
LMSGetErrorString( errorCode : CMIErrorCode ) : stringReturns a short string describing the specified error code.
LMSGetDiagnostic( errorCode : CMIErrorCode ) : stringReturns detailed information about the last error that occurred.
Initialize( “” ) : boolBegins a communication session with the LMS.
Terminate( “” ) : boolEnds a communication session with the LMS.
GetValue( element : CMIElement ) : stringRetrieves a value from the LMS.
SetValue( element : CMIElement, value : string) : stringSaves a value to the LMS.
Commit( “” ) : boolIndicates to the LMS that all data should be persisted (not required).
GetLastError() : CMIErrorCodeReturns the error code that resulted from the last API call.
GetErrorString( errorCode : CMIErrorCode ) : stringReturns a short string describing the specified error code.
GetDiagnostic( errorCode : CMIErrorCode ) : stringReturns detailed information about the last error that occurred.

Data Model

cmi._version (characterstring, RO) Represents the version of the data model
cmi.comments_from_learner._children (comment,location,timestamp, RO) Listing of supported data model elements
cmi.comments_from_learner._count (non-negative integer, RO) Current number of learner comments
cmi.comments_from_learner.n.comment (localized_string_type (SPM: 4000), RW) Textual input
cmi.comments_from_learner.n.location (characterstring (SPM: 250), RW) Point in the SCO to which the comment applies
cmi.comments_from_learner.n.timestamp (time (second,10,0), RW) Point in time at which the comment was created or most recently changed
cmi.comments_from_lms._children (comment,location,timestamp, RO) Listing of supported data model elements
cmi.comments_from_lms._count (non-negative integer, RO) Current number of comments from the LMS
cmi.comments_from_lms.n.comment (localized_string_type (SPM: 4000), RO) Comments or annotations associated with a SCO
cmi.comments_from_lms.n.location (characterstring (SPM: 250), RO) Point in the SCO to which the comment applies
cmi.comments_from_lms.n.timestamp (time(second,10,0), RO) Point in time at which the comment was created or most recently changed
cmi.completion_status (“completed”, “incomplete”, “not attempted”, “unknown”, RW) Indicates whether the learner has completed the SCO
cmi.completion_threshold (real(10,7) range (0..1), RO) Used to determine whether the SCO should be considered complete
cmi.credit (“credit”, “no-credit”, RO) Indicates whether the learner will be credited for performance in the SCO
cmi.entry (ab_initio, resume, “”, RO) Asserts whether the learner has previously accessed the SCO
cmi.exit (timeout, suspend, logout, normal, “”, WO) Indicates how or why the learner left the SCO
cmi.interactions._children (id,type,objectives,timestamp,correct_responses,weighting,learner_response,result,latency,description, RO) Listing of supported data model elements
cmi.interactions._count (non-negative integer, RO) Current number of interactions being stored by the LMS
cmi.interactions.n.id (long_identifier_type (SPM: 4000), RW) Unique label for the interaction
cmi.interactions.n.type (“true-false”, “choice”, “fill-in”, “long-fill-in”, “matching”, “performance”, “sequencing”, “likert”, “numeric” or “other”, RW) Which type of interaction is recorded
cmi.interactions.n.objectives._count (non-negative integer, RO) Current number of objectives (i.e., objective identifiers) being stored by the LMS for this interaction
cmi.interactions.n.objectives.n.id (long_identifier_type (SPM: 4000), RW) Label for objectives associated with the interaction
cmi.interactions.n.timestamp (time(second,10,0), RW) Point in time at which the interaction was first made available to the learner for learner interaction and response
cmi.interactions.n.correct_responses._count (non-negative integer, RO) Current number of correct responses being stored by the LMS for this interaction
cmi.interactions.n.correct_responses.n.pattern (format depends on interaction type, RW) One correct response pattern for the interaction
cmi.interactions.n.weighting (real (10,7), RW) Weight given to the interaction relative to other interactions
cmi.interactions.n.learner_response (format depends on interaction type, RW) Data generated when a learner responds to an interaction
cmi.interactions.n.result (“correct”, “incorrect”, “unanticipated”, “neutral”) or a real number with values that is accurate to seven significant decimal figures real. , RW) Judgment of the correctness of the learner response
cmi.interactions.n.latency (timeinterval (second,10,2), RW) Time elapsed between the time the interaction was made available to the learner for response and the time of the first response
cmi.interactions.n.description (localized_string_type (SPM: 250), RW) Brief informative description of the interaction
cmi.launch_data (characterstring (SPM: 4000), RO) Data provided to a SCO after launch, initialized from the dataFromLMS manifest element
cmi.learner_id (long_identifier_type (SPM: 4000), RO) Identifies the learner on behalf of whom the SCO was launched
cmi.learner_name (localized_string_type (SPM: 250), RO) Name provided for the learner by the LMS
cmi.learner_preference._children (audio_level,language,delivery_speed,audio_captioning, RO) Listing of supported data model elements
cmi.learner_preference.audio_level (real(10,7), range (0..*), RW) Specifies an intended change in perceived audio level
cmi.learner_preference.language (language_type (SPM 250), RW) The learner’s preferred language for SCOs with multilingual capability
cmi.learner_preference.delivery_speed (real(10,7), range (0..*), RW) The learner’s preferred relative speed of content delivery
cmi.learner_preference.audio_captioning (“-1″, “0″, “1″, RW) Specifies whether captioning text corresponding to audio is displayed
cmi.location (characterstring (SPM: 1000), RW) The learner’s current location in the SCO
cmi.max_time_allowed (timeinterval (second,10,2), RO) Amount of accumulated time the learner is allowed to use a SCO
cmi.mode (“browse”, “normal”, “review”, RO) Identifies one of three possible modes in which the SCO may be presented to the learner
cmi.objectives._children (id,score,success_status,completion_status,description, RO) Listing of supported data model elements
cmi.objectives._count (non-negative integer, RO) Current number of objectives being stored by the LMS
cmi.objectives.n.id (long_identifier_type (SPM: 4000), RW) Unique label for the objective
cmi.objectives.n.score._children (scaled,raw,min,max, RO) Listing of supported data model elements
cmi.objectives.n.score.scaled (real (10,7) range (-1..1), RW) Number that reflects the performance of the learner for the objective
cmi.objectives.n.score.raw (real (10,7), RW) Number that reflects the performance of the learner, for the objective, relative to the range bounded by the values of min and max
cmi.objectives.n.score.min (real (10,7), RW) Minimum value, for the objective, in the range for the raw score
cmi.objectives.n.score.max (real (10,7), RW) Maximum value, for the objective, in the range for the raw score
cmi.objectives.n.success_status (“passed”, “failed”, “unknown”, RW) Indicates whether the learner has mastered the objective
cmi.objectives.n.completion_status (“completed”, “incomplete”, “not attempted”, “unknown”, RW) Indicates whether the learner has completed the associated objective
cmi.objectives.n.progress_measure (real (10,7) range (0..1), RW) Measure of the progress the learner has made toward completing the objective
cmi.objectives.n.description (localized_string_type (SPM: 250), RW) Provides a brief informative description of the objective
cmi.progress_measure (real (10,7) range (0..1), RW) Measure of the progress the learner has made toward completing the SCO
cmi.scaled_passing_score (real(10,7) range (-1 .. 1), RO) Scaled passing score required to master the SCO
cmi.score._children (scaled,raw,min,max, RO) Listing of supported data model elements
cmi.score.scaled (real (10,7) range (-1..1), RW) Number that reflects the performance of the learner
cmi.score.raw (real (10,7), RW) Number that reflects the performance of the learner relative to the range bounded by the values of min and max
cmi.score.min (real (10,7), RW) Minimum value in the range for the raw score
cmi.score.max (real (10,7), RW) Maximum value in the range for the raw score
cmi.session_time (timeinterval (second,10,2), WO) Amount of time that the learner has spent in the current learner session for this SCO
cmi.success_status (“passed”, “failed”, “unknown”, RW) Indicates whether the learner has mastered the SCO
cmi.suspend_data (characterstring (SPM: 4000), RW) Provides space to store and retrieve data between learner sessions
cmi.suspend_data (characterstring (SPM: 64000), RW) Provides space to store and retrieve data between learner sessions
cmi.time_limit_action (“exit,message”, “continue,message”, “exit,no message”, “continue,no message”, RO) Indicates what the SCO should do when cmi.max_time_allowed is exceeded
cmi.total_time (timeinterval (second,10,2), RO) Sum of all of the learner’s session times accumulated in the current learner attempt
adl.nav.request (request(continue, previous, choice, exit, exitAll, abandon, abandonAll, suspendAll _none_), RW) Navigation request to be processed immediately following Terminate()
adl.nav.request (request(continue, previous, choice, jump, exit, exitAll, abandon, abandonAll, suspendAll _none_), RW) Navigation request to be processed immediately following Terminate()
adl.nav.request_valid.continue (state (true, false, unknown), RO) Used by a SCO to determine if a Continue navigation request will succeed.
adl.nav.request_valid.previous (state (true, false, unknown), RO) Used by a SCO to determine if a Previous navigation request will succeed.
adl.nav.request_valid.choice.{target=} (state (true, false, unknown), RO) Used by a SCO to determine if a Choice navigation request for the target activity will succeed.
adl.nav.request_valid.jump.{target=} (state (true, false, unknown), RO) Used by a SCO to determine if a Jump navigation request for the target activity will succeed.
cmi.core._children (student_id, student_name, lesson_location, credit, lesson_status, entry, score, total_time, lesson_mode, exit, session_time, RO) Listing of supported data model elements
cmi.core.student_id (CMIString (SPM: 255), RO) Identifies the student on behalf of whom the SCO was launched
cmi.core.student_name (CMIString (SPM: 255), RO) Name provided for the student by the LMS
cmi.core.lesson_location (CMIString (SPM: 255), RW) The learner’s current location in the SCO
cmi.core.credit (“credit”, “no-credit”, RO) Indicates whether the learner will be credited for performance in the SCO
cmi.core.lesson_status (“passed”, “completed”, “failed”, “incomplete”, “browsed”, “not attempted”, RW) Indicates whether the learner has completed and satisfied the requirements for the SCO
cmi.core.entry (“ab-initio”, “resume”, “”, RO) Asserts whether the learner has previously accessed the SCO
cmi.core.score_children (raw,min,max, RO) Listing of supported data model elements
cmi.core.score.raw (CMIDecimal, RW) Number that reflects the performance of the learner relative to the range bounded by the values of min and max
cmi.core.score.max (CMIDecimal, RW) Maximum value in the range for the raw score
cmi.core.score.min (CMIDecimal, RW) Minimum value in the range for the raw score
cmi.core.total_time (CMITimespan, RO) Sum of all of the learner’s session times accumulated in the current learner attempt
cmi.core.lesson_mode (“browse”, “normal”, “review”, RO) Identifies one of three possible modes in which the SCO may be presented to the learner
cmi.core.exit (“time-out”, “suspend”, “logout”, “”, WO) Indicates how or why the learner left the SCO
cmi.core.session_time (CMITimespan, WO) Amount of time that the learner has spent in the current learner session for this SCO
cmi.suspend_data (CMIString (SPM: 4096), RW) Provides space to store and retrieve data between learner sessions
cmi.launch_data (CMIString (SPM: 4096), RO) Data provided to a SCO after launch, initialized from the dataFromLMS manifest element
cmi.comments (CMIString (SPM: 4096), RW) Textual input from the learner about the SCO
cmi.comments_from_lms (CMIString (SPM: 4096), RO) Comments or annotations associated with a SCO
cmi.objectives._children (id,score,status, RO) Listing of supported data model elements
cmi.objectives._count (non-negative integer, RO) Current number of objectives being stored by the LMS
cmi.objectives.n.id (CMIIdentifier, RW) Unique label for the objective
cmi.objectives.n.score._children (raw,min,max, RO) Listing of supported data model elements
cmi.objectives.n.score.raw (CMIDecimal, RW) Number that reflects the performance of the learner, for the objective, relative to the range bounded by the values of min and max
cmi.objectives.n.score.max (CMIDecimal, Rw) Maximum value, for the objective, in the range for the raw score
cmi.objectives.n.score.min (CMIDecimal, RW) Minimum value, for the objective, in the range for the raw score
cmi.objectives.n.status (“passed”, “completed”, “failed”, “incomplete”, “browsed”, “not attempted”, RW) Indicates whether the learner has completed or satisfied the objective
cmi.student_data._children (mastery_score, max_time_allowed, time_limit_action, RO) Listing of supported data model elements
cmi.student_data.mastery_score (CMIDecimal, RO) Passing score required to master the SCO
cmi.student_data.max_time_allowed (CMITimespan, RO) Amount of accumulated time the learner is allowed to use a SCO
cmi.student_data.time_limit_action (exit,message,” “exit,no message”,” continue,message”, “continue, no message”, RO) Indicates what the SCO should do when max_time_allowed is exceeded
cmi.student_preference._children (audio,language,speed,text, RO) Listing of supported data model elements
cmi.student_preference.audio (CMISInteger, RW) Specifies an intended change in perceived audio level
cmi.student_preference.language (CMIString (SPM: 255), RW) The student’s preferred language for SCOs with multilingual capability
cmi.student_preference.speed (CMISInteger, RW) The learner’s preferred relative speed of content delivery
cmi.student_preference.text (CMISInteger, RW) Specifies whether captioning text corresponding to audio is displayed
cmi.interactions._children (id,objectives,time,type,correct_responses,weighting,student_response,result,latency, RO) Listing of supported data model elements
cmi.interactions._count (CMIInteger, RO) Current number of interactions being stored by the LMS
cmi.interactions.n.id (CMIIdentifier, WO) Unique label for the interaction
cmi.interactions.n.objectives._count (CMIInteger, RO) Current number of objectives (i.e., objective identifiers) being stored by the LMS for this interaction
cmi.interactions.n.objectives.n.id (CMIIdentifier, WO) Label for objectives associated with the interaction
cmi.interactions.n.time (CMITime, WO) Point in time at which the interaction was first made available to the student for student interaction and response
cmi.interactions.n.type (“true-false”, “choice”, “fill-in”, “matching”, “performance”, “sequencing”, “likert”, “numeric”, WO) Which type of interaction is recorded
cmi.interactions.n.correct_responses._count (CMIInteger, RO) Current number of correct responses being stored by the LMS for this interaction
cmi.interactions.n.correct_responses.n.pattern (format depends on interaction type, WO) One correct response pattern for the interaction
cmi.interactions.n.weighting (CMIDecimal, WO) Weight given to the interaction relative to other interactions
cmi.interactions.n.student_response (format depends on interaction type, WO) Data generated when a student responds to an interaction
cmi.interactions.n.result (“correct”, “wrong”, “unanticipated”, “neutral”, “x.x [CMIDecimal]“, WO) Judgment of the correctness of the learner response
cmi.interactions.n.latency (CMITimespan, WO) Time elapsed between the time the interaction was made available to the learner for response and the time of the first response

Error Codes

No Error (0) No error occurred, the previous API call was successful.
General Exception (101) No specific error code exists to describe the error. Use GetDiagnostic for more information.
General Initialization Failure (102) Call to Initialize failed for an unknown reason.
Already Initialized (103) Call to Initialize failed because Initialize was already called.
Content Instance Terminated (104) Call to Initialize failed because Terminate was already called.
General Termination Failure (111) Call to Terminate failed for an unknown reason.
Termination Before Initialization (112) Call to Terminate failed because it was made before the call to Initialize.
Termination After Termination (113) Call to Terminate failed because Terminate was already called.
Retrieve Data Before Initialization (122) Call to GetValue failed because it was made before the call to Initialize.
Retrieve Data After Termination (123) Call to GetValue failed because it was made after the call to Terminate.
Store Data Before Initialization (132) Call to SetValue failed because it was made before the call to Initialize.
Store Data After Termination (133) Call to SetValue failed because it was made after the call to Terminate.
Commit Before Initialization (142) Call to Commit failed because it was made before the call to Initialize.
Commit After Termination (143) Call to Commit failed because it was made after the call to Terminate.
General Argument Error (201) An invalid argument was passed to an API method (usually indicates that Initialize, Commit or Terminate did not receive the expected empty string argument.
General Get Failure (301) Indicates a failed GetValue call where no other specific error code is applicable. Use GetDiagnostic for more information.
General Set Failure (351) Indicates a failed SetValue call where no other specific error code is applicable. Use GetDiagnostic for more information.
General Commit Failure (391) Indicates a failed Commit call where no other specific error code is applicable. Use GetDiagnostic for more information.
Undefined Data Model Element (401) The data model element name passed to GetValue or SetValue is not a valid SCORM data model element.
Unimplemented Data Model Element (402) The data model element indicated in a call to GetValue or SetValue is valid, but was not implemented by this LMS. In SCORM 2004, this error would indicate an LMS that is not fully SCORM conformant.
Data Model Element Value Not Initialized (403) Attempt to read a data model element that has not been initialized by the LMS or through a SetValue call. This error condition is often reached during normal execution of a SCO.
Data Model Element Is Read Only (404) SetValue was called with a data model element that can only be read.
Data Model Element Is Write Only (405) GetValue was called on a data model element that can only be written to.
Data Model Element Type Mismatch (406) SetValue was called with a value that is not consistent with the data format of the supplied data model element.
Data Model Element Value Out Of Range (407) The numeric value supplied to a SetValue call is outside of the numeric range allowed for the supplied data model element.
Data Model Dependency Not Established (408) Some data model elements cannot be set until another data model element was set. This error condition indicates that the prerequisite element was not set before the dependent element.
No error (0) No error occurred, the previous API call was successful.
General Exception (101) No specific error code exists to describe the error. Use LMSGetDiagnostic for more information.
Invalid argument error (201) Indicates that an argument represents an invalid data model element or is otherwise incorrect.
Element cannot have children (202) Indicates that LMSGetValue was called with a data model element name that ends in “_children” for a data model element that does not support the “_children” suffix.
Element not an array. Cannot have count. (203) Indicates that LMSGetValue was called with a data model element name that ends in “_count” for a data model element that does not support the “_count” suffix.
Not initialized (301) Indicates that an API call was made before the call to LMSInitialize.
Not implemented error (401) The data model element indicated in a call to LMSGetValue or LMSSetValue is valid, but was not implemented by this LMS. SCORM 1.2 defines a set of data model elements as being optional for an LMS to implement.
Invalid set value, element is a keyword (402) Indicates that LMSSetValue was called on a data model element that represents a keyword (elements that end in “_children” and “_count”).
Element is read only. (403) LMSSetValue was called with a data model element that can only be read.
Element is write only (404) LMSGetValue was called on a data model element that can only be written to.
Incorrect Data Type (405) LMSSetValue was called with a value that is not consistent with the data format of the supplied data model element.