POST /api/cames/diplomas/search
Price: 20 credits
Search the CAMES register of diplomas recognised in its African member countries by diploma title, institution, country, year of recognition, equivalent diploma and level, and provisional status. Each record carries the diploma id and title, the institution id and name, the country, the year of recognition, the option, the equivalent diploma with its years after the baccalaureate, and whether the recognition is provisional.
Use this to check whether a diploma of a francophone African institution is recognised by CAMES. `institution_id` is null where the register names no institution or a name two CAMES ids share; `country` is null only where it names no institution.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)count integer required — Max number of results (min: 1)keyword string nullable — Words of the diploma title, each matched anywhere in it, ignoring letter case and accents (examples: "master gestion", "médecine")institution_id string nullable — CAMES institution id (examples: "17")institution string nullable — Words of the institution name, each matched anywhere in it, ignoring letter case and accents (examples: "Université Abdou Moumouni", "Ouagadougou")country string nullable — Country of the institution, ISO 3166 code (one of: "bj", "bf", "cm", "cf", "cg", "ci", "eg", "ga", "gn", "gw", "mg", "ml", "ne", "ng", "cd", "rw", "sn", "td", "tg", "fr", "ma")recognition_year_from integer nullable — Earliest year of recognition (examples: 2020; min: 1900; max: 2100)recognition_year_to integer nullable — Latest year of recognition (examples: 2024; min: 1900; max: 2100)equivalent_diploma string nullable — Words of the equivalent diploma name, each matched anywhere in it, ignoring case and accents (examples: "Licence", "Master II")years_after_baccalaureate integer nullable — Years of study after the baccalaureate of the equivalent diploma (examples: 3, 5; min: 0; max: 10)is_provisional boolean nullable — Whether the recognition is provisional@type string (default: "CamesDiploma")id string requiredname string requiredinstitution_id string nullableinstitution_name string nullablecountry string nullablecountry_code string nullablerecognition_year integer nullableoption string nullableequivalent_diploma string nullableyears_after_baccalaureate integer nullableis_provisional boolean (default: false)422 — 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 — The entity was not found, or a precondition failed 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.