Skip to navigation
UNSW Advance Institution APICatalogue

Create a curriculum container

View as Markdown

Creates a container in a curriculum. What it becomes depends on what you supply:

  • parentId makes it a child of that container, inheriting its owner. A child cannot belong to a different curriculum than its parent, so don’t also send an owner.
  • an owner (programCode+programYear or specialisationCode+specialisationYear) makes it a new root on that curriculum.
  • neither makes it a DRAFT root, owned by nobody. Build it and review it, then attach it with PUT /{structureId}/owner when you’re satisfied.

creditPoints is the requirement: the UOC that must be taken from this container.

Authentication

AuthorizationBearer

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

Query parameters

parentIdstringOptionalformat: "uuid"
programCodestringOptional
programYearintegerOptional
specialisationCodestringOptional
specialisationYearintegerOptional

Request

This endpoint expects an object.
titlestringOptional
e.g. "Core Subjects".
descriptionstringOptional
The requirement in words, e.g. "Students must take 30 UOC of the following subjects."
creditPointsintegerOptional
UOC that must be taken from this container.
creditPointsMaxintegerOptional

Upper bound, where the handbook states one. Must not be less than creditPoints.

sortintegerOptional
Position among siblings. Defaults to 0.

Response

The container was created.
idstringOptionalformat: "uuid"
parentIdstringOptionalformat: "uuid"
Null for a root container.
titlestringOptional
descriptionstringOptional
creditPointsintegerOptional
creditPointsMaxintegerOptional
sortintegerOptional
statusstringOptional

DRAFT | LIVE. DRAFT is hidden from normal curriculum reads and keeps the tree's placement editable.

unplacedbooleanOptional

True while this container belongs to no program or specialisation. Place it with PUT /{structureId}/owner or /{structureId}/parent.

Errors

400
Bad Request Error
404
Not Found Error