POST /api/nzqa/qualifications
Price: 5 credits
Get one NZQF qualification or micro-credential from New Zealand's register: type, category, status and its dates, level and credits, and every version with its title, developer, subject classification, strategic purpose, graduate profile, pathways, entry requirements, outcomes and conditions
Pass a number from nzqa/qualifications/search. The first entry of versions is the newest; current_version and the top-level title, level and credits are the version in force (the newest APPROVED one, else the newest SUPERSEDED one). nzqa/qualifications/programmes lists the programmes leading to it.
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", "HB3812", "https://www.nzqa.govt.nz/nzqf/search/viewQualification.do?selectedItemKey=2860")@type string (default: "NzqaQualification")id string requiredtitle string nullableaward_type string nullablecategory string nullablestatus string nullablestatus_date integer nullableapproval_date integer nullableexpiry_date integer nullablediscontinued_date integer nullablelast_entry_date integer nullablelevel_from integer nullablelevel_to integer nullablecredits_from integer nullablecredits_to integer nullablecurrent_version integer nullableversions array (default: [])@type string (default: "NzqaQualificationVersion")version integer nullablecase_id string nullabletitle string nullablelong_title string nullablemaori_title string nullableversion_status string nullableversion_status_date integer nullableaward_status string nullableaward_type string nullablelevel_from integer nullablelevel_to integer nullablecredits_from integer nullablecredits_to integer nullableshow_level_in_title boolean nullablenzsced_code string nullablenzsced_name string nullabledeveloper_name string nullabledeveloper_moe_number string nullablelanguage string nullablequality_assurance_body string nullableis_te_hono_o_te_kahurangi boolean nullablereview_date integer nullablecomplete_by_date integer nullablestrategic_purpose string nullablegraduate_profile string nullableeducation_pathway string nullableemployment_pathway string nullablecontent string nullableentry_requirements string nullablecore_outcomes array (default: [])@type string (default: "NzqaCoreOutcome")id integer nullableoutcome string nullablecredits integer nullablecondition string nullableevidence_requirements string nullableprogramme_conditions string nullablequalification_award string nullableminimum_standard_endorsement string nullablecontexts_and_outcome string nullableguiding_principle string nullablereplacement_info string nullabletransition_info string nullablenotes string nullableelective_strands array (default: [])@type string (default: "NzqaStrand")id integer nullabletitle string nullableoutcomes array (default: [])optional_strands array (default: [])@type string (default: "NzqaStrand")id integer nullabletitle string nullableoutcomes array (default: [])url string required422 — 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 qualification or micro-credential with this number is 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.