Eksport af grupper, medlemmer og kontaktpersoner

Vedligeholdes af

Institution

Formel WSDL servicebeskrivelse

Gyldig fra

Gyldig til

URL

juni 2021N/Ahttps://wsieksport.unilogin.dk/wsieksport-v6/ws?WSDL

Formål

Eksport webservicen anvendes til udtræk fra SkoleGrunddata. Data er baseret på det importerede, beriget med information fra Unilogin.

Unilogin SkoleGrunddata Eksportformat anvendes i forbindelse med eksport via webservicen ws17/wsiEKSPORT. WSDL definitionen for wsiEKSPORT rummer den formelle definition i XML Schema format.

Nedenfor er vist en skitse af den overordnede struktur i eksportformatet. Lister af elementer er angivet med stiplet ramme.


Tabel over felter og attributter

Tabellen beskriver de felter med tilhørende attributter, der kan importeres med de regler der gælder for hvert felt.

Nedenfor er objekter og attributter, som kun overføres i fuld- og mellem-pakken markeret med henholdsvis (F) og (FM). Felter uden markering forekommer i alle pakker. Felter markeret (MYNDIGHED) forekommer kun i myndighedspakken.

Bemærk konventionen: Feltnavne er med stort begyndelsesbogstav og attributnavne er med lille.

Angivelser af feltlængde for felter af typen ”String” er i forhold til utf8 tegnsætkodning, dvs. at visse tegn fylder to felter.

UNILoginExport

Felt

Type

Antal

Beskrivelse

exportDateTime

DateTime

1

Tid for eksport af data fra SkoleGrunddata

Fx: 2011-11-10T17:00:00

accessLevel

Token

1

En af værdierne: small, medium eller full

ImportSource

ImportSource

1-n

Importkilder, der refereres til fra eksportens Person-objekter

Institution

Institution

1

Institution

ImportSource

Felt

Type

Antal

Beskrivelse

sourceDateTime

DateTime

1

Tid for seneste eksport af data fra kildesystem på formen

Fx: 2011-11-10T17:00:00

source

String

1

Navn på kildesystem

schoolyear

String

1

Skoleår på formatet YYYY-YYYY

Fx: ”2016-2017”

Institution

Felt

Type

Antal

Beskrivelse

InstitutionNumber

String

1

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

InstitutionName

String

0-1

Institutionsnavn

Group

Group

0-n

Grupper på institutionen

InstitutionPerson

InstitutionPerson

0-n

Ansatte og elever på institutionen

Group

Felt

Type

Antal

Beskrivelse

GroupId

String

1

Gruppeid som er unikt og uforanderligt i hele sin levetid på institutionen.

Fx: "2016a"

GroupName

String

0-1

Gruppenavn

GroupType

Enum

1

Gruppetypen

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

GroupLevel

Enum

0-1

Hovedgruppens trin. Oplyses kun for grupper af typen ”Hovedgruppe”

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

Line

String

0-1

Spor, linje, studieretning eller lign. for hovedgruppen/stamklassen

Oplyses kun for grupper af typen ”Hovedgruppe”

For grundskoler fx: ”B”

FromDate

Date

0-1

Gruppens startdato på formen YYYY-MM-DD

ToDate

Date

0-1

Gruppens slutdato på formen YYYY-MM-DD

InstitutionPerson

Felt

Type

Antal

Beskrivelse

source

String

1

Angiver importkilden for den pågældende person

Refererer til Source i ImportSource

LocalPersonId

String

0-1

Den lokale identifikation af personen i institutionens kildesystem

Findes ikke i gamle importer

UNILogin

UNILogin

1

Unilogin-oplysninger

Person

Person

0-1

Personoplysninger

Student

Student

0-1

Elevoplysninger om personen

Employee

Employee

0-1

Læreroplysninger om personen

ExternExtern0-1

Ikke-ansat person

Employee

Felt

Type

Antal

Beskrivelse

RoleEnum1-n

Den ansattes roller

En af værdierne: Lærer, Pædagog, Vikar, Leder, Ledelse, TAP eller Konsulent

ShortName

String

0-1

Initialer

Occupation

String

0-1

Stilling

Location

String

0-1

Afdeling, bygning eller værelsesnummer på kostskoler

GroupId

String

0-n

De grupper medarbejderen er tilknyttet

Feltet indeholder gruppernes unikke id på institutionen

Extern

Felt

Type

Antal

Beskrivelse

RoleEnum1

Den ikke-ansattes rolle

En af værdierne: Ekstern eller Praktikant

GroupId

String

0-n

De grupper den eksterne medarbejder er tilknyttet. Feltet indeholder gruppernes unikke id på institutionen

Student

Felt

Type

Antal

Beskrivelse

RoleEnum1

Elevens Rolle

En af værdierne: Barn, Elev eller Studerende

StudentNumber

String

0-1

Elevens studienummer fra lokalt administrativt system

Level

Enum

1

Elevens trin

En af værdier: DT, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, U1, U2, U3, U4, VU eller Andet

DT er dagtilbud, 1 svarer til 1. klassetrin i grundskolen U1 er første trin på en ungdomsuddannelse

VU er voksenuddannelse

Location

String

0-1

Afdeling, bygning eller værelsesnummer på kostskoler

MainGroupId

String

1

Elevens hovedgruppe

For grundskoler elevens klasse og kan for andre institutioner for eksempel studieretning eller stamhold

MainGroiupId refererer til grupper med groupType ”Hovedgruppe”

GroupId

String

0-n

Yderligere grupper eleven er tilknyttet, ud over tilknytningen via MainGroupId.

ContactPerson

ContactPerson

0-10

Kontaktperson

ContactPerson

Felt

Type

Antal

Beskrivelse

relation

Enum

1

Kontaktpersonens relation til eleven

En af værdierne: Mor, Far, Andet eller Officielt tilknyttet person

childCustody

Bool

1

Har personen forældremyndighed

accessLevelEnum01

Bruges til autorisation i tjenester

En af værdierne: 1 eller 0

accessLevel=1 gives automatisk, hvis childCustody=yes

Hvis childCustody=no, skal hjemmel opnås på anden vis

Person

Person

1

Personoplysninger på kontaktpersonen

UNILogin

UNILogin

1

Unilogin-oplysninger

Person

Felt

Type

Antal

Beskrivelse

protected

Bool

1

Har personen navne- og adressebeskyttelse

verificationLevel

Enum

1

Er informationen vedrørende personen verificeret i CPR-registret

En af værdierne: 1=CPR-verificeret, 0=uverificeret

FirstName

String

1

Fornavne eller alias-navn ved navne- og adressebeskyttelse

FamilyName

String

1

Efternavn eller alias-navn ved navne- og adressebeskyttelse

CivilRegistrationNumber

String

1

Personnummer på formen DDMMYYXXXX

EmailAddress

String

0-1

E-mail

BirthDate

String

0-1

Fødselsdato på formen YYYY-MM-DD

Gender

Enum

0-1

Personens køn.

En af værdierne: M eller K

PhotoId

String

0-1

Reference til foto i kildesystemet

Address

Address

0-1

Adresse

HomePhoneNumber

PhoneNumber

0-1

Hjemmetelefon

WorkPhoneNumber

PhoneNumber

0-1

Arbejdstelefon

MobilePhoneNumber

PhoneNumber

0-1

Mobiltelefon

AliasFirstName

String

0-1

Alias-navn importeret ved navne- og adresse-beskyttelse

AliasFamilyName

String

0-1

Alias-nav importeret ved navne- og adresse-beskyttelse

PhoneNumber

Felt

Type

Antal

Beskrivelse

protected

Bool

1

Er telefonnummeret beskyttet

(element value)

String

1

Telefonnummer

Address

Felt

Type

Antal

Beskrivelse

StreetAddress

String

0-1

Adressens vejnavn, nr. og etage

PostalCode

String

0-1

Postnummer

PostalDistrict

String

0-1

By

CountryCode

String

0-1

Adressens landekode. i to tegn efter standarden ISO 3166-1 alpha-2.

Fx DK

Country

String

0-1

Adressens land

MunicipalityCode

String

0-1

Kommunekode

MunicipalityName

String

0-1

Kommunenavn

UNILogin

Felt

Type

Antal

Beskrivelse

UserId

String

1

Unikt brugerid (UniID)

InitialPassword

String


1

Ikke længere gyldig

En udbyder kan lave dataaftaler om udtræk af data i en lille, mellem eller fuld pakke. Hver pakke for sig kræver tilslutning og udgør en separat service ved indgåelse af aftaler om dataadgang i Tilslutning.

Ingen af ovennævnte pakker udstiller navn, CPR-nummer eller adresse fra CPR for navne- og adressebeskyttede personer. I stedet udstilles et alias-navn, som styres af de skoleadministrative systemer, der importerer data til Unilogin.

Udbydere med systemer, der løser myndighedsopgaver, kan blive tilsluttet en særlig myndighedspakke, som også udstiller data om beskyttede brugere (jfr. Dataaftale for eksport (ws17/wsiEKSPORT)).

Anmodning i Tilslutning til denne pakke skal suppleres med en supportsag, hvor formålet uddybes.

Support til Unilogin Integrationer og Webservices

wsiEKSPORT må maksimalt kaldes 4 gange pr. institution pr. dag

Metoder (Se Dataaftale for eksport (ws17/wsiEKSPORT) for detaljer)

Metodenavn

Returnerer

Beskrivelse

eksporterXmlLille (wsBrugerid, wsPassword, instnr)

XMLinst

Eksporterer institutionens data fra SkoleGrunddata.

eksporterXmlMellem (wsBrugerid, wsPassword, instnr)

XMLinst

Eksporterer institutionens data fra SkoleGrunddata udvidet med bl.a. CPR-numre.

eksporterXmlFuld (wsBrugerid, wsPassword, instnr)

XMLinst

Eksporterer institutionens data fra SkoleGrunddata udvidet med bl.a. CPR-numre, kontaktoplysninger og oplysninger om kontaktpersoner (Mor, Far, Andet, Officielt tilknyttet person)

eksporterXmlFuldMyndighed (wsBrugerid, wsPassword, instnr)XMLinstMyndighedspakke, som eksporterer samme data som fuld pakke inklusive data fra CPR om personer som er navne- og adressebeskyttede.

Styrelsen for It og Læring - Teglholmsgade 1 - 2450 København SV - www.stil.dk