# /hecpk/programmes/search

`POST /api/hecpk/programmes/search`

Price: 10 credits

Search the active MS, MPhil and PhD programmes approved by the Higher Education Commission of Pakistan, by title, university, campus, department, qualification level, discipline and other programme attributes. Each programme carries its university, campus and department with their start dates, qualification level, discipline, major subject, approval status, academic calendar, session, duration, credit hours, entry criteria, NOC date and professional accreditation

## How to use it

Text filters match any part of the name, case-insensitively, and combine with each other. University names follow the programme register's spelling, which can differ from hecpk/universities/search.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `keyword` (string, nullable) — Words to look for in the programme title (examples: "Computer Science"; minLength: 1)
- `university` (string, nullable) — Words to look for in the university name (examples: "University of Karachi"; minLength: 1)
- `campus` (string, nullable) — Words to look for in the campus name (examples: "Main Campus"; minLength: 1)
- `department` (string, nullable) — Words to look for in the department name (examples: "Chemistry"; minLength: 1)
- `qualification_level` (string, nullable) — Qualification level (one of: "Doctorate Degree", "M-Phil (18 Years) Degree", "Master/ MS (18 Years) Degree"; examples: "Doctorate Degree")
- `program_group` (string, nullable) — Degree group (one of: "Master of Business Administration", "Master of Engineering", "Master of Law", "Master of Philosophy", "Master of Philosophy in Management", "Master of Research in Informatics", "Master of Science", "Doctor of Philosophy"; examples: "Master of Philosophy")
- `discipline` (string, nullable) — Broad discipline (one of: "Agriculture", "Arts & Humanities", "Biological Sciences", "Engineering & Technology", "Management Sciences & Business Education", "Medical Sciences", "Physical Sciences", "Social Sciences", "Veterinary Sciences"; examples: "Engineering & Technology")
- `campus_type` (string, nullable) — Type of the campus offering the programme (one of: "Main Campus", "Sub Campus", "Constituent College", "Approved Study Centres", "Private", "Private Sector Partners"; examples: "Sub Campus")
- `degree_status` (string, nullable) — Approval status of the programme (one of: "Approved", "Reassessed", "Migrated"; examples: "Reassessed")
- `degree_type` (string, nullable) — Academic calendar of the programme (one of: "Semester", "Annual", "Term"; examples: "Annual")
- `session_type` (string, nullable) — Time of day the classes run (one of: "Morning", "Afternoon", "Evening", "Weekend"; examples: "Evening")
- `mode_of_study` (string, nullable) — Mode of study (one of: "Regular", "On Campus"; examples: "Regular")
- `count` (integer, required) — Max number of programmes to return (min: 1; max: 10000)

## Response

### 200 — Successful Response

- `@type` (string) (default: "HecpkProgramme")
- `id` (string, required)
- `title` (string, required)
- `program_group` (string, nullable)
- `qualification_level` (string, nullable)
- `discipline` (string, nullable)
- `major_subject` (string, nullable)
- `university_name` (string, required)
- `university_start_date` (integer, nullable)
- `campus_name` (string, nullable)
- `campus_type` (string, nullable)
- `campus_start_date` (integer, nullable)
- `department_name` (string, nullable)
- `department_start_date` (integer, nullable)
- `degree_start_date` (integer, nullable)
- `degree_status` (string, nullable)
- `degree_type` (string, nullable)
- `session_type` (string, nullable)
- `mode_of_study` (string, nullable)
- `term_count` (integer, nullable)
- `duration_years` (number, nullable)
- `min_duration_years` (number, nullable)
- `max_duration_years` (number, nullable)
- `credit_hours` (string, nullable)
- `entry_criteria` (string, nullable)
- `noc_date` (integer, nullable)
- `accreditation_required` (string, nullable)
- `accreditation_body` (string, nullable)
- `accreditation_date` (integer, nullable)
- `accreditation_status` (string, nullable)
- `accreditation_approval_status` (string, nullable)
- `comments` (string, 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 programme 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.

