Skip to navigation
UNSW Advance Institution APICatalogue

Update a catalogue specialisation

View as Markdown

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

Writable: name, type, creditPoints, studyLevel, fieldOfEducation, facultyName, schoolName and externalIds.

Full-representation semantics: each writable field is written as supplied, so omitting one (or sending null / "") CLEARS it. externalIds is the exception: it merges per system. 404 if there is no such specialisation, 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
typestringOptional

Major | Minor | Honours | Specialisation | Research.

creditPointsintegerOptional
studyLevelstringOptional
fieldOfEducationstringOptional
Empty string and null both clear the stored value.
facultyNamestringOptional
schoolNamestringOptional
externalIdsmap from strings to stringsOptional

Merged per system: a system you omit keeps its existing id.

Response

The specialisation was replaced.
idstringOptionalformat: "uuid"
Our stable id, unchanged by an update.
codestringOptional
yearintegerOptional
statusstringOptional

created | updated.

Errors

400
Bad Request Error
404
Not Found Error