UNI Login. Eksport webservice. WS17 v1

Transkript

1 UNI Login Eksport webservice WS17 v1

2 UNI Login Eksport webservice 1.4

3 Indhold 1 Eksport webservice Indhold af data Dataaftale Klassifikation af data Informationsmodel Entiteter og attributter Import Objekter Metoder Metoder til test Metoder til opslag... 3

4 UNI Login Eksport webservice 1 1 Eksport webservice Eksport webservicen anvendes til udtræk af UNI Login data i samme XML-format som anvendes i import webservicen ws10. Data er baseret på det importerede beriget med UNI Login s login-information og institutionens samlede grupper. En beskrivelse af det anvendte XML Schema findes i dokumentationen for ws10. Eksport webservicens servicebeskrivelse findes på adressen Produktion: Test: Indhold af data Data der returneres, er det der er registreret af institutionerne enten via import eller ved registrering i Brugeradministrationen. Man skal derfor være opmærksom på, at ikke alle personer har registreret alle oplysninger. Ligesom brugen af de enkelte felter varierer fra institution til institution. Da personoplysninger i UNI-Login er registreret per institution, kan der til den samme UNI-Loginbruger være forskellige sæt personinformationer for forskellige institutioner. 1.2 Dataaftale For at udtrække data for en institution, skal der foreligge en dataaftale imellem institutionen og udbyderen der trækker data. Inspiration til dataaftale kan findes på STILs hjemmeside: Når aftalen er indgået, skal det registres i UNI-Login. Det er kun muligt at udtrække data for institutioner, der har registreret en dataaftale til den pågældende udbyder. Processen i UNI-Login er at udbyder opretter en forespørgsel om dataaftale med en institution. Dette gøres i Brugeradministrationen via Dataaftaler/Webservice-forespørgsler. Når dataaftalen er indgået, godkender institutionens brugeradministrator forespørgslen under sine Dataaftaler. Dette repræsenterer teknisk en indgået databehandleraftale mellem udbyder og institution.

5 UNI Login Eksport webservice Klassifikation af data Data i UNI-Login er klassificeret i 3 niveauer opdelt efter følsomhed. Udbyder kan fra STIL få abonnement til at forespørge om rettigheder til udtræk af data i en lille, mellem og fuld pakke, svarende til klassificeringen af data. Den fulde pakke er en komplet eksport at data fra UNI Login. De mindre pakker kan med fordel anvendes, hvis man som udbyder kun er interesseret i at importere en delmængde af data og dermed indgå en enklere dataaftale. Læs mere om dataaftaler og sammensætningen af datapakkerne i UNI Login Brugeradministrationen. 1.4 Informationsmodel Institution Import 1.5 Entiteter og attributter Import Navn Type Beskrivelse institutionnumber String 6-tegns institutionsnummer, typisk tildelt fra Danmarks Statistik, men også fra interne kilder. source String Navn på kildesystem. sourcetype String Kildetype: ws10, XML eller CSV. exportdatetime DateTime Tidspunkt for eksport af data fra kildesystemet. importdatetime DateTime Tidspunkt for indlæsning i UNI Login. lastchangedate DateTime Tidspunkt for hvornår UNI Login senest har modtaget ændringer i en import. administrativevaliddate DateTime Importens administrative gyldighedsdato. Til ekstern brug. importxml XML Data i samme XML-format som anvendes i import webservicen ws10. Se den tilhørende XML Schema -beskrivelse i dokumentationen for importwebservicen ws10.

6 UNI Login Eksport webservice Objekter Metoderne returnerer data som XML-objekter. Objekter skrives her med stort forbogstav. En liste med f.eks. objekter af typen Import skrives i kantede parenteser: [Import]. Navn Type Attributter Import Objekt institutionnumber, source, sourcetype, exportdatetime, importdatetime, lastchangedate, administrativevaliddate ImportData Objekt importxml 1.7 Metoder Metoder til test Metodenavn Returnerer Beskrivelse helloworld ( ) Hello world Testmetode, der ikke kræver anden adgang end åbning for IP-nummer. hellosoapfaultdemo ( ) SOAP Fault Testmetode, der ikke kræver anden adgang end åbning for IP-nummer. Alle nedenstående metoder skal ud over de angivne parametre kaldes med adgangsgivende brugernavn og kodeord (wsuserid og wspassword) som første parametre Metoder til opslag Metodenavn Returnerer Beskrivelse listuniloginimport( institutionnumber) [Import] Returnerer en liste af Import-objekter med oplysninger om importer på den angivne institution. Returner et XML dokument med data i den angivne import. getimport( institutionnumber, ImportData source, sourcetype) getdata( institutionnumber) ImportData Returnerer et XML dokument med data på tværs af institutionens importer. getxmlschema () XML Returnerer XML Schema for den aktuelle ws17-version.