UNI Login. UNI Login webservice. ws-04

Transkript

1 UNI Login UNI Login webservice ws-04

2 UNI Login UNI Login webservice 1.4

3 Indhold 1 UNI Login webservice Informationsmodel Entiteter og attributter Person Funktion Import Objekter Metoder Metoder til test Metoder til opslag... 5

4 UNI Login webservice 1 1 UNI Login webservice Denne webservice kan anvendes til at udtrække UNI Login-brugere f.eks. til lokal infrastruktur på en institution eller i en kommune. Det er ikke en forudsætning, at de brugere, som skal oprettes, er identificeret med personnummer i UNI Login. Der kan kun udtrækkes informationer om brugere via institutioner eller funktionsmarkeringer, som er knyttet til den udtrækkende identitet, typisk en såkaldt wsad -bruger. Tilknytningen sker ved at den relevante myndighed indsender en underskrevet tilladelse til UNI-C. Der findes en formel beskrivelse af ws04 webservicen i WSDL-filen, der findes her: Informationsmodel Institution Funktion Person Import

5 UNI Login webservice Entiteter og attributter Person Navn Type Beskrivelse Brugerid String Unikt UNI Login-brugerid. Cprnr String Personens cpr-nummer i klar tekst. Eksempel: InitieltPw String Det password brugeren fik ved oprettelsen, eller sidst det blev nulstillet. PwStatus String valid hvis brugeren ikke selv har skiftet sit UNI Login password. Dvs. initieltpw er gældende. changed, hvis brugeren har skiftet sit password. Brugernavn String Består af fornavn+ +efternavn. Efternavn String Hvis det administrative system, der hentes data fra, indeholder et felt til efternavn, så er dette en kopi af feltets indhold. Hvis det administrative system kun indeholder et felt til fulde navn, så defineres efternavnet til at være det sidste ord i det fulde navn. Fornavn String Hvis det administrative system, der hentes data fra, indeholder et felt til fornavn, så er dette en kopi af feltets indhold. Hvis det administrative system kun indeholder et felt til fulde navn, så defineres fornavnet til at være fulde navn fratrukket det sidste ord i det fulde navn. Bemærk: hvis fulde navn kun er et navn, så kan fornavn være tomt (en tom streng). SkolekomNavn String Eksempel: Svend Hansen12. Mailadresse String Hvis brugeren selv har angivet en mailadresse på brugerprofil.emu.dk, er det denne mailadresse, ellers er det en mailadresse tildelt via import. MobilNr String Brugerens mobiltelefonnummer. Foedselsdag String Personens fødselsdato. Eksempel: beregnet ud fra cprnr. Koen String Personens køn M/K. Feltet er beregnet ud fra personnummeret. Hvis personen ikke har et personnummer, angives "ukendt".

6 UNI Login webservice Funktion Navn Type Beskrivelse Instnr String 6-tegns institutionsnummer (fra Danmarks Statistik, fx ). PrimInst String Ja hvis Instnr er brugerens primære institution, typisk institutionen der har ansvaret for brugeren i relation til prøver i folkeskolen. nej ellers. Brugerid String Unikt UNI Login brugerid. Funktionsmarkering String lærer, tap, pæd, elev, stud, kursist, klasse, skole. Klassetrin String Kun for elever og studerende. Eksempel: 8. Klasse String Kun for elever og studerende. Eksempler: 8a, 8.a 8. a.. Hvis eleven ikke er importeret vises Klasse/årgang, f.eks. A 06/07. HoldListe String Element i liste af elevens hold Aargang String Det, som er angivet som startklasse i institutionens import f.eks Initialer String Kun for lærere. Stilling String Kun for lærere. Fotoid String Benyttes til at navngive foto sammen med institutionsnummer. Spor String Kun for elever og studerende. Bogstav. Trin String Kun for elever. Tal, der angiver klassens trin. Kan være forskellig fra elevens klassetrin (niveau). Andet String Anden information fra institutionens import

7 UNI Login webservice Import Navn Type Beskrivelse Instnr String 6-tegns institutionsnummer (fra Danmarks statistik, fx ). Impdel_id String Id for importen. Kilde String Betegnelse for det system, data stammer fra. Kildetype String Fx "CSV" eller "XML". Eksportdato String Tidspunkt for udtræk fra kildesystem fx " :49:00.0". Importdato String Tidspunkt for indlæsning i UNI Login fx " :01:13.0". Gyldigdato String Tidspunkt for hvornår data gælder fra fx " :00:00.0". Forskeldato String Tidspunkt for hvornår der senest er sket ændringer i en import, fx " :49:00.0". 1.3 Objekter Infotjenestens webservice returnerer data som XML-pakker. En liste med f.eks. objekter af typen ElevCpr skrives i kantede parenteser: [ElevCpr]. Et objekt har attributter, som enten stammer fra entiteterne ovenfor, eller er lister af andre objekter som f.eks. [Funktioner]. Navn Type Attributter UNILogin Objekt Brugerid, Cprnr, InitieltPw, PwStatus UNILoginElev Objekt Brugerid, Cprnr, Efternavn, Fornavn, Funktionsmarkering, InitieltPw, Klasse, Klassetrin, Mailadresse, Navn, PwStatus, SkolekomNavn, Aargang UNILoginElev2 Objekt Brugerid, Cprnr, Efternavn, Fornavn, Funktionsmarkering, InitieltPw, Klasse, Klassetrin, Mailadresse, Navn, PwStatus, SkolekomNavn, Aargang, Fotoid, Foedselsdag, Spor, Trin, Koen, PrimInst, MobilNr, Andet, [HoldListe] UNILoginAnsat Objekt Brugerid, Cprnr, Efternavn, Fornavn, Funktionsmarkering, InitieltPw, Mailadresse, Navn, PwStatus, SkolekomNavn UNILoginAnsat2 Objekt Brugerid, Cprnr, Efternavn, Fornavn, Funktionsmarkering, InitieltPw, Mailadresse, Navn, PwStatus, SkolekomNavn, Initialer, Stilling, Fotoid, Prim-

8 UNI Login webservice 5 Inst, Mobiltelefon, Andet, [HoldListe] UNILoginImort Objekt instnr, impdel_id, kilde, kildetype, eksportdato, importdato, gyldigdato, forskeldato Funktioner Objekt Instnr, Funktion UNILoginPerson Objekt Brugerid, Cprnr, Efternavn, Fornavn, Funktionsmarkering, InitieltPw, Mailadresse, Navn, PwStatus, SkolekomNavn, Instnr, Foedselsdag ADPPerson Objekt UNILoginPerson, [Funktioner] 1.4 Metoder Nedenstående metoder er ikke nødvendigvis en udtømmende liste af implementerede metoder. Eksemplerne er forsøgt holdt på et ikke-teknisk niveau for at højne læsbarheden. Resultater vil i realiteten være objekter i form af XMLformaterede strenge. BEMÆRK: Det forudsættes, at applikationen implementerer en korrekt anvendelse af den tilbudte webservice. For at kunne hente UNI Login-brugere på en institution, kræves der en specielt tildelt rettighed. En bruger kan have tilknytning til flere institutioner. Dette styrer institutionerne selv i UNI Login-brugeradministration via importer fra deres administrative system Metoder til test Metodenavn Returnerer Beskrivelse helloworld ( ) Hello World! Testmetode, der ikke kræver anden adgang end åbning for IP-nummer. hellosoapfaultdemo ( ) hellosoapfault method failed Testmetode, der ikke kræver anden adgang end åbning for IP-nummer. Alle andre metoder skal ud over de angivne parametre kaldes med adgangsgivende brugernavn og kodeord! Metoder til opslag Metodenavn Returnerer Beskrivelse hentunilogin (instnr, cprnr) UNILogin Returner oplysninger om UNI Login-brugerid og password for personen med det angivne personnummer, forudsat at personen har en tilknytning til den angivne institution. hentalleunilogins [UNILogin] Returner en liste af objekter med oplysninger om UNI Login-brugerid og password for alle

9 UNI Login webservice 6 personer med en tilknytning til den angivne institution. hentuniloginliste (instnr, [cprnr]) [UNILogin] Returner en liste af objekter med oplysninger om UNI Login-brugerid og password for de angivne personer, forudsat at personerne har en tilknytning til den angivne institution. hentalleuniloginelever [UNILoginElev] Returner en liste af objekter med oplysninger om UNI Login brugerid og password samt elevoplysninger for alle elever eller studerende med en tilknytning til den angivne institution. hentalleuniloginelever2 [UNILoginElev2] Returner en liste af objekter med oplysninger om UNI Login brugerid og password samt elevoplysninger for alle elever eller studerende med en tilknytning til den angivne institution. hentalleuniloginansatte [UNILoginAnsat] Returner en liste af objekter med oplysninger om UNI Login brugerid og password samt personoplysninger for alle ansatte med en tilknytning til den angivne institution. hentalleuniloginansatte2 [UNILoginAnsat2] Returner en liste af objekter med oplysninger om UNI Login brugerid og password samt personoplysninger for alle ansatte med en tilknytning til den angivne institution. hentuniloginimportliste [UNILoginImport] Returnerer en liste af objekter med oplysninger om UNI Login importer på den angivne institution. hentadppersoner () [ADPPerson] Returnerer en liste med alle de brugere, der er tilknyttet den ws-adbruger, der kalder metoden.