Skip to navigation
UNSW Advance Institution APICatalogue

Update a catalogue program

View as Markdown

Replaces an existing program, identified by the code and year in the path. Neither can be changed, since together they identify it, and neither can handbookData.

Writable: name, kind, creditPoints, level, fieldOfEducation, facultyName, schoolName and externalIds.

Full-representation semantics: each writable field is written as supplied, so omitting one (or sending null / "") CLEARS it, so send the whole set.

externalIds is the exception: it merges per system, so a system you omit keeps its existing id. 404 if there is no such program, since this never creates one.

Authentication

AuthorizationBearer

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

Path parameters

codestringRequired
yearintegerRequired

Request

This endpoint expects an object.
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
Empty string and null both clear the stored value.
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. {"handbook": "34ffd3cd93772210d45cb2ea6aba10b7"}. Merged per system: a system you omit keeps its existing id. An id already used for a different program is rejected.

Response

The program was replaced.
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
404
Not Found Error