Get an application's credit decision | UAC

The credit decision on an application: what was awarded, what it counts towards, and what it is finally worth.

Read assessed first. False means no assessment has run, so credits is empty because nothing has been considered — not because nothing was awarded. An application submitted through this API stays that way until it is picked up for assessment.

Then read finalOutcome. While it is false the workflow is still running and the credit below can still change. True means the workflow has reached an end state and this is the answer.

uoc is always what the credit is worth now. An officer can reject a grant, re-price it, or mark it exempt. A rejected or exempt grant stays in the list, with its reason, counting 0 — you can see everything that was considered, and totalCreditUoc is a plain sum of the column. Where an officer changed the number, assessedUoc carries what the pipeline had originally said; where they did not, it is absent.

credits also includes anything an officer awarded outright, marked origin: manual. Those have no reason, because no rule produced them.

404 if the application id is unknown or belongs to another institution.

Authentication

AuthorizationBearer

Paste a Keycloak access token (no "Bearer " prefix)

Path parameters

idstringRequiredformat: "uuid"

Response

The credit decision as it currently stands.

applicationIdstringOptionalformat: "uuid"

statusstringOptional

Intake status: RECEIVED, READY, PROCESSING, WITHDRAWN or FAILED.

statusDetailstringOptional

Why intake failed, when status is FAILED. Null otherwise.

workflowStatusstringOptional

Assessment workflow status code; null until the application is assessed.

workflowStatusLabelstringOptional

That status in words, e.g. "Decided".

assessedbooleanOptional

Whether an assessment has run at all. False means no credit has been considered yet, not that none was awarded.

finalOutcomebooleanOptional

Whether the workflow has reached an end state. While false the credit below is provisional and can still change.

assessedAtdatetimeOptional

When assessment started; null until it does.

completedAtdatetimeOptional

When the workflow reached its end state; null while it is still running.

totalCreditUocintegerOptional

Total credit awarded, in units of credit. The sum of uoc below, so rejected credit contributes nothing.

awaitingAuthoritybooleanOptional

Whether any credit below is waiting on an academic authority. That credit IS counted in totalCreditUoc — it stands unless the authority refuses it — so while this is true the total can still fall. finalOutcome is false whenever it is true. Read authorityState on each credit to see which ones.

creditslist of objectsOptional

Every piece of credit considered, including any rejected.

Errors

404

Not Found Error