Hämta EMIL 2.0-information från SUSA-navet

Transkript

1 Hämta EMIL 2.0-information från SUSA-navet Copyright 2013 Skolverket Februari 2013 Sammanfattning Det här dokumentet beskriver hur man hämtar EMIL-information från SUSA-navet. Informationen som lämnas ut går att filtrera och forma på ett antal olika sätt vilka beskrivs nedan. Det förutsätts att läsaren har kunskap om Svensk Standard SS och EMIL 2.0 med avseende på typer, dokument, struktur och värdeförråd. Översikt SUSA-navets exportfunktion sker via HTTP och XHTML. Ett anrop till funktionen skapar ett XHTML-dokument som innehåller länkar till EMIL-dokument som finns lagrade i navet. Om inga argument anges tas alla tillgängliga EMIL-dokument med. Normalt anger man ett eller flera filter för få en mindre mängd dokument som berör en viss domän som t.ex. högskoleutbildningar. Anropa SUSA-navets export Exportfunktionen nås via HTTP och filter och val anges som parametrar i URL:en. Använda filter Det finns två typer av argument: filter som begränsar urvalet och val av vilken typ av refererande dokument man vill få ut (provider / lärosäte, info / kurs, event / kurstillfä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 infodokument (kurser), filter med prefixet EE filtrerar eventdokument (kurstillfällen). Det finns inga filter för lärosäten. Filter som saknar prefix filtrerar alla typer av dokument. Filter anges som ett eller flera URL-argument. 1 (5)

2 Göra urval Varje angivet filter kontrollerar vilka EMIL-dokument som uppfyller filtret. Om flera filter används är det snittet av dessa dokumentmängder som skickas ut som resultat. Om ett eventfilter finns angivet kommer exporten alltid att leverera kurstillfällen, oavsett om det finns infofilter angivna. Det beror på att det bildas två mängder som inte berör samma värden (kurser och kurstillfällen). Då snittet av dessa mängder alltid skulle vara tomt, konverteras automatiskt kurserna till tillhörande kurstillfällen. Som exempel kommer följande filterkombination att skicka ut kurstillfällen då det är ett eventfilter (EE) angett.?eelanguage=swe&eiacademictype=högskoleutbildning Om enbart filter som agerar på alla typer av dokument anges skickar alla typer ut. Välja typ av dokument Man kan välja vilken typ av dokument man vill få ut. Det finns tre val, ett för varje dokumenttyp: SelectEP (lärosäte), SelectEI (kurs), SelectEE(kurstillfä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 kurserna i stället för kurstillfällena.?eelanguage=swe&eiacademictype=högskoleutbildning&selectei 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 kurserna i exemplet ovan och respektive lärosäte för de kurserna anger man:?eelanguage=swe&eiacademictype=högskoleutbildning&selectei=ep Det går att kombinera flera referenskoder. Följande hämtar alla kurstillfällen som är på svenska samt respektive kursinformation och lärosäte.?eelanguage=swe&selectee=ei,ep Tillgängliga filter Ej utgångna dokument NotExpired 2 (5)

3 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.?notexpired Uppdaterade sedan datum UpdatedSince=<yyyy mm dd> UpdatedSince används för att filtrera fram dokument som uppdaterats sedan ett visst datum. UpdatedSince tar ett datum som argument på formatet yyyy-mm-dd (år-månad-dag).?updatedsince= Distansutbildning EEFormOfStudy=[distance,normal] EEFormOfStudy är ett filter för att välja ut utbildningstillfällen som ges på distans eller inte. Filtret tar argument distance eller normal?eeformofstudy=distance?eeformofstudy=normal Undervisningsspråk EELanguage=[lang] EELanguage är ett filter för att välja kurstillfällen som ges på ett specifikt undervisningsspråk. Språkkoder skall specificeras enligt ISO (treställiga språkkoder).?eelanguage=swe Område EEMunicipality=<kod>[,<kod>[,...]] EEMunicipality är ett filter som visar kurstillfällen i ett visst område. Om man vill ange flera områden separeras de med kommatecken (,). Områden anges med fyrsiffrig kod för kommun eller sexsiffrig kod för kommun och stadsdel / kommundel enligt SCB. 3 (5)

4 ?EEMunicipality=1880,1890 Akademisk typ?eiacademictype=<typ>[,<typ>[,...]] EIAcademicType filtrerar på typ av skolform. Giltiga värden finns specificerade i EMIL 2.0 i värdeförrådet OrganisationForm.?EIAcademicType=Högskoleutbildning?EIAcademicType=Gymnasieskola,Högskoleutbildning Alla kurstillfällen GetEvent GetEvent listar alla kurstillfällen.?getevent Alla kurser GetInfo GetInfo listar alla kurser.?getinfo Alla lärosäten GetProvider GetProvider listar alla lärosäten.?getprovider Alla dokument GetAll Filtret GetAll är ett filter som enbart är till för att kombinera med urvalsargument (SelectNN). Det hämtar alla dokument oavsett typ. 4 (5)

5 ?GetAll&SelectEP=EI 5 (5)