> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs-unsw-v6.advance-uac.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs-unsw-v6.advance-uac.com/_mcp/server. # Get one curriculum container and its entries GET https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/{structureId} 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. Reference: https://docs-unsw-v6.advance-uac.com/unsw-advance-institution-api/catalogue/get-one-curriculum-container-and-its-entries ## Authentication - `Authorization` header (bearer token, required) — Paste a Keycloak access token (no "Bearer " prefix) ## Servers - `https://unsw-v6-dev.advance-uac.com/institution-api` (Dev, default) - `https://unsw-v6-test.advance-uac.com/institution-api` (Test) ## Request ### Path parameters - `structureId` (string, required) ### Query parameters - `programCode` (string, optional) - `programYear` (integer, optional) - `specialisationCode` (string, optional) - `specialisationYear` (integer, optional) ## Response ### 200 The container, its entries and its child containers. - `id` (string, optional) — Use this as `structureId` when adding or removing a subject. - `title` (string, optional) - `description` (string, optional) — The handbook's requirement sentence, e.g. "Students must take 30 UOC of the following subjects." - `creditPoints` (integer, optional) — UOC that must be taken from this container. - `creditPointsMax` (integer, optional) - `dynamicRules` (list of map from string to any, optional) — The handbook's wildcard requirements ("any General Education subject"), for display only, since nothing evaluates these. - `items` (list of StructureItemView, optional) - `children` (list of StructureView, optional) ## Errors ### 400 Bad Request Error The request was rejected. See `error` for which field and why. - `status` (integer, optional) — Repeats the HTTP status code. - `error` (string, optional) — What went wrong, in a form safe to show a developer. ### 404 Not Found Error No such container. If you pass an ENTRY's id by mistake the message says so and names its container. - `status` (integer, optional) — Repeats the HTTP status code. - `error` (string, optional) — What went wrong, in a form safe to show a developer. ## Types ### StructureItemView An entry inside a curriculum container. - `id` (string, optional) - `itemType` (string, optional) — Course | Major | Minor | Honours | Specialisation | Research. Only Course can be added through the API; the rest came from the handbook. - `code` (string, optional) - `year` (integer, optional) - `name` (string, optional) - `uoc` (integer, optional) — Credit points this entry contributes. - `resolved` (boolean, optional) — False when the code isn't in our catalogue. Only ever the case for entries from the original handbook import, because subjects added through the API must resolve. ### StructureView A container in a curriculum: a requirement, its entries, and its children. - `id` (string, optional) — Use this as `structureId` when adding or removing a subject. - `title` (string, optional) - `description` (string, optional) — The handbook's requirement sentence, e.g. "Students must take 30 UOC of the following subjects." - `creditPoints` (integer, optional) — UOC that must be taken from this container. - `creditPointsMax` (integer, optional) - `dynamicRules` (list of map from string to any, optional) — The handbook's wildcard requirements ("any General Education subject"), for display only, since nothing evaluates these. - `items` (list of StructureItemView, optional) - `children` (list of StructureView, optional) ## Examples **Response** ```json { "id": "string", "title": "string", "description": "string", "creditPoints": 1, "creditPointsMax": 1, "dynamicRules": [ {} ], "items": [ { "id": "string", "itemType": "string", "code": "string", "year": 1, "name": "string", "uoc": 1, "resolved": true } ], "children": [ { "id": "string", "title": "string", "description": "string", "creditPoints": 1, "creditPointsMax": 1, "dynamicRules": [ {} ], "items": [ { "id": "string", "itemType": "string", "code": "string", "year": 1, "name": "string", "uoc": 1, "resolved": true } ], "children": [ null ] } ] } ``` **SDK Code** ```python import requests url = "https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/structureId" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/structureId'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/structureId" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/structureId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/structureId") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/structureId', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/structureId"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://unsw-v6-dev.advance-uac.com/institution-api/institution/catalogue/structures/structureId")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```