PathwayPhaseProgress
A request or response body; the type column links to the schemas it refers to.
PathwayPhaseProgress
| Field | Type | Required | Description |
|---|---|---|---|
| phase_id | string (uuid) | yes | — |
| name | string | yes | — |
| description_markdown | string | null | yes | — |
| depends_on_phase_ids | array of string (uuid) | yes | The phases this one comes after — an ordering for display, never a gate. |
| level_ids | array of string (uuid) | yes | The levels grouped under this phase, in authored order. |
| state | string | yes | complete: every level in the phase is complete (vacuously when it has none). unlocked: at least one level is unlocked or complete. locked: every level is still locked. Presentation only. one of "locked" | "unlocked" | "complete" |
| level_count | integer | yes | — |
| complete_level_count | integer | yes | — |
jsonExample
{
"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
}