# /dhet/colleges/search

`POST /api/dhet/colleges/search`

Price: 20 credits

Search South Africa's Register of Private Colleges, the private colleges registered to offer National Certificate (Vocational) and adult education qualifications and those whose registration was cancelled, by name, registration number, status, province and qualification. Each college carries its contacts, sites of delivery with their examination centre numbers and the qualifications it is registered to offer.

## How to use it

Colleges come in register order: cancelled first, then registered; filter by status for current ones.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `count` (integer, required) — Max number of results (min: 1)
- `name` (string, nullable) — Words of the college name, ignoring letter case: every word must be contained (examples: "Avenue English", "academy")
- `registration_number` (string, nullable) — Registration number of the college (examples: "2018/FE07/020")
- `status` (string, nullable) — Registration status (one of: "registered", "cancelled")
- `province` (string, nullable) — Province of a site (one of: "Eastern Cape", "Free State", "Gauteng", "KwaZulu-Natal", "Limpopo", "Mpumalanga", "North West", "Northern Cape", "Western Cape"; examples: "Limpopo")
- `qualification` (string, nullable) — Words of a qualification the college is registered to offer (examples: "Office Practice")

## Response

### 200 — Successful Response

- `@type` (string) (default: "DhetCollege")
- `registration_number` (string, nullable) — Registration number of the college (examples: "2018/FE07/020")
- `name` (string, nullable) — College name (examples: "Avenue English CC")
- `status` (string, nullable) — Registration status (one of: "registered", "cancelled"; examples: "registered")
- `position` (integer, nullable) — Number of the entry within its status list
- `provinces` (array) — Provinces of the sites (default: []; examples: ["Gauteng"])
- `contacts` (array) — Contact people (default: []; examples: ["Mr PA Essah"])
- `phones` (array) — Telephone numbers (default: []; examples: ["011 333 0475"])
- `faxes` (array) — Fax numbers (default: [])
- `emails` (array) — Email addresses (default: [])
- `postal_address` (string, nullable) — Postal address
- `sites` (array) — Sites of delivery (default: [])
  - `@type` (string) (default: "DhetCollegeSite")
  - `address` (string, nullable) — Street address of the site (examples: "155 Commissioner Street, Johannesburg 2001")
  - `exam_centre_number` (string, nullable) — Examination centre number of the site (examples: "0899993867")
  - `province` (union, nullable) — Province of the site (examples: "Gauteng")
- `qualifications` (array) — Qualifications the college is registered to offer (default: []; examples: ["National Certificate (Vocational): Office Practice (Level 2-4)"])
- `register_date` (integer, nullable) — Date of the register edition the record comes from, unix seconds (examples: 1791936000)

## 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 college matches these filters

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.

