Page tree
Skip to end of metadata
Go to start of metadata

Generelt

API’er for webservices 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 på Tilslutning. Herefter kan der oprettes anmodninger om dataadgang for den pågældende service. Når en administrator hos den ansvarlige part godkender anmodningen i Tilslutning er der adgang til at trække data.

Services

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

Administrative services (adm) manipulerer data, hvor informationsservices (info) kun slår op.

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.

Services til straksopslag må kun kaldes i kontekst af et aktivt bruger-login. Services til straksopslag må således ikke anvendes til batch-opdatering af lokal cache.


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

wsBrugerid

StringSystembruger, som ejes af en udbyder

wsPassword

StringSystembrugerens password

brugerid

String

Unikt UNI•Login-brugerid

cpr

StringCPR-nummer

navn

String

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

instnr

String

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

instnavn

String

Institutionsnavn

gruppeid

String

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

hovedgruppeid

String

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

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.

hovedgruppenavn

String

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

gruppetype

String

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

udbydernr

String

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

udbydernavn

String

Udbydernavn

ejernr

String

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

seriekode

String

Skal være entydig inden for en udbyder

serienavn

String

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

tjenestekode

String

Skal være entydig inden for en udbyder

tjenestenavn

String

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

url

String

Link til materialet eller tjenesten.

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.

projektgruppekode

String

Skal være entydig inden for en udbyder

projektgruppenavn

String

Beskrivende navn for en projektgruppe. Unikt inden for udbyderen.

fradato

Date

Startdato på formen: YYYY-MM-DD

tildato

Date

Slutdato på formen: YYYY-MM-DD

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.

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.

ansatRolle

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

eksternRolle

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

elevRolle

String

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

initialer

String

Initialer for en ansat

stilling

String

Stillingsbetegnelse

reskode

String

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

restekst

String

Kvitteringstekst.

antal

Num

Antal medlemmer i en gruppe

relation

String

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

myndighed

Bool

Har personen forældremyndighed?

verifikation

Num

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

1=CPR-verificeret, 0=uverificeret

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.

instXML

XML

XML dokument med data på en institution

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

Institution

instnr, instnavn, 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)

Brugertilknytning

instnr, brugerid, navn, AnsatTilknytning/EksternTilknytning/ElevTilknytningMedHovedgruppe

Bruger
brugerid, navn

Elevbruger

ElevTilknytning, instnr, brugerid, navn, Hovedgruppe

InstBruger

instnr, brugerid, navn, Elev?/Ansat?/Ekstern?, [Gruppe]

InstTilknytning

instnr, AnsatTilknytning/EksternTilknytning/ElevTilknytning/KontaktTilknytning

AnsatTilknytning

[ansatRolle]

EksternTilknytning

eksternRolle

ElevTilknytning

elevRolle

ElevTilknytningMedHovedgruppe

elevRolle, hovedgruppeid, hovedgruppenavn

KontaktTilknytning

relation

Elev

ElevTilknytning, hovedgruppeid, hovedgruppenavn, elevtrin

Ansat

AnsatTilknytning, initialer, stilling

Ekstern

EksternTilknytning

Kontaktperson

instnr, brugerid, navn, relation, myndighed, verifikation, adgangsniveau

Hovedgruppe

instnr, gruppeid, gruppenavn, gruppetype, gruppetrin, fradato, tildato

Gruppe

instnr, gruppeid, gruppenavn, gruppetype, gruppetrin?, fradato, tildato

Udbyder

udbydernr, udbydernavn

Serie

seriekode, serienavn

Tjeneste

udbydernr, serienavn, seriekode, tjenestekode, tjenestenavn, url, matplatid?

Licens

Tjeneste, fradato, tildato

Projektgruppe

ejernr, projektgruppekode, projektgruppenavn, fradato, tildato

GruppeMedAntal

Gruppe, antal

ProjektgruppeMedAntal

Projektgruppe, antal

GruppeLicens

Gruppe, Licens

ProjektgruppeLicens

Projektgruppe, Licens

Svar

reskode, restekst

XMLinst

instXML

XMLsvar

svarXML