{"swagger": "2.0", "basePath": "/", "paths": {"/v1/educations": {"get": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Endpoint for searching educations.", "operationId": "get_education_list_v1", "parameters": [{"name": "query", "in": "query", "type": "string", "description": "Free text search if provided. Otherwise retrieve all educations."}, {"name": "education_type", "in": "query", "type": "array", "description": "Filter on education type, e.g. program or kurs. See endpoint /v1/searchparameters/education_types for possible valid values.", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "education_form", "in": "query", "type": "array", "description": "Filter on education form, e.g. h\u00f6gskoleutbildning or yrkesh\u00f6gskoleutbildning. See endpoint /v1/searchparameters/education_forms for possible valid values.", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "municipality_code", "in": "query", "type": "string", "description": "Filter on 4 digit municipality code. See endpoint /v1/searchparameters/municipalities for possible valid values."}, {"name": "region_code", "in": "query", "type": "string", "description": "Filter on 2 digit region (l\u00e4n) code. See endpoint /v1/searchparameters/regions for possible valid values."}, {"name": "pace_of_study_percentage", "in": "query", "type": "string", "description": "Filter on pace of study percentage, e.g. 100"}, {"name": "education_code", "in": "query", "type": "string", "description": "Filter on education_code"}, {"name": "distance", "in": "query", "type": "boolean", "description": "Filter on educations that are at least partly from distance.", "default": false}, {"name": "filter_education_plan_exists", "in": "query", "type": "boolean", "description": "Filter on educations that has a scraped education plan. Intended for debug purpose.", "default": false}, {"name": "limit", "in": "query", "type": "integer", "description": "Number of results to fetch. Default value is 10."}, {"name": "offset", "in": "query", "type": "integer", "description": "The offset parameter defines the index for the first result item you want to fetch."}], "tags": ["Search educations"]}}, "/v1/educations/match-by-jobtitle": {"post": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "404": {"description": "Not found"}, "500": {"description": "Technical error"}}, "description": "Endpoint for matching educations for a taxonomy occupation conceptId.", "operationId": "post_match_educations_by_jobtitle_v1", "parameters": [{"name": "jobtitle", "in": "query", "type": "string", "required": true, "description": "Jobtitle according to the endpoint /v1/jobtitles/autocomplete"}, {"name": "education_type", "in": "query", "type": "array", "description": "Filter on education type, e.g. program or kurs. See endpoint /v1/searchparameters/education_types for possible valid values.", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "education_form", "in": "query", "type": "array", "description": "Filter on education form, e.g. h\u00f6gskoleutbildning or yrkesh\u00f6gskoleutbildning. See endpoint /v1/searchparameters/education_forms for possible valid values.", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "municipality_code", "in": "query", "type": "string", "description": "Filter on 4 digit municipality code. See endpoint /v1/searchparameters/municipalities for possible valid values."}, {"name": "region_code", "in": "query", "type": "string", "description": "Filter on 2 digit region (l\u00e4n) code. See endpoint /v1/searchparameters/regions for possible valid values."}, {"name": "distance", "in": "query", "type": "boolean", "description": "Filter on educations that are at least partly from distance.", "default": false}, {"name": "limit", "in": "query", "type": "integer", "description": "Number of results to fetch. Default value is 10.", "default": 10}, {"name": "offset", "in": "query", "type": "integer", "description": "The offset parameter defines the index for the first result item you want to fetch.", "default": 0}, {"name": "include_metadata", "in": "query", "type": "boolean", "description": "Return additional metadata. Defalt value is False.", "default": false}], "tags": ["Match educations"]}}, "/v1/educations/match-by-occupation": {"post": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "404": {"description": "Not found"}, "500": {"description": "Technical error"}}, "description": "Endpoint for matching educations for a taxonomy occupation conceptId.", "operationId": "post_match_educations_by_occupation_id_v1", "parameters": [{"name": "occupation_id", "in": "query", "type": "string", "required": true, "description": "Unique id for the occupation"}, {"name": "education_type", "in": "query", "type": "array", "description": "Filter on education type, e.g. program or kurs. See endpoint /v1/searchparameters/education_types for possible valid values.", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "education_form", "in": "query", "type": "array", "description": "Filter on education form, e.g. h\u00f6gskoleutbildning or yrkesh\u00f6gskoleutbildning. See endpoint /v1/searchparameters/education_forms for possible valid values.", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "municipality_code", "in": "query", "type": "string", "description": "Filter on 4 digit municipality code. See endpoint /v1/searchparameters/municipalities for possible valid values."}, {"name": "region_code", "in": "query", "type": "string", "description": "Filter on 2 digit region (l\u00e4n) code. See endpoint /v1/searchparameters/regions for possible valid values."}, {"name": "distance", "in": "query", "type": "boolean", "description": "Filter on educations that are at least partly from distance.", "default": false}, {"name": "limit", "in": "query", "type": "integer", "description": "Number of results to fetch. Default value is 10.", "default": 10}, {"name": "offset", "in": "query", "type": "integer", "description": "The offset parameter defines the index for the first result item you want to fetch.", "default": 0}, {"name": "include_metadata", "in": "query", "type": "boolean", "description": "Return additional metadata. Defalt value is False.", "default": false}], "tags": ["Match educations"]}}, "/v1/educations/{id}": {"parameters": [{"example": "i.sv.ft001", "in": "path", "description": "Unique Susa-Navet id for the education", "name": "id", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "404": {"description": "Not found"}, "500": {"description": "Technical error"}}, "description": "Endpoint for fetching education by id.", "operationId": "get_education_v1", "tags": ["Search educations"]}}, "/v1/enriched_occupations": {"get": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "404": {"description": "Not found"}, "500": {"description": "Technical error"}}, "description": "Endpoint for getting details for an enriched occupation.", "operationId": "get_enriched_occupations_details_v1", "parameters": [{"name": "occupation_id", "in": "query", "type": "string", "required": true, "description": "Unique id for the occupation according to Taxonomy concept_id"}, {"name": "include_metadata", "in": "query", "type": "boolean", "description": "Return additional metadata. Defalt value is False.", "default": false}], "tags": ["Match occupations"]}}, "/v1/jobtitles/autocomplete": {"get": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Endpoint for matching educations for a taxonomy occupation conceptId.", "operationId": "get_jobtitles_autocomplete_v1", "parameters": [{"name": "word", "in": "query", "type": "string", "required": true, "description": "Word or part of word to get autocompleted jobtitles for"}, {"name": "limit", "in": "query", "type": "integer", "description": "Number of results to fetch. Default value is 10.", "default": 10}], "tags": ["Match educations"]}}, "/v1/occupations/match-by-education": {"post": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "404": {"description": "Not found"}, "500": {"description": "Technical error"}}, "description": "Endpoint for matching occupations for an education id.", "operationId": "post_match_occupations_by_education_id_v1", "parameters": [{"name": "education_id", "in": "query", "type": "string", "required": true, "description": "Unique id for the education"}, {"name": "limit", "in": "query", "type": "integer", "description": "Number of results to fetch. Default value is 10.", "default": 10}, {"name": "offset", "in": "query", "type": "integer", "description": "The offset parameter defines the index for the first result item you want to fetch.", "default": 0}, {"name": "include_metadata", "in": "query", "type": "boolean", "description": "Return additional metadata. Defalt value is False.", "default": false}], "tags": ["Match occupations"]}}, "/v1/occupations/match-by-education-code": {"post": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "404": {"description": "Not found"}, "500": {"description": "Technical error"}}, "description": "Endpoint for matching occupations for an education id.", "operationId": "post_match_occupations_by_education_code_v1", "parameters": [{"name": "education_code", "in": "query", "type": "string", "required": true, "description": "Unique code for the education"}, {"name": "limit", "in": "query", "type": "integer", "description": "Number of results to fetch. Default value is 10.", "default": 10}, {"name": "offset", "in": "query", "type": "integer", "description": "The offset parameter defines the index for the first result item you want to fetch.", "default": 0}, {"name": "include_metadata", "in": "query", "type": "boolean", "description": "Return additional metadata. Defalt value is False.", "default": false}], "tags": ["Match occupations"]}}, "/v1/occupations/match-by-text": {"post": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Endpoint for matching occupations from a text that contains for example competencies or job titles.", "operationId": "post_match_occupations_by_text_v1", "parameters": [{"name": "input_text", "in": "query", "type": "string", "required": true, "description": "Text that contains for example competencies that one learns when studying."}, {"name": "input_headline", "in": "query", "type": "string", "description": "Text that contains the headline for the education."}, {"name": "limit", "in": "query", "type": "integer", "description": "Number of results to fetch. Default value is 10.", "default": 10}, {"name": "offset", "in": "query", "type": "integer", "description": "The offset parameter defines the index for the first result item you want to fetch.", "default": 0}, {"name": "include_metadata", "in": "query", "type": "boolean", "description": "Return additional metadata. Defalt value is False.", "default": false}], "tags": ["Match occupations"]}}, "/v1/searchparameters/education_forms": {"get": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Endpoint for getting valid education forms for filtering educations.", "operationId": "get_search_parameters_education_forms_v1", "tags": ["Search parameter values"]}}, "/v1/searchparameters/education_types": {"get": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Endpoint for getting valid education types for filtering educations.", "operationId": "get_search_parameters_education_types_v1", "tags": ["Search parameter values"]}}, "/v1/searchparameters/municipalities": {"get": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Endpoint for getting valid municipalities for filtering educations.", "operationId": "get_search_parameters_municipalities_v1", "tags": ["Search parameter values"]}}, "/v1/searchparameters/regions": {"get": {"responses": {"200": {"description": "OK"}, "400": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Endpoint for getting valid regions (l\u00e4n) for filtering educations.", "operationId": "get_search_parameters_regions_v1", "tags": ["Search parameter values"]}}}, "info": {"title": "JobEd Connect API", "version": "1.4.5 ", "description": "Endpoints for searching and matching related items in the labor market and the field of education"}, "produces": ["application/json"], "consumes": ["application/json"], "tags": [{"name": "Search educations", "description": "Search for educations"}, {"name": "Match occupations", "description": "Match related occupations by for example an education or by competence terms in a text"}, {"name": "Match educations", "description": "Match educations by for example an occupation or a job title"}, {"name": "Search parameter values", "description": "Search parameter values that should be used when filtering educations."}], "responses": {"ParseError": {"description": "When a mask can't be parsed"}, "MaskError": {"description": "When any error occurs on mask"}}}