Uppgifter om skolenheter, studievägar och statistik
Från api:et Planned educations API kan du hämta uppgifter om planerade utbildningstillfällen och information om de skolenheter som planerar att ge utbildningen. Det kan också finnas statistikuppgifter om skolenheter som anordnade utbildningen förra läsåret. En skolenhet kan också ha relaterade dokument i form av Skolinspektionens rapporter och skolenkäter.
Planned educations API
Format
Api:et är ett REST-api som returnerar data som JSON och i Swagger-format version 3.
Versionering
Tillgängliga versioner visas i Swagger-applikationen under "Select a definition". Eventuellt prefix i namnet beskriver status för versionen.
Observera att API:et kan svara med olika versioner vid olika tidpunkter, om inte önskad version anges i anropet.
Api:et använder HTTP-headern Sunset för att annonsera när nuvarande version slutar gälla och är otillgänglig.
Vid anrop till Api:et anges önskad version genom att skicka med en header.
application/vnd.skolverket.plannededucations.api.v3.hal+json
Api dokumentation
Här hittar ni alla våra endpoints i api samt dess repsonse-bodys vid olika http-statusar.
Utforska api:et genom Swagger-applikationen
Länk till annan webbplats, öppnas i nytt fönster.
Nedan är ett enkelt exempel på hur man kommer åt en endpoint och hur dess responsbody ser ut. Observera att detta är endast 1 exempel och att responsebodys skiljer sig åt mellan de olika endpointsen.
För att hämta en lista med skoleneheter kan ni anropa följande endpoint, då får ni en kompakt version av listan.
curl -X GET "https://api.skolverket.se/planned-educations/v3/compact-school-units?coordinateSystemType=WGS84&page=0&size=20" -H "accept: application/vnd.skolverket.plannededucations.api.v3.hal+json"
Nedan är responsbody för anropet ovan.
{ "body": { "content": [ { "abroadSchool": true, "coordinateSystemType": "string", "educationEventTypeOfSchooling": "string", "links": { "empty": true }, "schoolUnitCode": "string", "schoolUnitName": "string", "sweref99Latitude": "string", "sweref99Longitude": "string", "wgs84Latitude": "string", "wgs84Longitude": "string" } ], "links": { "empty": true }, "page": { "number": 0, "size": 0, "totalElements": 0, "totalPages": 0 } }, "links": { "empty": true }, "message": "string", "status": "ACCEPTED" }
v1 - version 1 (avvecklades 30 april 2021)
För version 1 ange headern accept: application/json samt headern X-API-Version: v1
deprecated-v2 - version 2, under avveckling (2023)
För version 2 ange headern accept: application/vnd.skolverket.plannededucations.api.v2.hal+json
stable-v3 - version 3, stabil version som är under utveckling och där förändringar kan ske oannonserat.
För version 3 ange headern accept: application/vnd.skolverket.plannededucations.api.v3.hal+json
Begreppsförklaringar
Hur insamling av statistikuppgifterna går till och hur de redovisas samt förklaring av olika begrepp som ofta förekommer i redovisningen av statistiken hittar du här.
Förklaring av statistikinsamling och olika begrepp
Variabellista med beskrivningar av de variabler som finns i api:et
Excel, 62 kB.
