UNI•Login Eksport (ws17)

UNI•Login
Eksport webservice
WS17 v1
© UNI•C juli 2015
UNI•Login
Eksport webservice
© UNI•C juli 2015
1.3
Indhold
1
Eksport webservice ....................................................................... 1
1.1 Informationsmodel ................................................................ 1
1.2 Entiteter og attributter ........................................................... 2
1.2.1
Import ...................................................................... 2
1.3 Objekter ............................................................................... 2
1.4 Metoder ............................................................................... 2
1.4.1
1.4.2
Metoder til test ....................................................... 2
Metoder til opslag ................................................... 3
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: https://ws17.infotjeneste.uni-c.dk/v1/?WSDL
Test:
https://ws17-test.infotjeneste.uni-c.dk/v1/?WSDL
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
© UNI•C juli 2015
Import
UNI•Login Eksport webservice
1.2
2
Entiteter og attributter
1.2.1 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.
DateTime Tidspunkt for hvornår UNI•Login senest har modtaget ændringer i en import.
administrativeValidDate DateTime Importens administrative gyldighedsdato. Til ekstern brug.
XML
Data i samme XML-format som anvendes i import
importXML
webservicen ws10. Se den tilhørende ”XML Schema”-beskrivelse i dokumentationen for importwebservicen ws10.
lastChangeDate
1.3
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
1.4.1
Metoder til test
Metodenavn
Returnerer
Beskrivelse
helloWorld ( )
”Hello world”
helloSOAPFaultDemo ( )
SOAP Fault
Testmetode, der ikke kræver anden adgang end åbning for IP-nummer.
Testmetode, der ikke kræver anden adgang end åbning for IP-nummer.
© UNI•C juli 2015
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.
1.4.2
Metoder til opslag
Metodenavn
Returnerer
Beskrivelse
listUNLoginImport (
institutionNumber)
[Import]
getImport (
institutionNumber,
source, sourceType)
getData (
institutionNumber)
getXmlSchema ()
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.
© UNI•C juli 2015
ImportData
XML
Returnerer et XML dokument med data på
tværs af institutionens importer.
Returnerer XML Schema for den aktuelle
ws17-version.