Hämta data från Susa-navet
Du kan hämta ut EMIL-information från Susa-navet. Informationen du får ut kan du filtrera och forma på ett antal olika sätt. Här kan du läsa om hur du gör.
Så hämtar du EMIL-information från Susa-navet
För att kunna hämta ut och bearbeta informationen i EMIL behöver du ha ha kunskap om Svensk Standard SS10700 (EMIL) med avseende på typer, dokument, struktur och värdeförråd.
Skolverket erbjuder två API:er som kan användas för att hämta uppgifter ur Susa-navet. REST-API:et är det mer moderna, resultaten är här på JSON-format. Det äldre så kallade EMIL-API:et returnerar de XML-dokument som Susa-navets leverantörer har skapat.
Med API:erna kan du
- använda filter
- göra urval
- välja typ av dokument
- göra ämnessök.
Svenska Institutet för Standarders webbplats
Länk till annan webbplats, öppnas i nytt fönster.
API:er för att hämta uppgifter från Susa-navet Länk till annan webbplats, öppnas i nytt fönster.
REST-API:et
Detta API har ett så kallat Swagger-gränssnitt som utgör både dokumentation och utforskande funktioner. Alla olika anrop finns beskrivna och vilka argument de tar.
REST-API, Swagger Länk till annan webbplats, öppnas i nytt fönster.
Alla anordnare i Hedemora kommun (kommunkod 2083)
Länk till annan webbplats.
Alla anordnare för grundskola i Hedemora Länk till annan webbplats.
En specifik anordnare, utifrån dess ID Länk till annan webbplats.
Alla utbildningar som ges på finska Länk till annan webbplats.
Alla yrkesutbildningar Länk till annan webbplats.
Tre specifika utbildningar Länk till annan webbplats.
Utbildningstillfällen som erbjuds på distans Länk till annan webbplats.
Utbildningstillfällen vars titel innehåller ordet ”betong” Länk till annan webbplats.
Utbildningstillfällen för alla utbildningar som är märkta som ”program” Länk till annan webbplats.
Vissa egenskapers tillåtna värden styrs av en värdemängd. Värdena i en värdemängd kan frågas med ett anrop till /reference följt av värdemängdens namn. I beskrivningen av ett attribut står då till exempel ”Valid values obtained with /reference/educationLevel”.
EMIL-API:et
Ett anrop till någon av API-funktionerna skapar ett XHTML-dokument som innehåller länkar till de EMIL-dokument som finns lagrade i SUSA-navet. Om inga argument anges tas alla tillgängliga EMIL-dokument med. Normalt anger man ett eller flera filter för att få en mindre mängd dokument.
Att använda Susa-navets data
Exportfunktionen nås via HTTPS, filter och val anges som parametrar i URL:en.
Det finns två typer av argument: filter som begränsar urvalet och val av vilken typ av dokument man vill få ut (anordnare, utbildning, utbildningstillfälle).
De flesta filter påverkar endast en typ av dokument. Vilken typ som påverkas framgår av filtrets prefix. Filter med prefixet “EI” filtrerar utbildningar (educationInfo-dokument), filter med prefixet “EE” filtrerar utbildningstillfällen (educationEvent-dokument). Det finns inga filter för utbildningsanordnare.
Filter som saknar prefix filtrerar alla typer av dokument. Filter anges som ett eller flera URL-argument.
Varje angivet filter kontrollerar vilka EMIL-dokument som uppfyller filtret. Om flera filter används är det snittet av dessa dokumentmängder som ges som resultat.
Om ett filter för utbildningstillfällen finns angivet kommer exporten alltid att leverera utbildningstillfällen, oavsett om det finns infofilter angivna. Det beror på att det bildas två mängder för olika typer av dokument (utbildningar och utbildningstillfällen). Då snittet av dessa mängder alltid skulle vara tomt, konverteras automatiskt utbildningarna till tillhörande utbildningstillfällen.
Som exempel kommer följande filterkombination att ge utbildningstillfällen då det är ett eventfilter (EE) angett.
Exempel, utbildningstillfällen Länk till annan webbplats, öppnas i nytt fönster.
Om enbart filter som agerar på alla typer av dokument anges returneras alla typer.
Man kan välja vilken typ av dokument man vill få ut. Det finns tre val, ett för varje dokumenttyp: SelectEP (utbildningsanordnare), SelectEI (utbildning), SelectEE (utbildningstillfälle). Det går bara att välja typ av dokument om man har angett minst ett filter.
Som exempel kan man ange följande för att i nyss nämnda exempel få ut utbildningarna i stället för utbildningstillfällena:
Exempel, utbildningar Länk till annan webbplats, öppnas i nytt fönster.
Man kan även välja att få med refererande dokument av andra typer genom att ange detta som värden på Select-parametern. Detta anges med koderna EP, EI, EE.
Om man som exempel vill få ut utbildningarna i exemplet ovan och respektive utbildningsanordnare för de utbildningarna anger man:
Exempel, utbildningsanordnare Länk till annan webbplats, öppnas i nytt fönster.
Det går att kombinera flera referenskoder. Följande hämtar alla utbildningstillfällen som är på svenska samt respektive utbildningsinformation och utbildningsanordnare:
Exempel, flera villkor Länk till annan webbplats, öppnas i nytt fönster.
Ej utgångna dokument
NotExpired används för att välja ut EMIL-dokument som inte har passerat utgångsdatum. Om det här filtret inte används så finns dokument som är upp till 30 dagar efter utgångsdatum med i resultatet.
Exempel (varning, ger många svar) Länk till annan webbplats.
Uppdaterade sedan datum
UpdatedSince filtrerar fram dokument som uppdaterats sedan ett visst datum. Argumentet på formatet yyyy-mm-dd (år-månad-dag).
Exempel, uppdaterade sedan datum Länk till annan webbplats, öppnas i nytt fönster.
Distansutbildning
EEFormOfStudy väljer ut utbildningstillfällen som ges på distans eller inte. Filtret tar argument distance eller normal.
Exempel, distansutbildning Länk till annan webbplats, öppnas i nytt fönster.
Undervisningsspråk
EELanguage filtrerar utbildningstillfällen som ges på ett specifikt undervisningsspråk. Språkkoder skall specificeras enligt ISO 639-3 (treställiga språkkoder).
Exempel, undervisningsspråk Länk till annan webbplats, öppnas i nytt fönster.
Kommun
EEMunicipality är ett filter som visar utbildningstillfällen i en eller flera kommuner. Om man vill ange flera koder separeras de med kommatecken. Områden anges med fyrsiffrig kod för kommun eller sexsiffrig kod för kommun och stadsdel/kommundel enligt SCB.
Exempel, kommun Länk till annan webbplats, öppnas i nytt fönster.
Akademisk typ
EIAcademicType filtrerar på typ av skolform. Giltiga värden finns specificerade i EMIL:s värdeförråd OrganisationForm.
Aktuella möjliga värden
Öppnas i nytt fönster.
Exempel, akademisk typ Länk till annan webbplats, öppnas i nytt fönster.
Alla utbildningstillfällen
GetEvent listar alla utbildningstillfällen.
Exempel, alla utbildningstillfällen Länk till annan webbplats, öppnas i nytt fönster.
Alla utbildningar
GetInfo listar alla utbildningar.
Exempel, alla utbildningar Länk till annan webbplats, öppnas i nytt fönster.
Alla utbildningsanordnare
GetProvider listar alla utbildningsanordnare.
Exempel, alla utbildningsanordnare Länk till annan webbplats, öppnas i nytt fönster.
Alla dokument
Filtret GetAll är ett filter som enbart är till för att kombinera med urvalsargument (SelectNN). Det hämtar alla dokument oavsett typ.
Exempel, alla dokument Länk till annan webbplats, öppnas i nytt fönster.
Ämnessök mot Susa-navet
I Susa-navet finns ett ämnesträd som kan användas för att söka utbildningar utifrån en ämneshierarki. På den översta nivån finns cirka 20 ämnesområden. Varje område innehåller cirka 5–20 olika inriktningar, totalt cirka 200 inriktningar.
En inriktning är egentligen bara en samling av utbildningskoder eller ämnen (studievägskoder, programkoder, kurskoder). Inriktningen Arkeologi hör till ämnesområdet Kultur och humanistiska ämnen och innehåller fem olika utbildningskoder/ämnen. Ett ämne är i praktiken en utbildningskod enligt någon ämnesförteckning, som SUN eller en leverantörsspecifik lista. Varje ämne i Susa-navet anger därför dels själva utbildningskoden, dels enligt vilken ämnesförteckning.
Matchning sker mot egenskapen utbildningskod (code) i EMIL:s huvudklass educationInfo.
Ämnessök via API
Hämta listan över alla ämnesområden, api Länk till annan webbplats, öppnas i nytt fönster.
Av svaret framgår bl.a. ID, namn och en länk till ämnesområdets ingående inriktningar. Se exempel 1. Av svaret för ett områdes inriktningar framgår bl.a. ID, namn och en länk till inriktningens ingående ämnen. Se exempel 2.
Exempel 1 Länk till annan webbplats, öppnas i nytt fönster.
Exempel 2 Länk till annan webbplats, öppnas i nytt fönster.
Anrop om områdets utbildningstillfällen Länk till annan webbplats, öppnas i nytt fönster.
Anrop om användarna (bara) kan välja inriktningar Länk till annan webbplats, öppnas i nytt fönster.
Anrop om inriktningens utbildningstillfällen Länk till annan webbplats, öppnas i nytt fönster.
Har användaren valt flera ämnesområden eller inriktningar skickas alla ID:n med komma mellan i anropen, directionIds=78,123,154.
Versionshistorik
Detta API fanns i den första versionen av navet, följer EMIL-standarden och är bakåtkompatibelt.
Syftet är att tillhandahålla möjligheten för tredje part att ladda ned stora mängder information om lärosäten, kurser och kurstillfällen för att själv bearbeta och använda data lokalt. Den information som exponeras är densamma som navet själv hämtar från de olika leverantörerna av information, det vill säga EMIL-dokument.
Denna version av API togs fram 2013.
Syftet är att tillhandahålla all funktionalitet som behövs för att kunna bygga en applikation som på ett naturligt och enkelt sätt kan integrera och använda sig av den information som finns i navet. Det innehåller funktioner för att söka, lista och titta på detaljerad information om de resurser som hanteras, men också dokumentation om hur detta går till. Den information som returneras är en JSON-representation av EMIL-dokument och följer alltså inte det schema som styr hur ett EMIL-dokument ser ut.
Uppdaterad dokumentation och struktur av dokumentation.
Under år 2025 kommer en ny EMIL-standard att publiceras och därmed kommer Susa-navets API uppdateras. Mer information kommer.
Skolverkets arbete med öppen data
Arbetet med digitalisering sker inom Skolverket och i samarbete med flertalet myndigheter och andra organisationer. En del av arbetet är öppen data. Det är fritt att använda vår data som är tillgänglig för allmänheten. Utvecklare, forskare och andra intresserade kan bygga egna tjänster och ta fram statistik. Den data som är öppen gäller bland annat Susa-navet men även läroplaner, kurs- och ämnesplaner, skolenhetsregistret och studievägar.