No Errors
The API Instance's error code is set to 0 if no errors occur during the API function execution. If the error code is 0 after an API function call the following is assumed:
- Initialize("") - The API Instance has successfully performed the appropriate learning management system (LMS) specific communication session initialization procedures. The communication session has been established and the API Instance is ready for other function calls. The conceptual communication state of the API Instance is now "Running".
- GetValue(parameter) - The requested data model element's value is returned. The value from the request shall be considered reliable and accurate according to the LMS. The conceptual communication state has not changed.
- SetValue(parameter_1, parameter_2) - The value passed in as parameter_2 of the SetValue() was successfully set (stored as the value associated with the data model element described by parameter_1) by the LMS. A request to GetValue() for the data model element used in the SetValue(), parameter_1, shall return the value that was stored by the LMS. The conceptual communication state has not changed.
- Commit("") - Any values that were set (using the SetValue() method call) since Initialize("") or the last Commit("") method call, have been successfully forwarded to the persistent data store. This method guarantees that the data will be available during subsequent learner sessions within the same learner attempt with the SCO. The conceptual communication state has not changed.
- GetLastError(), GetErrorString() and GetDiagnostic() - These API methods do not affect or alter the error code for the API Instance.
- Terminate("") - The API Instance has successfully performed the appropriate LMS specific communication session termination procedures. The communication session has ended. The conceptual communication state of the API Instance is now "Terminated".