Skip to navigation
UNSW Advance Institution APICatalogue

Get one curriculum container and its entries

View as Markdown

A single container with every entry in it (subjects, plus any Major / Minor / Honours / Specialisation / Research references) and its child containers nested beneath. Works for a container of a program OR of a specialisation. Use it to re-read one container after adding or removing a subject instead of fetching the whole tree.

404 if the container is unknown; if you pass an ENTRY’s id by mistake the error says so and names both the container it sits in and, for a specialisation entry, the endpoint serving the curriculum it points at.

Optionally assert the owner with programCode and programYear, or specialisationCode and specialisationYear. Supply one pair, not both.

Authentication

AuthorizationBearer

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

Path parameters

structureIdstringRequiredformat: "uuid"

Query parameters

programCodestringOptional
programYearintegerOptional
specialisationCodestringOptional
specialisationYearintegerOptional

Response

The container, its entries and its child containers.
idstringOptionalformat: "uuid"

Use this as structureId when adding or removing a subject.

titlestringOptional
descriptionstringOptional
The handbook's requirement sentence, e.g. "Students must take 30 UOC of the following subjects."
creditPointsintegerOptional
UOC that must be taken from this container.
creditPointsMaxintegerOptional
dynamicRuleslist of maps from strings to anyOptional

The handbook's wildcard requirements ("any General Education subject"), for display only, since nothing evaluates these.

itemslist of objectsOptional
childrenlist of objectsOptional

Errors

400
Bad Request Error
404
Not Found Error