UNI Login. Eksport webservice. WS17 v1

Transkript

1 UNI Login Eksport webservice WS17 v1

2 UNI Login Eksport webservice 1.3

3 Indhold 1 Eksport webservice 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: Det er kun muligt at udtrække data for institutioner, der har givet rettigheden til den pågældende udbyder. I praksis opretter man som udbyder en forespørgsel om rettigheder til en given institution i UNI Login Brugeradministrationen via punktet Dataaftaler. Rettigheden tildeles, når institutionens brugeradministrator godkender forespørgslen under sine Dataaftaler. Dette repræsenterer teknisk en indgået databehandleraftale mellem udbyder og institution. Udbyder kan fra STIL få abonnement til at forespørge om rettigheder til udtræk af data i en lille, mellem og fuld pakke. 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. Læs mere om dataaftaler og sammensætningen af datapakkerne i UNI Login Brugeradministrationen. 1.1 Informationsmodel Institution Import

5 UNI Login Eksport webservice 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 importdatetime DateTime Tidspunkt for eksport af data fra kildesystemet. 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 ws 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.4 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.

6 UNI Login Eksport webservice 3 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 listunloginimport ( institutionnumber) getimport ( institutionnumber, source, sourcetype) getdata ( institutionnumber) [Import] ImportData ImportData Returnerer en liste af Import-objekter med oplysninger om importer på den angivne institution. Returner et XML dokument med data i den angivne import. Returnerer et XML dokument med data på tværs af institutionens importer. getxmlschema () XML Returnerer XML Schema for den aktuelle ws17-version.