Tjänstebeskrivning T22

Tjänstebeskrivning T22 Hjälptjänst Ladok på webb

Ändringshistorik Datum Av Kommentar Granskare Godkännare 2004-09-16 Matilda Östling Första versionen - - 2005-06-08 Therese Hermansson Lagt till deltjänster för utsökning av institution samt uppdaterat felmeddelandehanteringen 2005-12-01 Johan Forssell Lagt till deltjänst för utsökning av institution mha. delkod 2007-01-03 Johan Forssell Lagt till deltjänst för utsökning av högskolor. 2007-01-12 Johan Forssell Förtydligad information om söktermer i findhsk() 2007-03-06 Anders Bergström Åtgärd 16423: Uppdaterat felmeddelanden. 2007-08-29 Kristoffer From Åtgärd 13672: Sök person på del av personnummer 2009-01-30 Magnus Uddstal Tilläg av metod för att hämta nuvarande termin och nästa 2009-02-04 Andreas Hed Tillägg av metod för hämtning av kurstillfällen och hämtning av kursinformation Namnbyte på dokumentet från hämta_namn till katalogtjänst 2011-02-23 Erik Andersson Tillägg av metod för hämtning av prov tillhörande kurs. 2011-03-30 Magnus Uddstål Tillägg av metod för att hämta alla Orter från ORT som inte är nedlagda 2011-04-01 Magnus Uddstål Tillägg av metod för att hämta alla institutioner 2011-05-04 Magnus Uddstål Tillägg av metod för att hämta adressuppgifter för ett antal personer 2014-12-09 Thom Jönsson Tillägg av metoder för utsökning av personer på del av personnummer eller namn tehn 2015-08-11 Rikard Skelander Uppdaterat beskrivningen av metoden för att hämta innevarande termin som nu också returneras start- och slutdatum för undervisning 2015-10-19 Thom Jönsson Korrigerad information i kapitel 16.

2016-08-24 Håkan Lindgren Lagt till metod för att hämta huvudområde och fördjupning för given kurskod. 2016-10-12 Thom Jönsson Lagt till metod för att hämta provuppsättningsterminer och sortera in prov efter dessa.

Matilda Östling, Johan Forssell 2017-05-11 4 (49) Innehållsförteckning 1 INLEDNING... 8 1.1 SYFTE... 8 1.2 MÅLGRUPP... 8 1.3 BESKRIVNING... 8 1.3.1 Deltjänster... 8 2 HÄMTA NAMN MED KONTROLLER... 10 2.1 BESKRIVNING... 10 2.1.1 Flödesbeskrivning... 10 2.1.2 Tabellförändringar... 10 2.2 BEHÖRIGHETSANALYS... 10 2.3 TABELLER SOM ANVÄNDS AV TJÄNSTEN... 11 2.4 EXPONERADE METODER... 11 2.5 INDATA... 11 2.5.1 Kontroller... 12 2.6 UTDATA... 12 2.7 FELHANTERING... 12 3 HÄMTA INSTITUTION... 13 3.1 SYFTE... 13 3.2 BESKRIVNING... 13 3.2.1 Inställningar... 13 3.3 KRAVLISTA... 13 3.4 INDATA... 13 3.5 UTDATA... 13 3.5.1 Felhantering... 14 4 SÖK INSTITUTION MED DEL AV INSTITUTIONSKOD... 15 4.1 SYFTE... 15 4.2 BESKRIVNING... 15 4.2.1 Inställningar... 15 4.3 KRAVLISTA... 15 4.4 INDATA... 15 4.5 UTDATA... 15 4.5.1 Felhantering... 16 5 SÖK INSTITUTION MED BENÄMNING... 17 5.1 SYFTE... 17 5.2 BESKRIVNING... 17 5.2.1 Inställningar... 17 5.3 KRAVLISTA... 17 5.3.1 Krav 1 Sök institutioner... 17 5.4 INDATA... 17 5.5 UTDATA... 17 5.5.1 Felhantering... 18 6 SÖK INSTITUTION MED ENGELSK BENÄMNING... 18 6.1 SYFTE... 18 6.2 BESKRIVNING... 18

Matilda Östling, Johan Forssell 2017-05-11 5 (49) 6.2.1 Inställningar... 18 6.2.2 Sorteringsordning... 18 6.3 KRAVLISTA... 18 6.3.1 Krav 1 Sök institutioner... 18 6.4 INDATA... 19 6.5 UTDATA... 19 6.5.1 Felhantering... 19 7 HÄMTA HÖGSKOLOR... 20 7.1 SYFTE... 20 7.2 BESKRIVNING... 20 7.2.1 Sorteringsordning... 20 7.3 METODER... 20 7.4 KRAVLISTA... 20 7.4.1 Krav 1 Hämta högskolor... 20 7.4.2 Krav 2 Sök högskolor efter kod... 20 7.4.3 Krav 3 Sök högskolor efter benämning... 20 7.4.4 Krav 4 Sök högskolor efter engelsk benämning... 21 7.5 INDATA... 21 7.6 UTDATA... 21 7.6.1 Felhantering... 22 8 SÖK PERSON PÅ DEL AV PERSONNUMMER... 22 8.1 SYFTE... 22 8.2 BESKRIVNING... 22 8.2.1 Flödesbeskrivning... 23 8.2.2 Tabellförändringar... 23 8.3 METODER... 23 8.4 BEHÖRIGHETSANALYS... 23 8.5 KRAVLISTA... 23 8.5.1 Krav 1 Kontrollera att användaren har rätt behörighet... 23 8.5.2 Krav 2 - Kontrollera att personnumret är korrekt... 23 8.5.3 Krav 3 Sök studenter baserade på personnumret... 23 8.6 INDATA... 24 8.6.1 Kontroller... 24 8.7 UTDATA... 24 8.7.1 Felhantering... 24 9 HÄMTA INNEVARANDE TERMIN... 25 9.1 SYFTE... 25 9.2 BESKRIVNING... 25 9.3 KRAVLISTA... 25 9.4 EXPONERADE METODER... 25 9.5 INDATA... 25 9.6 UTDATA... 25 9.7 TJÄNSTESPECIFIKA FELMEDDELANDEN... 26 10 HÄMTA KURSTILLFÄLLEN... 27 10.1 SYFTE... 27 10.2 BESKRIVNING... 27 10.2.1 Flödesbeskrivning... 27 10.2.2 Tabellförändringar... 27 10.3 METODER... 27 10.4 BEHÖRIGHETSANALYS... 27

Matilda Östling, Johan Forssell 2017-05-11 6 (49) 10.5 KRAVLISTA... 27 10.6 EXPONERADE METODER... 28 10.7 INDATA... 28 10.8 UTDATA... 28 10.9 TJÄNSTESPECIFIKA FELMEDDELANDEN... 29 11 HÄMTA KURSINFORMATION... 30 11.1 SYFTE... 30 11.2 BESKRIVNING... 30 11.2.1 Flödesbeskrivning... 30 11.2.2 Tabellförändringar... 30 11.3 METODER... 30 11.4 BEHÖRIGHETSANALYS... 30 11.5 KRAVLISTA... 30 11.6 EXPONERADE METODER... 31 11.7 INDATA... 31 11.8 UTDATA... 31 11.9 TJÄNSTESPECIFIKA FELMEDDELANDEN... 32 12 HÄMTA PROV... 32 12.1 SYFTE... 32 12.2 BESKRIVNING... 32 12.2.1 Inställningar... 32 12.2.2 Metoder... 32 12.3 KRAVLISTA... 32 12.4 INDATA... 32 12.5 UTDATA... 33 12.6 TJÄNSTESPECIFIKA FELMEDDELANDEN... 33 13 HÄMTA ORT... 34 13.1 SYFTE... 34 13.2 BESKRIVNING... 34 13.2.1 Inställningar... 34 13.2.2 Metoder... 34 13.3 KRAVLISTA... 34 13.4 INDATA... 34 13.5 UTDATA... 34 13.6 TJÄNSTESPECIFIKA FELMEDDELANDEN... 35 14 HÄMTA ALLA INSTITUTIONER... 35 14.1 SYFTE... 35 14.2 BESKRIVNING... 35 14.2.1 Inställningar... 35 14.2.2 Metoder... 35 14.3 KRAVLISTA... 36 14.4 INDATA... 36 14.5 UTDATA... 36 14.6 TJÄNSTESPECIFIKA FELMEDDELANDEN... 36 15 HÄMTA ADRESSUPPGIFTER... 37 15.1 SYFTE... 37 15.2 BESKRIVNING... 37 15.2.1 Inställningar... 37 15.2.2 Metoder... 37

Matilda Östling, Johan Forssell 2017-05-11 7 (49) 15.3 KRAVLISTA... 37 15.4 INDATA... 37 15.5 UTDATA... 37 15.6 TJÄNSTESPECIFIKA FELMEDDELANDEN... 38 16 HÄMTA KURS PÅ INSTITUTION... 39 16.1 SYFTE... 39 16.2 BESKRIVNING... 39 16.2.1 Inställningar... 39 16.2.2 Metoder... 39 16.3 KRAVLISTA... 39 16.4 INDATA... 39 16.5 UTDATA... 39 16.6 TJÄNSTESPECIFIKA FELMEDDELANDEN... 41 17 SÖK PERSON PÅ DEL AV PERSONNUMMER ELLER NAMN... 42 17.1 SYFTE... 42 17.2 BESKRIVNING... 42 17.2.1 Sökning med asterisk... 42 17.2.2 Flödesbeskrivning... 42 17.2.3 Tabellförändringar... 43 17.3 BEHÖRIGHET... 43 17.4 EXPONERADE METODER... 43 17.5 INDATA... 43 17.5.1 Utsökning av student på grund- och avancerad nivå... 43 17.5.2 Utsökning av forskarstudent... 44 17.5.3 Begränsa antalet sökträffar... 45 17.6 UTDATA... 45 17.6.1 Felhantering... 46 17.7 TJÄNSTESPECIFIKA FELMEDDELANDEN... 46 17.8 GENERELLA FELMEDDELANDEN... 47 18 HÄMTA HUVUDOMRÅDE OCH FÖRDJUPNING... 47 18.1 SYFTE... 47 18.2 BESKRIVNING... 47 18.3 METODER... 47 18.4 INDATA... 47 18.5 UTDATA... 48 18.5.1 Felhantering... 48 19 HÄMTA PROVUPPSÄTTNINGSTERMINER... 48 19.1 SYFTE... 48 19.2 BESKRIVNING... 48 19.3 METODER... 49 19.4 INDATA... 49 19.5 UTDATA... 49 19.5.1 Felhantering... 49

Matilda Östling, Johan Forssell 2017-05-11 8 (49) 1 Inledning 1.1 Syfte Detta dokument skall, på en teknisk nivå, beskriva hjälptjänsten katalogtjänst. Med denna hjälptjänst kan man hämta diverse kataloguppgifter från Ladok. Fullständigt namn och status för student. Namn och information på institution. Namn och kod på högskolor. Hämtning av aktuell termin samt nästa. Kursinformation givet kurskod. Kurstillfällen givet kurskod. Prov givet kurskod Orter Adressuppgifter 1.2 Målgrupp Dokumentet vänder sig till kravansvariga, portalutvecklare och driftspersonal på universitet och högskolor. 1.3 Beskrivning Med denna tjänst kan enklare uppgifter hämtas ur Ladoks databas, såsom namn på en student, institution eller högskola. 1.3.1 Deltjänster Varje deltjänst motsvarar ett anrop till systemet. Krav Nr Deltjänst Målgrupp Prio Status 1 Hämta namn (med kontroller) Personal 0 Levererad 2 Hämta institution Personal 0 Levererad 3 Sök institution med benämning Personal 0 Levererad 4 Sök institution med engelsk benämning Personal 0 Levererad 5 Hämta högskolor Student 0

Matilda Östling, Johan Forssell 2017-05-11 9 (49) Krav Nr Deltjänst Målgrupp Prio Status 6 Sök högskola på kod Studenter 0 7 Sök högskola på benämning Studenter 0 8 Sök högskola på engelsk benämning Studenter 0 9 Sök person på del av personnummer Personal 0 10 Hämta innevarande termin Studenter,Pe rsonal 11 Hämta kurstillfällen Personal, Studenter 12 Hämta kursinformation Personal, Studenter 13 Hämta prov Personal, Studenter 14 Hämta orter Personal Studenter 15 Hämta institutioner Personal, Studenter 16 Sök kurser på institution Personal, Studenter 17 Sök person på del av personnummer eller namn 18 Hämta huvudområde och fördjupning Personal, Studenter Personal, Studenter 19 Hämta provuppsättningsterminer Personal, Studenter 0

Matilda Östling, Johan Forssell 2017-05-11 10 (49) 2 Hämta namn med kontroller 2.1 Beskrivning Denna deltjänst hämtar för- och efternamn utifrån angivet personnummer samtidigt som kontroller av personnumret görs samt studentens status fastställs. Formatkontroll av personnumret: Längden exakt 10 tecken. Samtliga positioner utom sjunde ska innehålla en siffra. Kontrollerar att sex första positionerna är ett giltigt datum. Kontrollsiffran (sista siffran) kontrolleras med hjälp av checksumma. Status av studenten: Kontrollerar om studenten har bytt personnummer. Kontrollerar om studenten är individuellt gallrad. Kontrollerar om studenten är gallrad. Kontrollerar om studenten är avliden. 2.1.1 Flödesbeskrivning Exempel på hur flödet kan se ut i hjälptjänsten hämta_namn: 1. Studenten/läraren väljer tjänsten i högskolans portal 2. Portalen anropar hjälptjänsten hämta_namn. 3. Om portalanvändaren är en student personnumret kontrolleras och status hämtas vartefter resultatet visas av portalen. Om portalanvändaren är en lärare - läraren får ange ett personnummer som sedan kontrolleras. Status och namn på studenten visas sedan av portalen. 2.1.2 Tabellförändringar Tjänsten innebär inga tabellförandringar. 2.2 Behörighetsanalys Studenten måste vara etablerad i Ladok och kan endast se sin egen information. Läraren måste vara behörig och utföra uppslagningar om olika studenter.

Matilda Östling, Johan Forssell 2017-05-11 11 (49) 2.3 Tabeller som används av tjänsten För att se vilka tabeller som tjänsten använder sig av se dokument Tabellsäkerhet.doc, 126-011. Kravlista Beskrivning Tabell Prio 1 2 Kontrollera att personnumret är korrekt. 0 Kontrollera om personen bytt personnummer GAMMALNY 0 3 4 5 Kontrollera om personen är individuellt gallrad Kontrollera om personen är gallrad (samt hämta namn) Hämta namn samt kontrollera om personen är avliden IGALLRAD 0 GALLRAD 0 NAMN 0 Samtliga krav är utvecklade. 2.4 Exponerade metoder UtilityNamnVO findnamebypnr(uservo uvo, UtilityNamnVO unamnvo) 2.5 Indata Värdeobjekt Data Kontroll Kommentar UserVO uvo Se dokumentet generell indata UtilityNamnVO unamnvo Kontroll av pnr Personnumret i UtilityNamnVO måste sättas av portalen.

Matilda Östling, Johan Forssell 2017-05-11 12 (49) 2.5.1 Kontroller 1. Formatkontroll, exakt 10 tecken. 2. Alla tecken siffror, utom eventuellt på sjunde position. 3. Första sex positionerna ett korrekt datum. 4. Kontrollsiffran (sista siffran) korrekt. 2.6 Utdata Värdeobjekt Data Format Kommentar UtilityNamnVO valid messages Information tillhörande studenten. True/False Om denna är falsk finns det felmeddelanden i messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc pnr C(10) Innehåller det pnr som skickats in i tjänsten. Om personen bytt pnr innehåller denna parameter det nya pnr:et. tnamn C(25) Förnamnet. enamn C(25) Efternamnet. hasnewpnr Boolsk Personen har bytt personnummer. igallrad Boolsk Personen är individuellt gallrad. gallrad Boolsk Personen är gallrad. igallraddatum C(10) gallraddatum C(10) 2.7 Felhantering Datumet för individuell gallring. Datumet för gallring. inladok Boolsk Personen finns i LADOK:s namntabell. avliden Boolsk Personen är avliden. Om det angivna personnumret som inparameter inte är korrekt sätts valid till false och ett meddelande finns i Message. Detta inträffar om personnumret har fel format eller inte är logiskt korrekt. Felmeddelandet sätts i UtilityNamnVO som returneras. För information om felmeddelandena se Message.doc

Matilda Östling, Johan Forssell 2017-05-11 13 (49) 3 Hämta institution 3.1 Syfte I denna tjänst hämtas en institution givet en institutionskod. 3.2 Beskrivning Tjänsten hämtar benämning, gatuadress, postnummer, ort, telefon samt engelsk benämning givet en institutionskod. Följande kontroller görs på koden Ej null Ej blank Ej längre än 4 tecken 3.2.1 Inställningar Inga. 3.3 Kravlista Hämta all information om institutionen från tabellen INST 3.4 Indata UtilityInstitutionVO Parameter Format Kontroll Tvättning Kod C(4) Ej null, ej blank, maxlängd 4 3.5 Utdata UtilityInstitutionVO Parameter Format Kommentar Kod C(4) Innehåller den institutionskod som är unik för varje institution. Benamn C(40) Institutionens benämning Gatadr C(30) Institutionens gatuadress Postnr C(6) Institutionens postnummer

Matilda Östling, Johan Forssell 2017-05-11 14 (49) Ort C(24) Institutionens ort Telefon C(12) Institutionens telefon Benamne C(40) Institutionens engelska namn valid boolsk Om denna är false finns felmeddelande i messages Messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc 3.5.1 Felhantering Konstant utility.institutionnotfound Nivå Kommentar Error Institutionen kunde inte hittas. Det kan även förekomma generella felmeddelanden från t ex validering och autenticering. Se dokumentet Message.doc för information om dessa.

Matilda Östling, Johan Forssell 2017-05-11 15 (49) 4 Sök institution med del av institutionskod 4.1 Syfte I denna tjänst hämtas en eller flera institutioner givet del av institutionskod. 4.2 Beskrivning Tjänsten hämtar benämning, gatuadress, postnummer, ort, telefon samt engelsk benämning givet institutionskod eller del av institutionskod. Angiven delkod används som start på det sökord som slår i databasen. Delkod 35 kommer t.ex. att hitta instutionskod 350. En array av träffar returneras. Följande kontroller görs på koden Ej null Ej blank Ej längre än 4 tecken 4.2.1 Inställningar Inga. 4.3 Kravlista Hämta all information om institutionen från tabellen INST 4.4 Indata UtilityInstitutionVO Parameter Format Kontroll Tvättning Kod C(4) Ej null, ej blank, maxlängd 4 4.5 Utdata UtilityInstitutionVO[] Parameter Format Kommentar Kod C(4) Innehåller den institutionskod som är unik för varje institution. Benamn C(40) Institutionens benämning

Matilda Östling, Johan Forssell 2017-05-11 16 (49) Gatadr C(30) Institutionens gatuadress Postnr C(6) Institutionens postnummer Ort C(24) Institutionens ort Telefon C(12) Institutionens telefon Benamne C(40) Institutionens engelska namn valid boolsk Om denna är false finns felmeddelande i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc 4.5.1 Felhantering Konstant utility.institutionnotfound Nivå Kommentar Error Institutionen kunde inte hittas. Det kan även förekomma generella felmeddelanden från t ex validering och autenticering. Se dokumentet Message.doc för information om dessa.

Matilda Östling, Johan Forssell 2017-05-11 17 (49) 5 Sök institution med benämning 5.1 Syfte I denna tjänst söks institutioner fram på dess svenska benämning 5.2 Beskrivning Tjänsten hämtar benämning, gatuadress, postnummer, ort, telefon samt engelsk benämning givet en sträng som matchas mot institutionernas svenska benämning. En array av träffar returneras. 5.2.1 Inställningar Inga. 5.3 Kravlista 5.3.1 Krav 1 Sök institutioner Sök institutioner från INST givet en söksträng som matchas benamn 5.4 Indata UtilityInstitutionVO Parameter Format Kontroll Tvättning Benamn C(40) - 5.5 Utdata UtilityInstitutionVO[] Parameter Format Kommentar Kod C(4) Innehåller den institutionskod som är unik för varje institution. Benamn C(40) Institutionens benämning Gatadr C(30) Institutionens gatuadress Postnr C(6) Institutionens postnummer

Matilda Östling, Johan Forssell 2017-05-11 18 (49) Ort C(24) Institutionens ort Telefon C(12) Institutionens telefon Benamne C(40) Institutionens engelska namn valid boolsk Om denna är false finns felmeddelande i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc 5.5.1 Felhantering Konstant utility.institutionnotfound Nivå Kommentar Error Institutionen kunde inte hittas. Det kan även förekomma generella felmeddelanden från t ex validering och autenticering. Se dokumentet Message.doc för information om dessa. 6 Sök institution med engelsk benämning 6.1 Syfte I denna tjänst söks institutioner fram på dess engelska benämning 6.2 Beskrivning Tjänsten hämtar benämning, gatuadress, postnummer, ort, telefon samt engelsk benämning givet en sträng som matchas mot institutionernas engelska benämning. En array av träffar returneras. 6.2.1 Inställningar Inga. 6.2.2 Sorteringsordning Inga. 6.3 Kravlista 6.3.1 Krav 1 Sök institutioner Sök institutioner från INST givet en söksträng som matchar benamne

Matilda Östling, Johan Forssell 2017-05-11 19 (49) 6.4 Indata UtilityInstitutionVO select * from INST where upper(benamne) like upper( %pharmacy% ); Parameter Format Kontroll Tvättning Benamne C(40) - 6.5 Utdata UtilityInstitutionVO[] Parameter Format Kommentar Kod C(4) Innehåller den institutionskod som är unik för varje institution. Benamn C(40) Institutionens benämning Gatadr C(30) Institutionens gatuadress Postnr C(6) Institutionens postnummer Ort C(24) Institutionens ort Telefon C(12) Institutionens telefon Benamne C(40) Institutionens engelska namn valid boolsk Om denna är false finns felmeddelande i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc 6.5.1 Felhantering Konstant utility.institutionnotfound Nivå Kommentar Error Institutionen kunde inte hittas. Det kan även förekomma generella felmeddelanden från t ex validering och autenticering. Se dokumentet Message.doc för information om dessa.

Matilda Östling, Johan Forssell 2017-05-11 20 (49) 7 Hämta högskolor 7.1 Syfte I denna tjänst hämtas uppgifter om högskolor. 7.2 Beskrivning Tjänsten hämtar kod, benämning och engelsk benämning på högskolor från tabellen ALLAHSK. Det är möjligt att söka på kod, benämning eller engelsk benämning. En array av träffar returneras. 7.2.1 Sorteringsordning Sorteringsordningen sker på de termer som angivits i sökningen. Anges flera termer sorteras resultaten efter kod. Anges inga termer sorteras resultatet efter benämning. 7.3 Metoder /** * Hämtar högskolor från ALLAHSK. * @param uvo För autentisering och auktorisering * @param search_terms Fyll i kod, benämning eller engelsk benämning. * Det är möjligt att söka med flera termer samtidigt. * @return Lista med högskolor. */ public UtilityHskVO[] findhsk(uservo uvo, UtilityHskVO search_terms) 7.4 Kravlista Tjänsten beskrivs av följande krav. 7.4.1 Krav 1 Hämta högskolor Hämta alla högskolor från ALLAHSK sorterade på benämning. 7.4.2 Krav 2 Sök högskolor efter kod Hämta vissa högskolor begränsade på kod, sorterade på kod. Det går bra att ange del av kod, och den är inte skiftlägeskänslig. 7.4.3 Krav 3 Sök högskolor efter benämning Hämta vissa högskolor från ALLAHSK sorterade på benämning. Det går bra att ange del av benämning, och den är inte skiftlägeskänslig.

Matilda Östling, Johan Forssell 2017-05-11 21 (49) 7.4.4 Krav 4 Sök högskolor efter engelsk benämning Hämta vissa högskolor från ALLAHSK sorterade på engelsk benämning. Det går bra att ange del av benämning och den är inte skiftlägeskänslig. 7.5 Indata UtilityHskVO Parameter Format Kontroll Tvättning kod C(3) 1-3 tecken benamn C(45) Högskolans benämning benamne C(60) Högskolans engelska benämning 1. Det går att söka på del av kod, del av benämning och del av engelsk benämning. 2. Om mindre än 3 tecken anges för koden så kommer angivna tecken att matchas mot början av koden. 3. Inga söktermer är skiftlägeskänsliga. 4. Om inga parametrar sätts så kommer alla poster från ALLAHSK att returneras. a. Om kod är satt så kommer endast matchning mot kod att ske. b. Om benamn är satt (men inte kod) så kommer matchning mot benamn att ske. c. Om benamne är satt (men varken kod eller benamn) så kommer matchning mot benamne att ske. 7.6 Utdata UtilityHskVO[] Parameter Format Kommentar kod C(3) Kod unik för varje högskola benamn C(45) Högskolans benämning benamne C(60) Högskolans engelska namn valid boolsk Om denna är false finns felmeddelande i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc

Matilda Östling, Johan Forssell 2017-05-11 22 (49) 7.6.1 Felhantering Konstant utility.allahskempty Nivå Kommentar Fatal Ingen data hittades i ALLAHSK. Det kan även förekomma generella felmeddelanden från t ex validering och autenticering. Se dokumentet Message.doc för information om dessa. 8 Sök person på del av personnummer 8.1 Syfte I denna tjänst kan personal söka student på delvis känt personnummer. 8.2 Beskrivning Denna deltjänst hämtar personnummer samt för- och efternamn utifrån angiven del av personnummer samtidigt som kontroller av indata görs samt studenternas status fastställs. Formatkontroll av personnumret: Längden skall max vara 10 tecken utöver bindestreck. Samtliga positioner utom eventuellt sjunde ska innehålla en siffra. Sjunde positionen skall innehålla en siffra eller bokstaven T. Tillåter ett (1) bindestreck, i.e. ÅÅMMDD-XXXX Kontrollsiffran (sista siffran) kontrolleras med hjälp av checksumma. Status av studenten: Kontrollerar om studenten har bytt personnummer. Kontrollerar om studenten är individuellt gallrad. Kontrollerar om studenten är gallrad. Kontrollerar om studenten är avliden.

Matilda Östling, Johan Forssell 2017-05-11 23 (49) 8.2.1 Flödesbeskrivning Exempel på hur flödet kan se ut i hjälptjänsten Sök person på del av personnummer : 1. Studenten/läraren väljer tjänsten i högskolans portal 2. Portalen anropar hjälptjänsten Sök person på del av personnummer. 3. Om portalanvändaren är en student neka åtkomst till tjänsten Om portalanvändaren är en lärare - läraren får ange början av ett personnummer som sedan kontrolleras. En lista av namn på matchande studenter visas sedan av portalen. 8.2.2 Tabellförändringar Tjänsten innebär inga tabellförändringar. 8.3 Metoder /** * Hämtar information om de studenter vars personnummer matchar söksträngen * i UtilityNamnVO * @param uservo För autentisering och auktorisering * @param unamnvo Innehåller söksträng som personnummer * @return Lista med matchande studenter. */ public UtilityNamnListVO getnamebypartpnr(uservo uservo, UtilityNamnVO unamnvo) 8.4 Behörighetsanalys Läraren måste vara behörig och utföra uppslagningar om olika studenter. 8.5 Kravlista Tjänsten beskrivs av följande krav. 8.5.1 Krav 1 Kontrollera att användaren har rätt behörighet Endast personal får använda söktjänsten. 8.5.2 Krav 2 - Kontrollera att personnumret är korrekt Sökning genomförs endast om träffar kan existera. 8.5.3 Krav 3 Sök studenter baserade på personnumret Hämta de studenter från NAMN vars personnummer matchar söksträngen.

Matilda Östling, Johan Forssell 2017-05-11 24 (49) 8.6 Indata Värdeobjekt Data Kontroll Kommentar UserVO uservo Se dokumentet generell indata UtilityNamnVO unamnvo Kontroll av pnr Personnumret i UtilityNamnVO måste sättas av portalen. 8.6.1 Kontroller 5. Formatkontroll, det skall max vara 10 tecken utöver bindestreck. 6. Alla tecken är siffror, utom eventuellt på sjunde position. 7. Sjunde positionen skall innehålla en siffra eller bokstaven T. 8. Tillåter ett (1) bindestreck, i.e. ÅÅMMDD-XXXX 9. Kontrollsiffran (sista siffran) är korrekt. 8.7 Utdata Värdeobjekt Data Format Kommentar UtilityNamnListVO Information tillhörande studenter valid True/False Om denna är falsk finns det felmeddelanden i messages messages Message[] names 8.7.1 Felhantering Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc UtilityNamnVO[] En array med information om de studenter som matchar söksträngen Om det angivna personnumret som inparameter inte är korrekt sätts valid till false och ett meddelande finns i Message. Detta inträffar om personnumret har fel format eller inte är logiskt korrekt. Felmeddelandet sätts i UtilityNamnListVO som returneras. För information om felmeddelandena se Message.doc

Matilda Östling, Johan Forssell 2017-05-11 25 (49) 9 Hämta innevarande termin 9.1 Syfte I denna deltjänst visas innevarande termin och terminen som kommer efter innevarande termin samt start- och slutdatum för undervisning för dessa. Den termin som studenten väljer används sedan som indata till nästa steg. 9.2 Beskrivning Systemet läser upp/räknar fram o Innevarande termin samt dess start- och slutdatum för undervisning o Terminen efter innevarande samt dess start- och slutdatum för undervisning Den termin som studenten väljer används av systemet i nästa deltjänst för att hämta förslag på termins- och kursregistreringar. I normala fall rör det sig om innevarande termin. 9.3 Kravlista Krav Nr Beskrivning Tabell/Vy Prio 1. Visa innevarande termin samt räkna ut nästkommande termin EGENHSK 0 Alla krav är utvecklade. 9.4 Exponerade metoder getcurrandnextsemester (UserVO uvo) 9.5 Indata Värdeobjekt Data Format Kontroll Kommentar UserVO uvo Se dokumentet Generell indata 9.6 Utdata Utdata utgörs av innevarande och nästkommande termin samt deras start- och stopdatum för undervisning som är satta i värdeobjektet UtilitySemesterVO

Matilda Östling, Johan Forssell 2017-05-11 26 (49) Värdeobjekt Data Format Kontroll Kommentar UtilitySemest ervo currentsemester C(3) TÅÅ - Innevarande termin currentsemesterundervisn ingfrom currentsemesterundervisn ingtom ÅÅÅÅ-MM-DD - ÅÅÅÅ-MM-DD - nextsemester C(3) TÅÅ - nextsemesterundervisning ÅÅÅÅ-MM-DD From nextsemesterundervisning Tom ÅÅÅÅ-MM-DD Innevarande termin, startdatum för undervisning Innevarande termin, slutdatum för undervisning Kommande termin, startdatum för undervisning Kommande termin, slutdatum för undervisning valid Boolsk Om denna är falsk finns det felmeddelanden i messages messages Message[] - Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message 9.7 Tjänstespecifika felmeddelanden Inga tjänstespecifika meddelanden. För generella felmeddelanden se dokumentet Message eller Java Doc.

Matilda Östling, Johan Forssell 2017-05-11 27 (49) 10 Hämta kurstillfällen 10.1 Syfte Denna tjänst är till för att hämta alla tillfällen en kurs går givet kursens kurskod. 10.2 Beskrivning Systemet slår upp informationen från databasen samt returnerar en sorterad lista med det äldsta kurstillfället sist. 10.2.1 Flödesbeskrivning Exempel på hur flödet kan se ut i hjälptjänsten Hämta kurstillfällen : 1. Studenten/läraren väljer tjänsten i högskolans portal 2. Portalen anropar hjälptjänsten Hämta kurstillfällen. 3. Studenten/Läraren anger en exakt kurskod. 4. En lista av tillfällen som kursen ges visas sedan av portalen. 10.2.2 Tabellförändringar Tjänsten innebär inga tabellförändringar. 10.3 Metoder /** * Listar tillfällen som kursen "kurskod" går, data läses från KTILL2 * @author andreas.hed * @param uservo * @param kurskod kurskod * @return en lista av tillfällen kursen går/har gått * @ejb:interface-method */ public UtilityKursTillFListVO getkurstillfbykod(uservo uservo,string kurskod) 10.4 Behörighetsanalys Giltig student eller lärare räcker. 10.5 Kravlista Krav Nr Beskrivning Tabell/Vy Prio 1. Hämta alla tillfällen då kursen går KTILL2

Matilda Östling, Johan Forssell 2017-05-11 28 (49) 10.6 Exponerade metoder getkurstillfbykod (UserVO uvo, String kurskod) 10.7 Indata Värdeobjekt Data Format Kontroll Kommentar UserVO - - - Se dokumentet Generell indata String kurskod C(6) KursKod.check() Kurskod 10.8 Utdata Utdata utgörs av en lista på kurstillfällen för den angivna kursen eller en tom lista om kursen ej finns. Värdeobjekt Data Format Kontroll Kommentar UtilityKursTillFListVO callstatusimpl CallStatus - Medelandehantering ktfl List<UtilityKurs TillFVO> UtilityKursTillFVO kurskod C(6) - - En lista av kurstillfällen startter C(5) ÅÅÅÅT - Tillfälle kursen ges kurstakt C(3) - kurstid C(3) - undform C(3) - ort C(4) - kursomg C(1) - kurstyp C(3) - ffgpoang DEC(3.1) - kod C(5) - startv C(6) - slutv C(6) - dep1 DEC(3.1) - dep2 DEC(3.1) - lok1 DEC(3.1) - lok2 DEC(3.1) - plantal Int(4) - antalord Int(4) - antalres Int(4) valuta C(1)

Matilda Östling, Johan Forssell 2017-05-11 29 (49) konvert C(1) 10.9 Tjänstespecifika felmeddelanden Inga tjänstespecifika meddelanden. För generella felmeddelanden se dokumentet Message eller Java Doc.

Matilda Östling, Johan Forssell 2017-05-11 30 (49) 11 Hämta kursinformation 11.1 Syfte Denna tjänst är till för att hämta all information om en kurs givet kursens kurskod. 11.2 Beskrivning Systemet slår upp informationen från databasen. 11.2.1 Flödesbeskrivning Exempel på hur flödet kan se ut i hjälptjänsten Hämta kursinformation : 1. Studenten/läraren väljer tjänsten i högskolans portal 2. Portalen anropar hjälptjänsten Hämta kursinformation. 3. Studenten/Läraren anger en exakt kurskod. 4. Informationen för kursen visas sedan av portalen. 11.2.2 Tabellförändringar Tjänsten innebär inga tabellförändringar. 11.3 Metoder /** * Hämtar data rörande en kurs givet en kurskod * @author andreas.hed * @param uservo * @param kurskod kurskod * @return en UtilityKursVO innehållande information om kursen * @ejb:interface-method */ public UtilityKursVO getkursbykod(uservo uservo,string kurskod) 11.4 Behörighetsanalys Giltig student eller lärare räcker. 11.5 Kravlista Krav Nr Beskrivning Tabell/Vy Prio 1. Hämta information om kursen KURS Alla krav är utvecklade.

Matilda Östling, Johan Forssell 2017-05-11 31 (49) 11.6 Exponerade metoder getkursbykod (UserVO uvo, String kurskod) 11.7 Indata Värdeobjekt Data Format Kontroll Kommentar UserVO uvo Se dokumentet Generell indata String kurskod C(6) KursKod.check() Kurskod C(6) 11.8 Utdata Utdata utgörs av en mappning av informationen från aktuell tabell KURS, metoden returnerar NULL om kursen inte finns. Värdeobjekt Data Format Kontroll Kommentar UtilityKursVO kod C(6) benamns C(120) benamne C(120) poang DEC(4.1) inst C(4) bskala C(2) lkurs C(1) ekurs C(1) kagrpscb C(3) knivauha C(1) friv C(1) nedlagd C(1) djup C(1) examin C(1) ectsp DEC(4.1) idatum C(10) ianv C(6) utbniva C(1) valuta C(1) urspoang DEC(4.1) konvert C(1) isvalid Boolean FALSE=ingen träff i DB CallStatus callstatusimpl Message hantering

Matilda Östling, Johan Forssell 2017-05-11 32 (49) 11.9 Tjänstespecifika felmeddelanden Inga tjänstespecifika meddelanden. För generella felmeddelanden se dokumentet Message eller Java Doc. 12 Hämta prov 12.1 Syfte I denna tjänst hämtas prov tillhörande en kurs givet kurskod. 12.2 Beskrivning Tjänsten hämtar lista med prov givet en kurskod. 12.2.1 Inställningar Inga. 12.2.2 Metoder /** * Hämtar prov tillhörande kurs * * @author eikaon02 * @param uservo * @param kurskod * @return en {@link UtilityProvVO} innehållande tillhörande prov till kursen */ public UtilityProvVO getprovbykurskod(uservo uservo, String kurskod); 12.3 Kravlista Hämta prov från tabellen PROV. 12.4 Indata Värdeobjekt Data Kontroll Kommentar UserVO uservo Se dokumentet generell indata String kurskod Kod för kursen.

Matilda Östling, Johan Forssell 2017-05-11 33 (49) 12.5 Utdata Värdeobjekt Data Format Kommentar UtilityProvVO valid Omslutande värdeobjekt för lista med ProvVO True/False Om denna är falsk finns det felmeddelanden i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc Names ProvVO[] En array med de prov som matchar kurskoden ProvVO är en mappning av information från tabellen PROV. Värdeobjekt Data Format Kommentar ProvVO kurs C(6) Kurskod prov C(4) Provkod benamn C(60) Benämning på provet benamne C(60) Engelsk benämning bskala C(2) Betygskala endaprov C(1) Godkänt prov=godkänd kurs projarb C(1) Projektarbete inst C(4) Ansvarig inst (om ej samma som kursansv) idatum C(10) Senaste ändringsdatum ianv C(6) Användarkod ectsp DEC(4.1) ECTS-credit poang DEC(4.1) Poäng på provet 12.6 Tjänstespecifika felmeddelanden Inga tjänstespecifika meddelanden. För generella felmeddelanden se dokumentet Message eller Java Doc.

Matilda Östling, Johan Forssell 2017-05-11 34 (49) 13 Hämta Ort 13.1 Syfte I denna tjänst hämtas alla ej nedlagda orter från tabellen ORT. 13.2 Beskrivning I denna tjänst hämtas alla ej nedlagda orter från tabellen ORT. 13.2.1 Inställningar Inga. 13.2.2 Metoder /** * Hämtar data rörande orter i systemet. * * @author maud0002 * * @param uservo Användaren som utför anropet. * @return En {@link UtilityOrtVO}[] innehållande alla Orter * */ public UtilityOrtVO[] findallplaces(uservo uservo); 13.3 Kravlista 13.4 Indata Värdeobjekt Data Kontroll Kommentar UserVO uservo Se dokumentet generell indata 13.5 Utdata Värdeobjekt Data Format Kommentar UtilityOrtVO[] valid True/False Om denna är falsk finns det felmeddelanden i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc

Matilda Östling, Johan Forssell 2017-05-11 35 (49) kod benamn Ortskod benämning Om inga poster hittas returneras en Array som är 0 stor. 13.6 Tjänstespecifika felmeddelanden Inga tjänstespecifika meddelanden. För generella felmeddelanden se dokumentet Message eller Java Doc. 14 Hämta alla institutioner 14.1 Syfte I denna tjänst hämtas alla institutioner som inte är nedlagda. 14.2 Beskrivning I denna tjänst hämtas alla institutioner som inte är nedlagda. 14.2.1 Inställningar Inga. 14.2.2 Metoder /** * Hämtar data rörande institutioner i systemet. * * @author maud0002 * * @param uservo Användaren som utför anropet. * @return En {@link UtilityInstitutionVO}[] innehållande alla Institutioner */ public ladok.lpw.service.utility.vo.utilityinstitutionvo[] findallinstitutions(uservo uservo);

Matilda Östling, Johan Forssell 2017-05-11 36 (49) 14.3 Kravlista 14.4 Indata Värdeobjekt Data Kontroll Kommentar UserVO uservo Se dokumentet generell indata 14.5 Utdata UtilityInstitutionVO[] Parameter Format Kommentar Kod C(4) Innehåller den institutionskod som är unik för varje institution. Benamn C(40) Institutionens benämning Gatadr C(30) Institutionens gatuadress Postnr C(6) Institutionens postnummer Ort C(24) Institutionens ort Telefon C(12) Institutionens telefon Benamne C(40) Institutionens engelska namn valid boolsk Om denna är false finns felmeddelande i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc 14.6 Tjänstespecifika felmeddelanden Inga tjänstespecifika meddelanden. För generella felmeddelanden se dokumentet Message eller Java Doc.

Matilda Östling, Johan Forssell 2017-05-11 37 (49) 15 Hämta adressuppgifter 15.1 Syfte I denna tjänst hämtas adress och epostuppgifter för alla personer som skickas in 15.2 Beskrivning I denna tjänst hämtas adress och epostuppgifter för alla personer som skickas in 15.2.1 Inställningar Inga. 15.2.2 Metoder /** * Hämtar Personuppgifter innehållande bland annat address och epost. * * @param uservo Användaren som utför anropet. * @param personids array med personnummer * @return Ett {@link UtilityPersonsVO}} * */ public UtilityPersonsVO fetchadrinfo(uservo uservo, String[] personids) { 15.3 Kravlista 15.4 Indata Värdeobjekt Data Kontroll Kommentar UserVO uservo Se dokumentet generell indata String[] personids De personnummer man vill hämta data för 15.5 Utdata UtilityPersonsVO Värdeobjekt Data Format Kontroll Kommentar PersonVO[] personvo - - Innehåller personens namn och kontaktuppgifter

Matilda Östling, Johan Forssell 2017-05-11 38 (49) Värdeobjekt Data Format Kontroll Kommentar PersonVO enamn C(25) - tnamn C(25) - tgatadr C(40) - t... = Tidsbegränsad adress tcoadr C(25) - tpostnr C(12) - tort C(35) - tland C(20) - fgatadr C(40) - f... = Folkbokföringsadress fcoadr C(25) - fpostnr C(12) - fort C(35) - fland C(20) - fromdat tomdat C(10) ÅÅÅÅ- MM-DD C(10) ÅÅÅÅ- MM-DD telnr C(70) - sms C(70) - emailadr C(70) - - Visar från vilket datum den tidsbegränsade adressen gäller - Visar vilket datum den tidsbegränsade adressen upphör att gälla 15.6 Tjänstespecifika felmeddelanden Inga tjänstespecifika meddelanden. För generella felmeddelanden se dokumentet Message eller Java Doc.

Matilda Östling, Johan Forssell 2017-05-11 39 (49) 16 Hämta kurs på institution 16.1 Syfte 16.2 Beskrivning I denna tjänst hämtas kurser som hör till en specifik institution. 16.2.1 Inställningar Inga. 16.2.2 Metoder /** * Hämtar alla kurser kopplade till en specifik institution. * * @param uservo * @param inst institution * @return en UtilityKursVO array innehållande information om kurserna. */ public UtilityKursProvVO[] getkursbyinst(uservo uservo, String inst) { 16.3 Kravlista 16.4 Indata Värdeobjekt Data Kontroll Kommentar UserVO uservo Se dokumentet generell indata String inst Den aktuella institutionen. 16.5 Utdata UtilityKursProvVO Värdeobjekt Data Typ Kommentar UtilityKursProvVO kod String Kurskod benamns String Svensk benämning benamne String Engelsk benämning

Matilda Östling, Johan Forssell 2017-05-11 40 (49) Värdeobjekt Data Typ Kommentar ProvVo poang BigDecimal Poängomfattning inst String Kursansvarig institution bskala String Betygskala lkurs String Kurs inom program (J/N) ekurs String Fristående kurs (J/N) kagrpscb String SCB-ämnesklass knivauha String Av UHÄ fastställd nivå friv String Frivillig kurs (J/N) nedlagd String Nedlagd kurs (J/blank) djup String Djup examin String Examinator ectsp BigDecimal ectsp-credit idatum String Inläggningsdatum (ÅÅÅÅ-MM-DD) ianv String Användarkod utbniva String Utbildningsnivå valuta String Valuta urspoang BigDecimal Ursprungspoäng konvert String Konverteringsmarkering (J/blank) isvalid Boolean prov ProvVo[] kurs String Kurskod prov String Provkod benamn String Svensk benämning bskala String Betygskala endaprov String Godkänt prov = godkänd kurs (J/N) benamne String Engelsk benämning projarb String Projektarbete (J/blank) inst String Institution idatum String Inläggningsdatum (ÅÅÅÅ-MM-DD) ianv String Användarkod ectsp BigDecimal ectsp-credit

Matilda Östling, Johan Forssell 2017-05-11 41 (49) Värdeobjekt Data Typ Kommentar poang BigDecimal Poäng urspoang BigDecimal Ursprungspoäng konverterad boolean Konverteringsmarkering 16.6 Tjänstespecifika felmeddelanden Inga tjänstespecifika meddelanden. För generella felmeddelanden se dokumentet Message eller Java Doc.

Matilda Östling, Johan Forssell 2017-05-11 42 (49) 17 Sök person på del av personnummer eller namn 17.1 Syfte I denna deltjänst kan personal söka studenter eller forskarstudenter på helt eller delvis känt personnummer, tilltalsnamn eller efternamn. Utsökningen kan också begränsas på helt eller delvis känd kurskod, programkod eller institution för studenter, respektive på helt eller delvis känt forskarutbildningsämne för forskarstudenter. Vid utsökningen kontrolleras också studenternas status. 17.2 Beskrivning Denna deltjänst hämtar personers personnummer, tilltalsnamn och efternamn utifrån angivna sökvillkor. För studenter på grund- och avancerad nivå hämtas också: Förstagångsregistreringar på kurs (från tabellen FFGKURS) Förstagångsregistrering inom program (från tabellen ANTLIN). För forskarstudenter hämtas också: Forskarutbildningsämnen (från tabellen FOANT2). Utöver detta hämtas också datum för eventuell gallring eller igallring, samt om personen är avliden. 17.2.1 Sökning med asterisk Vid utsökning med delvis kända sökord ska en asterisk (*) användas för att representera de okända delarna av sökordet. Exempel: Anges 820202* som Personnummer kommer utsökningen att hitta personer vars personnummer inleds med dessa siffror. Anges *dersso* som Efternamn kommer utsökningen att hitta personer som någonstans i sitt efternamn har denna kombination av bokstäver. 17.2.2 Flödesbeskrivning Exempel på hur flödet kan se ut i deltjänsten: 1. Personal med behörighet till tjänsten som innefattar utsökning av studenter på grund- eller avancerad nivå eller forskarstudenter väljer denna i högskolans portal.

Matilda Östling, Johan Forssell 2017-05-11 43 (49) 2. Helt eller delvis känt personnummer, tilltalsnamn eller efternamn måste ange. Sökningen kan ytterligare begränsas genom att ange helt eller delvis känd kurskod, programkod eller institution för studenter, samt helt eller delvis känt forskarutbildningsämne för forskarstudenter. 3. En lista av matchande studenter på grund- och avancerad nivå eller forskarstudenter visas i portalen. 17.2.3 Tabellförändringar Tjänsten innebär inga tabellförändringar. 17.3 Behörighet Endast personal har behörighet till deltjänsten. 17.4 Exponerade metoder Nedanstående metoder används för att söka studenter på grund- och avancerad nivå respektive forskarstudenter. Studenter på grund- och avancerad nivå UtilityGrundStudentVO[] getgrundstudenterbysearchcriterias(uservo uservo, UtilitySearchCriteriaGrundVO searchcriteriavo) Forskarstudenter UtilityForskarstudentVO[] getforskarstudenterbysearchcriterias(uservo uservo, UtilitySearchCriteriaForskarstudenterVO searchcriteriavo) 17.5 Indata UserVO Värdeobjektet UserVO används för att autentisera användaren av tjänsten. För ytterligare information, se dokumentet Generell In- och Utdata LPW.doc. 17.5.1 Utsökning av student på grund- och avancerad nivå UtilitySearchCriteriaGrundVO I värdeobjektet UtilitySearchCriteriaGrundVO sätts parametrarna som ska användas vid utsökningen.

Matilda Östling, Johan Forssell 2017-05-11 44 (49) Minst en av parametrarna pnr, enamn eller tnamn måste innehålla något tecken för att sökningen skall genomföras. Om samtliga av dessa parametrar är tomma kommer ett felmeddelande att genereras och ingen sökning genomförs. Max ett (1) bindestreck får användas i ett helt eller delvis specificerat personnummer. Parameter Datatyp Kommentar pnr String Personnummer eller del av personnummer enamn String Efternamn eller del av efternamn tnamn String Tilltalsnamn eller del av tilltalsnamn kurs String Kurskod eller del av kurskod progr String Programkod eller del av programkod inst String Institutionskod eller del av institutionskod 17.5.2 Utsökning av forskarstudent UtilitySearchCriteriaForskarstudenterVO I värdeobjektet UtilitySearchCriteriaForskarstudenterVO sätts parametrarna som ska användas vid utsökningen. Minst en av parametrarna pnr, enamn eller tnamn måste innehålla något tecken för att sökningen skall genomföras. Om samtliga av dessa parametrar är tomma kommer ett felmeddelande att genereras och ingen sökning genomförs. Max ett (1) bindestreck får användas i ett helt eller delvis specificerat personnummer. Parameter Datatyp Kommentar pnr String Personnummer eller del av personnummer enamn String Efternamn eller del av efternamn tnamn String Tilltalsnamn eller del av tilltalsnamn amne String Forskarutbildningsämne eller del av forskarutbildningsämne

Matilda Östling, Johan Forssell 2017-05-11 45 (49) 17.5.3 Begränsa antalet sökträffar Det maximala antalet träffar som returneras vid utsökningen begränsas av MAX_TRÄFFAR i Nouveaus systempreferenser i tabellen SYSTPREF. 17.6 Utdata Metoderna returnerar en array av värdeobjektet UtilityGrundStudentVO vid utsökning av studenter på grund- och avancerad nivå, samt en array av UtilityForskarstudentVO vid utsökning av forskarstudenter. UtilityGrundStudentVO Parameter Datatyp Kommentar pnr String Personnummer enamn String Efternamn tnamn String Tilltalsnamn gallraddatum String Datum för eventuell gallring igallraddatum String Datum för eventuell igallring avliden boolean true om personen är avliden program List<AntlinVO> Förstagångsregistreringar på kurs, sorterade efter termin kurser List<FfgkursVO> Förstagångsregistreringar inom program, sorterade efter termin valid boolean Om denna är false finns felmeddelande i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumentet Message.doc Värdeobjektet UtilityGrundStudentVO Förutom set- och getmetoder för värdeobjektets parametrar finns metoder för att hämta senaste registrering på kurs eller program: getlatestkurs() och getlatestprogram(). Metoder finns också för att kontrollera om studenten är gallrad eller igallrad: isgallrad() och isigallrad().

Matilda Östling, Johan Forssell 2017-05-11 46 (49) UtilityForskarstudentVO Parameter Datatyp Kommentar pnr String Personnummer enamn String Efternamn tnamn String Tilltalsnamn gallraddatum String Datum för eventuell gallring igallraddatum String Datum för eventuell igallring avliden boolean Anger om personen är avliden amne List<UtilityFoamneVO> Forskarutbildningsämnen, sorterade efter termin valid boolean Om denna är false finns felmeddelande i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumentet Message.doc Förutom set- och getmetoder för värdeobjektets parametrar finns en metod för att hämta senaste forskarutbildningsämne: getlatestamne() Metoder finns också för att kontrollera om studenten är gallrad eller igallrad: isgallrad() och isigallrad(). 17.6.1 Felhantering Om något fel uppstår vid utsökningen sätts valid i returobjektet till false och ett meddelande skapas. Detta kan kontrolleras i ett returnerat värdeobjekt genom att anropa metoderna isvalid() och getmessages(). 17.7 Tjänstespecifika felmeddelanden Tjänstespecifika felmeddelanden genereras om något av följande inträffar: Samtliga av parametrarna pnr, enamn och tnamn är tomma i ett värdeobjekt som används som indata. Ett helt eller delvis angivet personnummer innehåller fler än ett (1) bindestreck. Utsökningen resulterar i fler träffar än vad som angivits som begränsning i Nouveaus systempreferenser (i tabellen SYSTPREF).

Matilda Östling, Johan Forssell 2017-05-11 47 (49) Konstant utility.too_few_criterias utility.multiple_hyphens utility.too_many_hits Nivå Kommentar Error Sökkriterier saknas. Minst ett av fälten för personnummer och namn måste vara ifyllt. Error Högts ett (1) bindestreck är tillåtet i personnumret. Error För många träffar. Begränsa sökningen ytterligare. 17.8 Generella felmeddelanden För generella felmeddelanden, se dokumentet Messages.doc. 18 Hämta huvudområde och fördjupning 18.1 Syfte I denna tjänst hämtas uppgifter om huvudområde och fördjupning för en given kurskod. 18.2 Beskrivning Tjänsten hämtar kod, benämning och engelsk benämning på huvudområde och fördjupning från tabellen KURSHOMR, HUVUDOMR och FORDJUP för given kurskod. Varje träff läggs i ett värdeobjekt och läggs i en lista. 18.3 Metoder /** * Hämtar huvudområde och fördjupning KURSHOMR, HUVUDOMR och FORDJUP. * @param uvo För autentisering och auktorisering * @param kurskod Ange kurskod för den aktuella kursen. * @return Lista med information om huvudområde och fördjupning. */ public UtilityHuvudomrFordjupningVO[] findkurshomrbykurskod(uservo uvo, String kurskod); 18.4 Indata Värdeobjekt Data Kontroll Kommentar UserVO uservo Se dokumentet generell indata

Matilda Östling, Johan Forssell 2017-05-11 48 (49) String Kurskod Kurskod för den aktuella kursen. 18.5 Utdata Metoden returnerar en lista av värdeobjektet UtilityHuvudomrFordjupningVO vid utsökning av huvudområde och fördjupning för given kurskod. UtilityHuvudomrFordjupningVO Parameter Typ Kommentar huvudomr String Kod för huvudområdet huvudomrbenamns String Huvudområdets svenska namn huvudomrbenamne String Huvudområdets engelska namn fordjupning String Kod för fördjupning fordjupningbenamns String Fördjupningens svenska namn fordjupningbenamne String Fördjupningens engelska namn valid Boolean Om denna är false finns felmeddelande i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc 18.5.1 Felhantering Det kan förekomma generella felmeddelanden från t ex validering och autenticering. Se dokumentet Message.doc för information om dessa. 19 Hämta provuppsättningsterminer 19.1 Syfte Denna tjänst hämtar provuppsättningsterminer för specificerade prov och sorterar in proven efter funna terminer. 19.2 Beskrivning Tjänsten hämtar terminer från tabellen PROVUPPS med hjälp av provens kurskod och provkod. Proven returneras sedan i listor insorterade efter de funna terminerna.

Matilda Östling, Johan Forssell 2017-05-11 49 (49) 19.3 Metoder /** * Hämtar specificerade provs provuppsättningsterminer och returnerar proven insorterade efter termin. * @param UserVO uvo För autentisering och auktorisering * @param ProvVO[] tests Lista med ProvVO innehållande kurskod och provkod. * @return ProvBySemesterVO[] Lista med proven insorterade i de provuppsättningsterminer de tillhör. */ public ProvBySemesterVO[] getprovorderedbysemester(uservo uservo, ProvVO[] tests); 19.4 Indata Parameter Typ Kommentar uservo UserVO Se dokumentet generell indata tests ProvVO[] Proven vars provuppsättningsterminer skall eftersökas. Måste minst innehålla kurskod och provkod. 19.5 Utdata Observera att ingen kontroll utförs på indatat. Metoden returnerar en lista av värdeobjektet ProvBySemesterVO där varje objekt innehåller en funnen termin och en lista med de prov (ProvVO) som tillhör denna termin. ProvBySemesterVO Parameter Typ Kommentar termin String Provuppsättningstermin provlist List<ProvVO> Lista med de prov som tillhör ovanstående provuppsättningstermin callstatusimpl CallStatusAsCollection Innehåller statusinformation/felmeddelanden 19.5.1 Felhantering Det kan förekomma generella felmeddelanden från t ex validering och autentisering. Se dokumentet Message.doc för information om dessa.