Versioner sammenlignet

Nøgle

  • Linjen blev tilføjet.
  • Denne linje blev fjernet.
  • Formatering blev ændret.

Generelt

API’er for webservices i UNI•Login SkoleGrunddata beskrives her på et konceptuelt niveau. Det konkrete niveau er beskrevet i WSDL-beskrivelserne, som der er henvist til fra de enkelte webservices.

Begrebsmodel

Der skelnes i det følgende mellem data, som vedligeholdes af en institution, og data, som vedligeholdes af en udbyder. En institution er en organisation, som bedriver undervisning, og som derfor har knyttet brugere til sig i form af ansatte og elever. En udbyder er en organisation, som udbyder tjenester til at understøtte den aktivitet, der foregår på en undervisningsinstitution i form af administrative processer og læringsprocesser.

...

Vedligeholdelsesansvaret for data er med til at opdele de enkelte services, og der skal som udgangspunkt laves aftaler med den ansvarlige part om at tilgå data via en service. I praksis skal man som udbyder tilsluttes en given service ved henvendelse til Styrelsen for It og LæringTilslutning. Herefter kan der oprettes forespørgsleranmodninger om aftaler dataadgang for den pågældende service i UNI•Login Brugeradministrationen via punktet ”Tilslutninger”. Når en brugeradministrator administrator hos den ansvarlige part godkender forespørgslen under sine ”Dataaftaler” i UNI•Login Brugeradministrationen anmodningen i Tilslutning er der adgang til at trække data.En tilslutning til en given service er tilstrækkeligt, hvis man kun vil tilgå egne data. Dataaftaler er nødvendige for at kunne tilgå data hos andre institutioner/udbydere. 

Services

Ud over at services opdeles på vedligeholdelsesansvaret for data, opdeles de også i forhold til den tiltænkte anvendelse.

...

Straks-services (straks) håndterer mindre mængder data i modsætning til services til fulde træk (fuld), der er beregnet til at overføre store datamængder og til at vedligeholde lokal cache. 

Bemærk

Services til fulde træk må maksimalt kaldes 4 gange pr. institution pr. dag. Bemærk, at services til fulde træk og administration har en driftprofil med lavere kritikalitet end services til straksopslag. Jf. Servicemål for UNI-Login.

...

Der findes et antal gennemgående metoder i alle services til test og overblik over indgåede dataaftaler.

Oversigt over services

Id

Navn

Adm/Info

Straks/Fuld

Vedligehold

Beskrivelse

Licens- og autorisation

ws03

wsaLICENS

adm

straks

Udbyder

Administration af tjenester og tildeling af licenser til dem

ws05

wsiAUTOR

info

straks

Udbyder

Autorisation af slutbruger på baggrund af licenser

Projektgrupper (dynamiske, tværgående grupper)

ws15

wsaGRUPPE

adm

straks

Udbyder

Administration af projektgrupper

ws16

wsiUDBYDER

info

straks

Udbyder

Information om projektgrupper, deres medlemmer og licenser

Institutionsoplysninger, herunder forældre og kontaktpersoner

ws22

wsiINST

info

straks

Institution

Information om grupper, deres medlemmer og licenser

ws71

wsiBRUGER

info

straks

Institution

Information om slutbrugers kontaktpersoner

Import og eksport, herunder forældre og kontaktpersoner

ws10

wsaIMPORT

adm

fuld

Institution

Import af grupper, medlemmer og kontaktpersoner

ws17

wsiEKSPORT

info

fuld

Institution

Eksport af grupper, medlemmer og kontaktpersoner


wsiiIDENTIFIKATIONinfostraksInstitutionMapning mellem UNI-Login brugerid og CPR-nummer

Attributter

Attributter er de felter, som anvendes i kald af webservices, men også de felttyper, der returneres i objekter som svar på kald til en metode. (Attributter skrives med lille begyndelsesbogstav).

Attributnavn

Type

Beskrivelse

Anker
wsBrugerid
wsBrugerid
wsBrugerid

StringSystembruger, som ejes af en udbyder

Anker
wsPassword
wsPassword
wsPassword

StringSystembrugerens password

Anker
brugerid
brugerid
brugerid

String

Unikt UNI•Login-brugerid

Anker
cpr
cpr
cpr

StringCPR-nummer

Anker
navn
navn
navn

String

Består af fornavn+’ ’+efternavn. Hvis der er navnebeskyttelse vises det importerede alias-navn.

Anker
instnr
instnr
instnr

String

Seks-tegns registreringsnummer, som identificerer en institution (kan indeholde både bogstaver og tal)

Anker
instnavn
instnavn
instnavn

String

Institutionsnavn

Anker
gruppeid
gruppeid
gruppeid

String

Et gruppeid, holdID eller fagkode som er unikt på institutionen.

Anker
hovedgruppeid
hovedgruppeid
hovedgruppeid

String

Gruppeid på hovedgruppen. For grundskoler er hovedgruppen lig elevens klasse.

Anker
gruppenavn
gruppenavn
gruppenavn

String

Navnet på gruppen. Navnet er enten en gruppe oprettet af institutionen eller et af de fast definerede gruppenavne i UNI•Login - Alle, Elever og Ansatte.

Anker
hovedgruppenavn
hovedgruppenavn
hovedgruppenavn

String

Gruppenavnet på en elevs hovedgruppe. For grundskoler er hovedgruppen lig elevens klasse.

Anker
gruppetype
gruppetype
gruppetype

String

Typen af gruppe.  En af værdierne: ”Hovedgruppe”, ”Årgang”, ”Retning”, ”Hold”, ”SFO”, ”Team” eller ”Andet”

Anker
udbydernr
udbydernr
udbydernr

String

Seks-tegns registreringsnummer, som identificerer en udbyder (kan indeholde bogstaver og tal)

Anker
udbydernavn
udbydernavn
udbydernavn

String

Udbydernavn

Anker
ejernr
ejernr
ejernr

String

Seks-tegns registreringsnummer, som identificerer en ejer af projektgrupper (kan indeholde bogstaver og tal)

Anker
seriekode
seriekode
seriekode

String

Skal være entydig inden for en udbyder

Anker
serienavn
serienavn
serienavn

String

Beskrivende navn for en serie af tjenester. Serier oprettes til gruppering af udbyderens tjenester. Unikt inden for udbyderen

Anker
tjenestekode
tjenestekode
tjenestekode

String

Skal være entydig inden for en udbyder

Anker
tjenestenavn
tjenestenavn
tjenestenavn

String

Beskrivende navn for en tjeneste. Skal være entydigt inden for en udbyder.

Anker
url
url
url

String

Link til materialet eller tjenesten.

Anker
matplatid
matplatid
matplatid

String

Reference til materialet eller tjenestens ”matplat-id” på Materialeplatformen https://materialeplatform.emu.dk. Her kan der hentes forenklede fælles mål, fag og klassetrin mv. vedr. materialet.

Anker
projektgruppekode
projektgruppekode
projektgruppekode

String

Skal være entydig inden for en udbyder

Anker
projektgruppenavn
projektgruppenavn
projektgruppenavn

String

Beskrivende navn for en projektgruppe. Unikt inden for udbyderen.

Anker
fradato
fradato
fradato

Date

Startdato på formen: YYYY-MM-DD

Anker
tildato
tildato
tildato

Date

Slutdato på formen: YYYY-MM-DD

Anker
gruppetrin
gruppetrin
gruppetrin

String

Klassens/stamgruppens trin. En af følgende værdier: DT, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, U1, U2, U3, U4, VU, Andet. DT er dagtilbud, 1 svarer til 1. klassetrin i grundskolen, U1 er første trin på en ungdomsuddannelse. VU er voksenuddannelse.

Anker
elevtrin
elevtrin
elevtrin

String

Elevens trin. En af følgende værdier: DT, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, U1, U2, U3, U4, VU, Andet. DT er dagtilbud, 1 svarer til 1. klassetrin i grundskolen, U1 er første trin på en ungdomsuddannelse. VU er voksenuddannelse.

Anker
ansatRolle
ansatRolle
ansatRolle

String"Lærer", "Pædagog", "Vikar", "Leder", "Ledelse", "TAP", "Konsulent"

Anker
eksternRolle
eksternRolle
eksternRolle

StringEn af følgende værdier: "Ekstern", "Praktikant"

Anker
elevRolle
elevRolle
elevRolle

String

En af følgende værdier: "Barn", "Elev", "Studerende"

Anker
initialer
initialer
initialer

String

Initialer for en ansat

Anker
stilling
stilling
stilling

String

Stillingsbetegnelse

Anker
reskode
reskode
reskode

String

Et tal, som er en statuskode defineret af den aktuelle webservice.

Anker
restekst
restekst
restekst

String

Kvitteringstekst.

Anker
antal
antal
antal

Num

Antal medlemmer i en gruppe

Anker
relation
relation
relation

String

Beskrivelse af kontaktpersonens relation til eleven. En af værdierne: ”Mor”, ”Far”, ”Andet”.

Anker
myndighed
myndighed
myndighed

Bool

Har personen forældremyndighed?

Anker
verifikation
verifikation
verifikation

Num

Er informationen vedrørende kontakten verificeret i CPR-registret af kildesystemet.

1=CPR-verificeret, 0=uverificeret

Anker
adgangsniveau
adgangsniveau
adgangsniveau

Num

0 (default) angiver at kontaktpersonen må få adgang til almindelige personoplysninger om den tilknyttede elev.

1 angiver at kontaktpersonen må få adgang til fortrolige og følsomme personoplysninger om eleven. NB. Hvis kontaktpersonen ikke er forældremyndighedsindehaver, skal hjemmel opnås på anden vis.

Anker
instXML
instXML
instXML

XML

XML dokument med data på en institution

Anker
svarXML
svarXML
svarXML

XML

XML format med fejlmeddelelser. Fejlmeddelelserne er henvendt til udviklere og lister fejlmeddelelsen samt den linje i XML filen, der fejler i forhold til skemaet.


Objekter

Objekter er det, der returneres fra metoderne. Et objekt rummer en eller flere attributter, men kan også rumme andre objekter. (Et objekt skrives med stort begyndelsesbogstav).

Objektnavn

Attributter

Anker
Institution
Institution
Institution

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, type, typenavn, type3, type3navn, adresse, bynavn, postnr, telefonnr, faxnr, mailadresse, www, kommunenr, kommune, admkommune, regionsnr, region

(Se feltdefinitioner i Institutionsregistret. Officielle oplysinger vedrørende institutioner stammer ligeledes herfra)

Anker
Brugertilknytning
Brugertilknytning
Brugertilknytning

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API/UNI-Login SkoleGrunddata Webservice API/UNI-Login SkoleGrunddata Webservice API

Anker
Bruger
Bruger
Bruger
UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Elevbruger
Elevbruger
Elevbruger

ElevTilknytning, UNI-Login SkoleGrunddata Webservice API, brugerid, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
InstBruger
InstBruger
InstBruger

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API?/UNI-Login SkoleGrunddata Webservice API?/UNI-Login SkoleGrunddata Webservice API?, [UNI-Login SkoleGrunddata Webservice API]

Anker
InstTilknytning
InstTilknytning
InstTilknytning

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API/UNI-Login SkoleGrunddata Webservice API/UNI-Login SkoleGrunddata Webservice API/UNI-Login SkoleGrunddata Webservice API

Anker
AnsatTilknytning
AnsatTilknytning
AnsatTilknytning

[UNI-Login SkoleGrunddata Webservice API]

Anker
EksternTilknytning
EksternTilknytning
EksternTilknytning

UNI-Login SkoleGrunddata Webservice API

Anker
ElevTilknytning
ElevTilknytning
ElevTilknytning

UNI-Login SkoleGrunddata Webservice API

Anker
ElevTilknytningMedHovedgruppe
ElevTilknytningMedHovedgruppe
ElevTilknytningMedHovedgruppe

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
KontaktTilknytning
KontaktTilknytning
KontaktTilknytning

UNI-Login SkoleGrunddata Webservice API

Anker
Elev
Elev
Elev

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Ansat
Ansat
Ansat

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Ekstern
Ekstern
Ekstern

UNI-Login SkoleGrunddata Webservice API

Anker
Kontakt
Kontakt
Kontaktperson

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Hovedgruppe
Hovedgruppe
Hovedgruppe

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Gruppe
Gruppe
Gruppe

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API?, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Udbyder
Udbyder
Udbyder

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Serie
Serie
Serie

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Tjeneste
Tjeneste
Tjeneste

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API?

Anker
Licens
Licens
Licens

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Projektgruppe
Projektgruppe
Projektgruppe

UNI-Login SkoleGrunddata Webservice API, projektgruppekode, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
GruppeMedAntal
GruppeMedAntal
GruppeMedAntal

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
ProjektgruppeMedAntal
ProjektgruppeMedAntal
ProjektgruppeMedAntal

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
GruppeLicens
GruppeLicens
GruppeLicens

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
ProjektgruppeLicens
ProjektgruppeLicens
ProjektgruppeLicens

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
Svar
Svar
Svar

UNI-Login SkoleGrunddata Webservice API, UNI-Login SkoleGrunddata Webservice API

Anker
XMLinst
XMLinst
XMLinst

UNI-Login SkoleGrunddata Webservice API

Anker
XMLsvar
XMLsvar
XMLsvar

UNI-Login SkoleGrunddata Webservice API