Skip to navigation

Add a new catalogue program

View as Markdown

Creates a program in the institution’s catalogue. code and year are required and together identify it.

This never updates. If a program already exists for that (code, year) the response is 409, so use PUT /{code}/{year} instead. An externalIds value already registered against a different program is a 400.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
codestringOptional
The institution's program code, e.g. "8429".
yearintegerOptional
Catalogue year, e.g. 2026. The same code in another year is a distinct program with its own id.
namestringOptional
kindstringOptional

single | double_degree | research. Only single and double_degree can be promoted to an assessable program.

creditPointsintegerOptional

Total credit points (UOC) for the program.

levelstringOptional
fieldOfEducationstringOptional
facultyNamestringOptional
The owning faculty's name as your system records it. The matching group on our side is resolved separately, so this is a label, not a link.
schoolNamestringOptional
externalIdsmap from strings to stringsOptional

Your own identifiers for this program, keyed by system name, e.g. {"sis": "PRG-0042"}. An id already used for a different program is rejected.

Response

The program was created.
idstringOptionalformat: "uuid"
Our stable id for the program, unchanged by an update.
codestringOptional
yearintegerOptional
statusstringOptional

Always updated from this endpoint.

Errors

400
Bad Request Error
409
Conflict Error