POST /api/campusfrance/programs
Price: 1 credit
Get one programme from the Campus France master and licence (bachelor-level) directories by its id, reference or share link: French name, year of study, duration, diploma type, programme website, tracks, subjects with their guide sheets, and the delivering institution with its parent university, postal address, phone, website, coordinates and guide sheets.
One programme by the `id` campusfrance/programs/search returns, with that row's `catalogue`.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)program string required — Master or licence programme id, reference or share link (examples: "118014492", "FOR.1180-ENS.14492", "https://cataloguelm.campusfrance.org/master/ws/cfgetmaster.php?id=1180_14492_en")catalogue string nullable — Directory holding the programme, when known: master or licence (one of: "master", "licence")@type string (default: "CampusfranceProgram")id string requiredcatalogue string required (one of: "master", "licence")reference string nullablename string nullablelevel string nullableduration integer nullableduration_unit string nullablediploma_type string nullablediploma_type_code string nullablediploma_sheet_url string nullableurl string nullabletracks array (default: [])subjects array (default: [])@type string (default: "CampusfranceSubject")id string nullablename_fr string nullablename_en string nullablesheet_url string nullableinstitution object nullable@type string (default: "CampusfranceProgramInstitution")id string nullablename string nullableparent_id string nullableparent_name string nullableaddress string nullablepo_box string nullablepostal_code string nullablecedex string nullablecity string nullabledepartment string nullableregion string nullableregion_code string nullablephone string nullablewebsite_url string nullablelatitude number nullablelongitude number nullableinstitution_sheet_url string nullablewelcome_sheet_url 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 master or licence programme has 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.