Assessment workflows
Every application is assessed by a workflow — an ordered set of steps it moves through, from submission to a decision. Which workflow applies is decided by the program, its cohort year and its stream.
You will want this for two reasons: to show an applicant where their application has got to, and to know which of your programs can accept applications at all.
What “available” means
A workflow is listed if at least one of your programs is attached to it. A workflow no
program of yours uses is not yours to see, and returns 404.
The list carries a count of each one’s steps and of your programs using it:
programCount counts distinct programs, not attachments. One program attached for three
cohort years is one program.
Steps, and where an application sits
GET /institution/workflows/{id} returns the steps in the order they run:
code is the same value as workflowStatus on the outcome
endpoint. That is what makes this useful: read the outcome, find its
workflowStatus in this list, and you know how far through the process the application is
and what is left.
label is written for people — show that, not the code.
automatic tells you whether waiting is normal
terminal: true marks an end state. Reaching one is what sets finalOutcome on the outcome
response — with one caveat about academic approval.
Which programs accept applications
programs on the detail response is the authoritative list of your programs on that
workflow, per cohort year and stream. Submit against a code + year pair that appears on
some workflow.
For the flat answer across every workflow, use
GET /institution/programs/accepting-applications — a program with no workflow attached
cannot be assessed, and submitting against it is rejected during processing.
This is read-only. Which workflow a program uses, and what steps it has, are UAC configuration decisions. Tell us if a program is on the wrong one.
