< Previous | Contents | Next >

Application Programming Interface (API)


SCORM® 2004 4th Edition documentation suite reprinted with permission from IEEE Std. 1484.11.1-2004 IEEE Standard for Learning Technology – Data Model for Content to Learning Management System Communication, Copyright 2004, by IEEE; IEEE Std. 1484.11.2-2003 IEEE Standard for Learning Technology – ECMAScript Application Programming Interface for Content to Runtime Services Communication, Copyright 2003, by IEEE; IEEE Std. 1484.12.1-2002 IEEE Standard for Learning Object Metadata, Copyright 2002, by IEEE; and IEEE Std.

1484.12.3-2005 IEEE Standard for Learning Technology – Extensible Markup Language (XML) Schema Definition Language Binding for Learning Object Metadata, Copyright 2005, by IEEE. The IEEE disclaims any responsibility or liability resulting from the placement and use in the described manner.

SCORM® 2004 4th Edition documentation suite contains material reprinted with permission from IMS Content Packaging v1.1.4 Copyright 2004, by IMS Global Learning Consortium (IMS GLC) and IMS Simple Sequencing v1.0 Copyright 2003, by IMS GLC. IMS Global Learning Consortium has made no inquiry into whether or not the implementation of third party material included in this document would infringe upon the intellectual property rights of any party. Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the document set forth in this document, and to provide supporting documentation to IMS. This material is being offered without any warranty whatsoever, and in particular, any warranty of non-infringement is expressly disclaimed. Any use of this material shall be made entirely at the implementer’s own risk, and neither the IMS GLC nor any of its members or submitters, shall have any liability whatsoever to any implementer or third party for any damages of any nature whatsoever, directly or indirectly, arising from the use of this material.


This page intentionally left blank.


 

3.1. Application Programming Interface (API)3.1.1. API Overview3.1.2. API Methods and Syntax3.1.3. Session Methods3.1.3.1 Initialize3.1.3.2 Terminate3.1.4. Data-Transfer Methods3.1.4.1 GetValue3.1.4.2 SetValue3.1.4.3 Commit3.1.5. Support Methods3.1.5.1 GetLastError3.1.5.2 GetErrorString3.1.5.3 GetDiagnostic3.1.6. Communication Session State Model3.1.7. API Implementation Error Codes3.1.7.1 Successful API Function Invocation3.1.7.2 General Error Codes3.1.7.2.1 General Exception (101)3.1.7.2.2 General Initialization Failure (102)3.1.7.2.3 Already Initialized (103)3.1.7.2.4 Content Instance Terminated (104)3.1.7.2.5 General Termination Failure (111)3.1.7.2.6 Termination Before Initialization (112)3.1.7.2.7 Termination After Termination (113)3.1.7.2.8 Retrieve Data Before Initialization (122)3.1.7.2.9 Retrieve Data After Termination (123)3.1.7.2.10 Store Data Before Initialization (132)3.1.7.2.11 Store Data After Termination (133)3.1.7.2.12 Commit Before Initialization (142)3.1.7.2.13 Commit After Termination (143)3.1.7.3 Syntax Error Codes3.1.7.3.1 General Argument Error (201)3.1.7.4 RTS Error Codes3.1.7.4.1 General Get Failure (301)3.1.7.4.2 General Set Failure (351)3.1.7.4.3 General Commit Failure (391)3.1.7.5 Data Model Error Codes3.1.7.5.1 Undefined Data Model Element (401)3.1.7.5.2 Unimplemented Data Model Element (402)3.1.7.5.3 Data Model Element Value Not Initialized (403)3.1.7.5.4 Data Model Element Is Read Only (404)3.1.7.5.5 Data Model Element Is Write Only (405)3.1.7.5.6 Data Model Element Type Mismatch (406)3.1.7.5.7 Data Model Element Value Out Of Range (407)3.1.7.5.8 Data Model Dependency Not Established (408)3.1.7.6 SCORM Extension Error Conditions3.1.7.6.1 Data Model Element Does Not Have Children3.1.7.6.2 Data Model Element Cannot Have Count3.1.7.6.3 Data Model Element Collection Set Out Of Order3.1.7.6.4 Data Model Collection Element Request Out Of Range3.1.7.6.5 Data Model Element Not Specified3.1.7.6.6 Unique Identifier Constraint Violated3.1.7.6.7 Smallest Permitted Maximum Exceeded3.1.7.6.8 Data Model Element Does Not Have Version3.1.7.6.9 Identifier Value Can Only Be Set Once3.2. LMS Responsibilities3.2.1. API Instance3.2.1.1 Version Attribute3.3. SCO Responsibilities3.3.1. Finding the API Instance3.3.2. API Usage Requirements and Guidelines3.3.2.1 Unexpected events