Skip to navigation

Get a catalogue subject

View as Markdown

The catalogue subject for a (code, year), including every external id recorded against it keyed by system.

404 if there is no such subject.

Authentication

AuthorizationBearer

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

Path parameters

codestringRequired
yearintegerRequired

Response

The subject and every external id recorded against it.
idstringOptionalformat: "uuid"
codestringOptional
yearintegerOptional
namestringOptional
creditPointsintegerOptional
studyLevelstringOptional
fieldOfEducationstringOptional
facultyNamestringOptional
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
Every external id recorded for this subject, keyed by system name.
createdAtdatetimeOptional
updatedAtdatetimeOptional

Errors

404
Not Found Error