# /uac/courses/search

`POST /api/uac/courses/search`

Price: 20 credits

Search the UAC (NSW and ACT) admissions course catalogue: one record per course at a campus, with its provider, course level, durations, attendance modes, intakes with closing dates and ATAR profile

## How to use it

Pick `level`: undergraduate, postgraduate, international or online; each is its own catalogue. One record is one course at one campus; pass its `level` and `course_id` to uac/courses for the course description, fees and student profile. ATAR values UAC withholds are null, with the reason code in `value_codes`.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `level` (string, required) — Which UAC course search to read. (one of: "undergraduate", "postgraduate", "international", "online"; examples: "undergraduate")
- `keyword` (string, nullable) — Words to search course titles and keywords for. (examples: "nursing"; minLength: 1)
- `search_course_content` (boolean) — Also match the keyword against the course descriptions and areas of study. (default: false)
- `providers` (array) — Keep only courses of these institutions, given as the `provider_id` codes UAC uses. (default: []; examples: ["MQ","UOW"])
- `fields_of_study` (array) — Keep only courses in these broad fields of study. (default: []; one of: "Agriculture, Environmental and Related Studies", "Architecture and Building", "Creative Arts", "Education", "Engineering and Related Technologies", "Food, Hospitality and Personal Services", "Health", "Information Technology", "Management and Commerce", "Mixed Field Programs", "Natural and Physical Sciences", "Society and Culture"; examples: ["Health"])
- `course_levels` (array) — Keep only courses at these UAC course levels: TBP Bachelor, TBH Bachelor (Honours), TBG Bachelor (Graduate Entry), TAB Associate Degree, TXD Diploma, TZD Advanced Diploma, TOA Undergraduate Certificate, TEN Preparation Program, TCM Bachelor/Master or Masters, TCD, TPD and THD Masters or Doctoral Degree, TGO and TGS Graduate Diploma, TGC Graduate Certificate, TNA Bridging Program, TRM Research Masters Degree, TT1 to TT4 Certificate I to IV. (default: []; one of: "TBP", "TBH", "TBG", "TAB", "TXD", "TZD", "TOA", "TEN", "TCM", "TCD", "TPD", "THD", "TGO", "TGS", "TGC", "TNA", "TRM", "TT1", "TT2", "TT3", "TT4"; examples: ["TBP"])
- `fee_types` (array) — Keep only courses with these fee types: CSP Commonwealth supported place, DFEE domestic fee-paying, INT international fee-paying, ADF, ENA, VET and OTH as UAC codes them. (default: []; one of: "CSP", "DFEE", "INT", "ADF", "ENA", "VET", "OTH"; examples: ["CSP"])
- `start_months` (array) — Keep only courses with an intake starting in these months, 1 to 12. (default: []; examples: [2,7])
- `attendance_modes` (array) — Keep only courses offered in these attendance modes. (default: []; one of: "full_time", "part_time", "online"; examples: ["part_time"])
- `course_status` (string, nullable) — Keep only open courses, or only withdrawn ones. (one of: "open", "withdrawn"; examples: "open")
- `pathway_courses` (string, nullable) — Keep only pathway courses, or leave them out. (one of: "only", "exclude"; examples: "only")
- `online_course_type` (string, nullable) — With level `online`: keep only undergraduate or only postgraduate courses. (one of: "undergraduate", "postgraduate")
- `sort` (string) — Order of the results. (default: "relevance"; one of: "relevance", "alphabetical-az", "alphabetical-za", "duration-sl", "duration-ls"; examples: "alphabetical-az")
- `count` (integer, required) — Max number of course variants to return. (examples: 100; min: 1; max: 3000)

## Response

### 200 — Successful Response

- `@type` (string) (default: "UacCourseVariant")
- `id` (string, required)
- `course_id` (string, nullable)
- `course_code` (string, nullable)
- `level` (string, required)
- `url` (string, nullable)
- `name` (string, nullable)
- `provider_id` (string, nullable)
- `provider_name` (string, nullable)
- `provider_image` (string, nullable)
- `campus_code` (string, nullable)
- `campus_location_code` (string, nullable)
- `course_level` (string, nullable)
- `course_status` (string, nullable)
- `is_pathway` (boolean, nullable)
- `course_stage` (integer, nullable)
- `start_months` (array) (default: [])
- `durations` (array) (default: [])
  - `@type` (string) (default: "UacDuration")
  - `code` (string, required)
  - `length` (number, nullable)
  - `unit` (string, nullable)
  - `attendance` (string, nullable)
- `attendance_modes` (array) (default: [])
- `channel_id` (string, nullable)
- `channel_type` (string, nullable)
- `channel_subtype` (string, nullable)
- `channel_target` (string, nullable)
- `offerings` (array) (default: [])
  - `@type` (string) (default: "UacOffering")
  - `start_date` (integer, nullable)
  - `closing_date` (integer, nullable)
  - `enrolment_date` (integer, nullable)
  - `mature_age_birth_date` (integer, nullable)
  - `is_selectable` (boolean, nullable)
- `atar_profiles` (array) (default: [])
  - `@type` (string) (default: "UacAtarProfile")
  - `year` (integer, nullable)
  - `lowest_atar` (number, nullable)
  - `median_atar` (number, nullable)
  - `highest_atar` (number, nullable)
  - `lowest_selection_rank` (number, nullable)
  - `median_selection_rank` (number, nullable)
  - `highest_selection_rank` (number, nullable)
  - `profile_code` (string, nullable)
  - `value_codes` (object) (default: {})
    - `*` (string)
  - `collection_year` (integer, nullable)
  - `guaranteed_atar` (string, nullable)
  - `profile_link` (string, nullable)
- `relevance_score` (number, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

No courses available

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.

