PathwayProgress
A request or response body; the type column links to the schemas it refers to.
PathwayProgress
| Field | Type | Required | Description |
|---|---|---|---|
| pathway_id | string (uuid) | yes | — |
| slug | string | yes | — |
| name | string | yes | — |
| description_markdown | string | null | yes | — |
| attachments | array of PathwayAttachment | yes | The pathway'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 pathway that reach the viewer, in authored order — an aid outside their audience, or archived, is left out. |
| phases | array of PathwayPhaseProgress | yes | Every phase in dependency order (creation order between unrelated phases), each with its derived state. |
| levels | array of PathwayLevelProgress | yes | Every level in authored order, each with its derived state. |
| current_level_ids | array of string (uuid) | yes | The unlocked-but-incomplete levels — where the viewer is right now. |
| complete | boolean | yes | Whether every level is complete for the viewer. |
jsonExample
{
"pathway_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"slug": "string",
"name": "string",
"description_markdown": "string",
"attachments": [
null
],
"job_aids": [
{
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"title": "string",
"description": "string",
"audience": "trainees",
"archived": true
}
],
"phases": [
{
"phase_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"name": "string",
"description_markdown": "string",
"depends_on_phase_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"level_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"state": "locked",
"level_count": 0,
"complete_level_count": 0
}
],
"levels": [
{
"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
}
]
}
],
"current_level_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"complete": true
}