ScormApi
Gets data for the specified SCORM CMI fields based on the element names.
Results are ordered alphabetically by SCO ID.
Requires the View Section Enrollments permission in the enrollment organization or an ancestor.
Which page of results to start on
Use the AdminApi Authenticate method to get the access_token
Contains information for filtering which SCORM CMI data to retrieve
Id of the enrollment to get SCORM data for
00000000-0000-0000-0000-000000000000Id of the assignment to get SCORM data for
00000000-0000-0000-0000-000000000000List of CMI element names to get data for
List of SCOs and corresponding CMI data
Not authorized to view CMI data
Entity not found
Validation exception. See response body for more info.
POST /api/v1/ScormApi/GetCmiData HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 140
{
"enrollment_id": "00000000-0000-0000-0000-000000000000",
"assignment_id": "00000000-0000-0000-0000-000000000000",
"cmi_element_names": [
"text"
]
}[
{
"title": "text",
"sco_id": "text",
"start_date_utc": "2025-09-13T12:09:34.390Z",
"exit_date_utc": "2025-09-13T12:09:34.390Z",
"cmi_fields": [
{
"cmi_element_name": "text",
"cmi_element_value": "text",
"error_message": "text"
}
],
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}
]Edits data for a student's SCORM courseware attempt and corresponding history (if applicable)
based on the supplied assignment status id and SCO id.
If a field is not passed in, the value will remain unchanged.
Requires the Update Section Enrollments permission in the assignment status enrollment
organization or an ancestor.
Use the AdminApi Authenticate method to get the access_token
Contains fields for editing a student's SCORM courseware attempt
Id of the assignment status to edit SCORM data for
00000000-0000-0000-0000-000000000000ScoId from GetCmiData
Title for the lesson
When this attempt was started
When the user exited this attempt
"browse", "normal", or "review"
This is the current student status as determined by the LMS system. "passed", "completed", "failed", "incomplete", "browsed", or "not attempted"
This corresponds to the point in the lesson at which the student exited the SCO. This can be used to determine where the student will start the course the next time it is launched.
Indicates how the learner left the SCO. "normal" or "suspend"
Identifies the amount of time the learner has spent in the current instance of the SCO.
Stores the learner’s cumulative time for all sessions of a specific SCO for a given learner attempt.
Number that reflects the performance of the learner
Provides space to store and retrieve data between learner sessions
Indicates whether the learner has previously accessed the SCO. "ab-initio", "resume", or "" (empty string)
The student’s preferred language for SCOs with multilingual capability
The learner’s preferred relative speed of content delivery
Indicates whether the learner will be credited for performance in the SCO
Base error response
Not authorized to edit SCORM data
Entity not found
Validation exception
POST /api/v1/ScormApi/EditScormData HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 432
{
"assignment_status_id": "00000000-0000-0000-0000-000000000000",
"sco_id": "text",
"title": "text",
"start_date_utc": "2025-09-13T12:09:34.390Z",
"exit_date_utc": "2025-09-13T12:09:34.390Z",
"lesson_mode": "text",
"lesson_status": "text",
"lesson_location": "text",
"exit_status": "text",
"session_time": "text",
"total_time": "text",
"raw_score": 1,
"suspend_data": "text",
"entry": "text",
"preference_language": "text",
"preference_speed": 1,
"for_credit": true
}{
"api_error_entity": {
"error_code": 0,
"error_message": "text",
"warning_messages": [
"text"
]
}
}