POST /api/opintopolku/implementations
Price: 5 credits
Get one implementation of a study programme at a Finnish institution from Opintopolku (Studyinfo): teaching languages, methods and times, planned duration, start term, fees and scholarship, contact persons, keywords and occupations, and every application option with its application periods, places, prior education required and past admission scores
Implementation ids come from opintopolku/programs, opintopolku/programs/providers and opintopolku/institutions/programs. Pass an `admissions[].id` to opintopolku/admissions for its selection criteria, entrance exams and attachments.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)implementation string required — Opintopolku implementation id or its opintopolku.fi page URL (examples: "1.2.246.562.17.00000000000000003025", "https://opintopolku.fi/konfo/fi/toteutus/1.2.246.562.17.00000000000000036781"; minLength: 1)@type string (default: "OpintopolkuImplementation")id string requiredurl string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableprogram_id string nullableprogram_type string nullableprogram_type_path string nullablestatus string nullabledescription object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablelearning_outcomes object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablequalifications array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecredits number nullablecredits_unit object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestudy_type object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecompetence_areas array (default: [])@type string (default: "OpintopolkuCompetenceArea")area object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabletitle object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablelink object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablekeywords object nullable@type string (default: "OpintopolkuWords")fi array (default: [])sv array (default: [])en array (default: [])occupations object nullable@type string (default: "OpintopolkuWords")fi array (default: [])sv array (default: [])en array (default: [])teaching_languages array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_languages_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_methods array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_methods_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_times array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_times_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableduration_years integer nullableduration_months integer nullableduration_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestart object nullable@type string (default: "OpintopolkuStartTerm")start_type string nullableterm object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableyear integer nullablestarts_at integer nullableends_at integer nullableindividual_plan_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablefees array (default: [])@type string (default: "OpintopolkuFee")fee_type string nullableamount number nullablefee_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablehas_scholarship boolean nullablescholarship object nullable@type string (default: "OpintopolkuScholarship")min number nullablemax number nullableunit string nullabledescription object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_info array (default: [])@type string (default: "OpintopolkuSection")heading object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabletext object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableis_application_open boolean nullableuses_application_options boolean nullableapplication_period object nullable@type string (default: "OpintopolkuApplicationPeriod")starts_at integer nullableends_at integer nullableis_open boolean nullableis_past boolean nullableapplication_form_url object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableapplication_form_type string nullableapplication_term string nullableapplication_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableadmission_count integer (default: 0)admissions array (default: [])@type string (default: "OpintopolkuAdmissionSummary")id string requiredurl string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestatus string nullableapplication_round_id string nullableapplication_round_name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableapplication_method object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabletarget_group object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableapplication_periods array (default: [])@type string (default: "OpintopolkuApplicationPeriod")starts_at integer nullableends_at integer nullableis_open boolean nullableis_past boolean nullablestart object nullable@type string (default: "OpintopolkuStartTerm")start_type string nullableterm object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable (see schema OpintopolkuText)year integer nullablestarts_at integer nullableends_at integer nullableindividual_plan_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableplaces integer nullablefirst_timer_places integer nullableplaces_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableprior_education array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable (see schema OpintopolkuText)prior_education_info object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablevenue object nullable@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable (see schema OpintopolkuText)venue_full_name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablehas_athlete_vocational_training boolean nullableorganisation object nullable@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable (see schema OpintopolkuText)application_form_url object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableapplication_form_type string nullableapplication_form_id string nullableselection_criteria_id string nullablehas_selection_criteria_description boolean nullablescore_history array (default: [])@type string (default: "OpintopolkuScoreHistory")year integer nullablelowest_accepted_score number nullableplaces integer nullablefirst_choice_applicant_count integer nullableselection_method object nullable (see schema OpintopolkuCode)selection_queue_id string nullableapplication_round_id string nullableadmission_id string nullableadmission_code object nullable (see schema OpintopolkuCode)provider_id string nullablemodified_at integer nullableapplication_round_ids array (default: [])is_jotpa_funded boolean nullableis_labour_market_training boolean nullableis_continuing_education boolean nullableis_micro_credential boolean nullableis_open_university boolean nullableis_special_needs_education boolean nullableis_special_needs_vocational boolean nullableis_competence_demonstration boolean nullablecontacts array (default: [])@type string (default: "OpintopolkuContactPerson")name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabletitle object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableemail object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablephone object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablewebsite object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablewebsite_title object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableinstitution_ids array (default: [])providers array (default: [])@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableorganisation object nullable@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableorganisation_ids array (default: [])image string nullablelanguages array (default: [])modified_at integer nullableindexed_at integer 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 implementation is published under this 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.