POST /api/nzqa/qualifications/programmes
Price: 10 credits
List the programmes leading to one NZQF qualification or micro-credential in New Zealand's register, in every approval status: programme number and version, title, status and dates, level and credits, owner and accredited organisations, subject classification, aim, outcome, content and entry requirements
Covers approved, superseded, discontinued, withdrawn and declined programmes, each with its status. Pass a number from nzqa/qualifications/search.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)qualification string required — NZQA qualification or micro-credential number, or the qualification page URL (examples: "2860", "https://www.nzqa.govt.nz/nzqf/search/viewQualification.do?selectedItemKey=2860")version integer nullable — Qualification version; the version in force when omitted (examples: 1; min: 1)count integer required — Max number of programmes to return (min: 1; max: 1000)@type string (default: "NzqaProgramme")id string requiredversion_id string requiredversion integer nullabletitle string nullablestatus string nullablestatus_date integer nullablefirst_approved_date integer nullablereview_date integer nullablelevel_from integer nullablelevel_to integer nullablecredits_from integer nullablecredits_to integer nullableowner_name string nullableowner_moe_number string nullabletrading_name string nullableaccredited_providers array (default: [])@type string (default: "NzqaOrganizationRef")id string nullablemoe_number string nullablename string nullablenzsced_detailed string nullablenzsced_narrow string nullablenzsced_broad string nullableaim string nullableoutcome string nullablecontent string nullableentry_requirements string nullableaward_properties string nullablestandards array (default: [])@type string (default: "NzqaStandard")id string nullabletitle string nullablelevel integer nullablecredits integer nullablecomments string nullablecase_id string nullable422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.408 — The request ran past its time limit 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 leads to this qualification version, or the number is not in the register 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 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 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 Wait at least 30 seconds, then retry.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.