Skip to navigation
UNSW Advance Institution APICatalogue

Update a catalogue subject

View as Markdown

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

Writable: name, creditPoints, studyLevel, fieldOfEducation, facultyName, schoolName, kind, complexity, description, learningOutcomes, discipline, availability, conditions 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. If you only want to change one field, use PATCH instead, which leaves everything you omit alone.

externalIds is the exception: it merges per system, so a system you omit keeps its existing id. 404 if there is no such subject, 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
creditPointsintegerOptional

Credit points (UOC) the subject is worth.

studyLevelstringOptional
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
kindstringOptional

Whether this row is a specific subject or an unspecified credit block (a placeholder used to grant credit without naming a subject).

complexitystringOptional

How advanced the subject is. Free text, but use the same vocabulary as the studyLevel recorded on applicants' subjects (introductory, intermediate, advanced), because credit matching compares the two and a mismatch fails to match silently rather than erroring.

descriptionstringOptional
Summary of what the subject covers. Shown in the UI, and intended as input to similarity matching later, so prose is more useful here than keywords.
learningOutcomesstringOptional

What a student can do on completing the subject. Same purpose as description: display now, similarity matching later.

disciplinestringOptional
Discipline code for the subject. Lets a structure group by discipline directly instead of parsing a prefix out of the subject code, which breaks as soon as a code doesn't follow the usual pattern.
availabilitystringOptional
When the subject can be studied. Carried into outcome reporting for international students, who need to know which terms are offered.
conditionsstringOptional
Prerequisites, equivalents, exclusions and anything else that affects whether credit can be granted for this subject. Displayed to whoever is assessing an RPL claim, not evaluated automatically.
externalIdsmap from strings to stringsOptional

Your own identifiers for this subject, keyed by system name. Merged per system: a system you omit keeps its existing id. An id already used for a different subject is rejected.

Response

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

created | updated.

Errors

400
Bad Request Error
404
Not Found Error