QrCodeTarget

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

QrCodeTarget

FieldTypeRequiredDescription
kindstringyes

What the code points at: one of this deployment's job aids, hosted SCORM courses or quizzes — reached on the learner's own page for it — or a raw http(s) URL anywhere.

one of "job_aid" | "scorm_course" | "quiz" | "url"

idstring (uuid) | nullyes

The job aid, course or quiz the code points at; null for a url code, and null again once that resource has been permanently deleted.

urlstring | nullyes

The raw destination of a url code; null for every other kind.

labelstring | nullyes

The resource's title or name — as it is now for a code's current target, as it was at the time for a change's snapshot — or null for a url code.

statusstringyes

live: scanning can reach it (a url always is). archived: the resource is archived, so scans answer unavailable. unpublished: a draft quiz nobody can take yet. missing: the resource was permanently deleted; retarget the code.

one of "live" | "archived" | "unpublished" | "missing"

jsonExample
{
  "kind": "job_aid",
  "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "url": "https://example.com/safety-notice",
  "label": "string",
  "status": "live"
}