POST /api/studyaustralia/providers
Price: 10 credits
Get one Study Australia education provider by its id: type, CRICOS, RTO and TCSI codes, description, website, logo, school profile and every campus with address, coordinates, transport, accommodation, fields of study and qualification levels.
Read an Australian education provider and its campuses from an id returned by studyaustralia/providers/search or a provider page link. Its courses and scholarships come from studyaustralia/courses/search and studyaustralia/scholarships/search with provider_ids.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)provider string required — Study Australia provider id or provider page URL (examples: "ed72a788c15867049e20b2e5f048ec0a", "https://search.studyaustralia.gov.au/provider/deakin-university/ed72a788c15867049e20b2e5f048ec0a")@type string (default: "StudyaustraliaProvider")id string requiredprovider_number string nullableurl string requiredalias string nullablename string requireddescription string nullabletype_id string nullabletype string nullabletype_key string nullablesimple_type_id string nullablesimple_type string nullablesimple_type_key string nullablecricos_code string nullablerto_code string nullabletcsi_provider_id string nullablewebsite_url string nullableimage string nullablehas_accredited_courses boolean nullablehas_active_courses boolean nullableschool_profiles array (default: [])@type string (default: "StudyaustraliaSchoolProfile")id string nullableschool_level_id string nullableschool_level string nullableschool_level_key string nullablesector_id string nullablesector string nullablesector_key string nullablegender_id string nullablegender string nullablegender_key string nullablesites array (default: [])@type string (default: "StudyaustraliaProviderSite")id string nullablename string nullablesite_type_id string nullablesite_type string nullableis_primary boolean nullableaddress object nullable@type string (default: "StudyaustraliaAddress")street string nullablestreet_2 string nullablesuburb string nullablepostcode string nullablestate string nullablestate_name string nullableregion object nullable@type string (default: "StudyaustraliaRegion")id string nullablekey string nullablename string nullableshort_name string nullablecountry object nullable@type string (default: "StudyaustraliaCode")id string nullablekey string nullablename string nullablelatitude number nullablelongitude number nullablestudy_areas string nullablefields_of_study array (default: [])@type string (default: "StudyaustraliaFieldOfStudy")id string nullablekey string nullablename string nullabledescription string nullablequalifications array (default: [])@type string (default: "StudyaustraliaQualificationLevel")id string nullablekey string nullablename string nullableorder integer nullablecampus_description string nullabletransport string nullableaccommodation string nullableis_in_qld_scope boolean nullableis_in_vic_scope boolean 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 Study Australia education provider 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.