POST /api/saqa/unit_standards
Price: 10 credits
Get one unit standard of the South African National Qualifications Framework from SAQA by its id: originator, field and subfield, type, NQF levels, credits, registration status and dates, purpose, range, specific outcomes with their assessment criteria, embedded knowledge, critical cross-field outcomes, the qualifications using it and the providers accredited to offer it.
Read a South African NQF unit standard by its SAQA id from saqa/unit_standards/search or a qualification.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)unit_standard string required — SAQA unit standard id or its page URL (examples: "115440", "https://allqs.saqa.org.za/showUnitStandard.php?id=115440")@type string (default: "SaqaUnitStandard")id string nullabletitle string nullableurl string nullableoriginator string nullableqa_functionary string nullablefield string nullablesubfield string nullableabet_band string nullableunit_standard_type string nullablepre_2009_nqf_level string nullablenqf_level string nullablecredits integer nullableregistration_status string nullableregistration_start_date integer nullableregistration_end_date integer nullabledecision_number string nullablelast_enrolment_date integer nullablelast_achievement_date integer nullablereplacement_note string nullablereplaces array (default: [])@type string (default: "SaqaReplacedUnitStandard")id string nullabletitle string nullablepre_2009_nqf_level string nullablenqf_level string nullablecredits integer nullablereplacement_status string nullablereplaced_by array (default: [])@type string (default: "SaqaReplacedUnitStandard")id string nullabletitle string nullablepre_2009_nqf_level string nullablenqf_level string nullablecredits integer nullablereplacement_status string nullablepurpose string nullableassumed_learning string nullablerange string nullableoutcomes array (default: [])@type string (default: "SaqaOutcome")number integer nullabletext string nullablenotes string nullablerange string nullableassessment_criteria array (default: [])@type string (default: "SaqaAssessmentCriterion")number integer nullabletext string nullablerange string nullableaccreditation_and_moderation string nullableembedded_knowledge string nullabledevelopmental_outcome string nullablelinkages string nullablecritical_cross_field_outcomes array (default: [])@type string (default: "SaqaCrossFieldOutcome")category string nullabletext string nullableassessor_criteria string nullablereregistration_history string nullablenotes string nullablequalifications array (default: [])@type string (default: "SaqaUnitStandardQualification")category string nullableid string nullabletitle string nullableurl string nullablepre_2009_nqf_level string nullablenqf_level string nullablestatus string nullableend_date integer nullableqa_functionary string nullableaccredited_providers array (default: [])other_sections array (default: [])@type string (default: "SaqaSection")heading string nullabletext 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 — SAQA shows no details for that id. 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.