ScormLaunch

A request or response body; the type column links to the schemas it refers to.

ScormLaunch

Field	Type	Required	Description
attempt	ScormAttempt	yes	—
course	ScormCourse	yes	—
entry	string	yes	resume seeds the saved CMI map so the module restores its state. one of "ab-initio" \| "resume"
cmi	object	yes	SCORM CMI elements by name, e.g. cmi.core.lesson_status.
total_time_seconds	number	yes	—
objective_ids	array of string	yes	Manifest-declared objectives the runtime seeds, like a real LMS.
mastery_score	number \| null	yes	—
learner_id	string	yes	—
learner_name	string	yes	—
content_url	string	yes	Absolute URL of the package's launch resource, on the deployment's SCORM content host. Relative asset URLs inside the module resolve under the same signed content prefix.
player_url	string	yes	Absolute URL of the launcher page the player frames, on the SCORM content host: it hosts the SCORM runtime the module talks to, frames content_url, and reports to its parent window by postMessage.
commit_token	string	yes	Signed ticket the launcher saves this attempt with, through PUT /scorm-frame-commits/{commit_ticket}; good for this attempt alone.

jsonExample

{
  "attempt": {
    "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "course_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "user_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "attempt_number": 0,
    "package_version_number": 0,
    "status": "in_progress",
    "api_flavor": "scorm-1.2",
    "completion_status": "completed",
    "success_status": "passed",
    "score_raw": 0,
    "score_max": 0,
    "score_scaled": 0,
    "progress_measure": 0,
    "location": "string",
    "total_time_seconds": 0,
    "started_at": "2026-01-01T00:00:00.000Z",
    "last_commit_at": "2026-01-01T00:00:00.000Z",
    "completed_at": "2026-01-01T00:00:00.000Z",
    "passed": true,
    "closed_at": "2026-01-01T00:00:00.000Z",
    "learning_record_id": "1b671a64-40d5-491e-99b0-da01ff1f3341"
  },
  "course": {
    "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "owner_department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "name": "string",
    "description": "string",
    "audience": "trainees",
    "subjects": [
      {
        "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
        "slug": "string",
        "name": "string"
      }
    ],
    "scorm_version": "scorm-1.2",
    "launch_path": "string",
    "mastery_score": 0,
    "package_file_name": "string",
    "package_size_bytes": 0,
    "package_replaced_at": "2026-01-01T00:00:00.000Z",
    "current_package_version": 0,
    "recertification_required_at": "2026-01-01T00:00:00.000Z",
    "recertification_required_from_version": 0,
    "created_by": "string",
    "created_at": "2026-01-01T00:00:00.000Z",
    "archived_at": "2026-01-01T00:00:00.000Z"
  },
  "entry": "ab-initio",
  "cmi": {},
  "total_time_seconds": 0,
  "objective_ids": [
    "string"
  ],
  "mastery_score": 0,
  "learner_id": "string",
  "learner_name": "string",
  "content_url": "string",
  "player_url": "string",
  "commit_token": "string"
}