Skip to navigation

Add a qualification to an application

View as Markdown

Appends a qualification (with optional nested subjects) to an existing application. Allowed while the application has not yet been processed.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
typestringOptional

tertiary | subject | work_experience.

sourcestringOptional

Reporting source; defaults to "officer".

datamap from strings to anyOptional

Type-specific fields, e.g. {code, name, institution, completedYear}.

subjectslist of objectsOptional

Nested subjects (for a tertiary qualification).

Response

OK
idstringOptionalformat: "uuid"
typestringOptional

tertiary | subject | work_experience.

parentIdstringOptionalformat: "uuid"

The qualification this one sits under — a subject's degree. Null for a top-level qualification.

datamap from strings to anyOptional

The type-specific fields, consolidated across every source that has reported this qualification.

documentCountintegerOptional

How many supporting documents are attached, so you can tell at a glance whether evidence has been uploaded. Counts confirmed uploads only; list them with GET /institution/qualifications/{id}/documents.

Errors

400
Bad Request Error