CreateQrCodeRequest
A request or response body; the type column links to the schemas it refers to.
CreateQrCodeRequest
| Field | Type | Required | Description |
|---|---|---|---|
| org | string | yes | Organization UUID id or slug the code belongs to. at least 1 character |
| department | string | no | UUID id or slug of the owning department within the organization; omit for a code owned by the organization directly. Ownership scopes administration and, for a url code, limits following it to the department's role holders. at least 1 character |
| slug | string | no | Omit to have one generated. Choose it before printing: it cannot be changed after. 2–128 characters · matches ^[a-z0-9][a-z0-9_-]{1,127}$ |
| name | string | yes | 1–200 characters |
| description | string | no | Omit or send empty for no note. at most 2000 characters |
| target_kind | string | yes | 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" |
| target_id | string (uuid) | no | For a job_aid, scorm_course or quiz code: the id of that resource, which must belong to the code's organization. Omit for a url code. |
| target_url | string (uri) | no | For a url code: where it points. Omit for every other kind. 1–2000 characters |
{
"org": "acme-corporation",
"department": "string",
"slug": "bay-3-fume-hood",
"name": "Bay 3 fume hood poster",
"description": "string",
"target_kind": "job_aid",
"target_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"target_url": "https://example.com/safety-notice"
}