PathwayLevelProgress
A request or response body; the type column links to the schemas it refers to.
PathwayLevelProgress
| Field | Type | Required | Description |
|---|---|---|---|
| level_id | string (uuid) | yes | — |
| name | string | yes | — |
| description | string | null | yes | — |
| description_markdown | string | null | yes | — |
| attachments | array of PathwayAttachment | yes | The level's trainee handouts, in authored order. Trainer resources are never part of progress; the authoring read carries them. |
| job_aids | array of JobAidRef | yes | The job aids presented on the level that reach the viewer, in authored order — an aid outside their audience, or archived, is left out. |
| position | integer | yes | — |
| phase_id | string (uuid) | null | yes | The phase grouping this level, or null for an ungrouped level. |
| depends_on_level_ids | array of string (uuid) | yes | — |
| depends_on_phase_ids | array of string (uuid) | yes | Phases every level of which must be complete before this one unlocks. |
| state | string | yes | complete: every applicable certification is awarded (vacuously complete when none applies). unlocked: every prerequisite level, and every level of every prerequisite phase, is complete. locked: rendered collapsed — presentation only, nothing is enforced server-side. one of "locked" | "unlocked" | "complete" |
| assignment | string | yes | assigned: at least one certification in the level is required of the viewer. nothing_assigned: the level holds certifications, but none is required of any of the viewer's roles — it derives as complete without their earning anything, and the pages show it as "nothing assigned" rather than "complete". empty: no certification is placed in the level yet. one of "assigned" | "nothing_assigned" | "empty" |
| applicable_count | integer | yes | Certifications in the level that apply to the viewer. |
| awarded_count | integer | yes | Of the applicable ones, how many the viewer currently holds. |
| has_overdue | boolean | yes | Whether any applicable certification in the level is past due — the warning badge on an otherwise complete level. Never re-locks anything. |
| certifications | array of PathwayCertProgress | yes | — |
{
"level_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"name": "string",
"description": "string",
"description_markdown": "string",
"attachments": [
null
],
"job_aids": [
{
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"title": "string",
"description": "string",
"audience": "trainees",
"archived": true
}
],
"position": 0,
"phase_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"depends_on_level_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"depends_on_phase_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"state": "locked",
"assignment": "assigned",
"applicable_count": 0,
"awarded_count": 0,
"has_overdue": true,
"certifications": [
{
"certification_type_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"slug": "string",
"name": "string",
"applies_to_user": true,
"awarded": true,
"overdue": true
}
]
}