UNI login Importformat Feltdefinitioner

Transkript

1 UNI login Importformat Feltdefinitioner UNI login Importformat anvendes i forbindelse med import via webservicen wsaimport (ws10). WSDL definitionen for wsaimport (ws10) rummer den formelle definition i XML Schema format. Nedenfor er vist en skitse af den overordnede struktur i importformatet. 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. 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. UNILoginImport sourcedatetime DateTime 1 Tid for eksport af data fra kildesystemet f.eks: T17:00:00 Tidspunktet skal være nyere end tidspunktet for sidste eksport der er indlæst. source String 1 Navn på kildesystem. Navnet bruges sammen institutionens registreringsnummer til identifikation af importen. schoolyear String 1 Skoleår angivet på formatet YYYY-YYYY. Fx

2 sourceversion String 0-1 Versionsnummer på kildesystem. Kun information. Gemmes ikke i UNI Login. Institution Institution 1 Institution Institution InstitutionNumber String 1 Seks-tegns registreringsnummer, som identificerer en institution (kan indeholde både bogstaver og tal) InstitutionName String 0-1 Institutionsnavn. Kun information. Gemmes ikke i UNI Login. Group Group 0-n Grupper på institutionen InstitutionPerson InstitutionPerson 0-n Ansatte og elever på institutionen. Group Grupper bruges til samling af personer på en institution. Både elever og lærere kan tilknyttes grupper. En gruppe kan fx være klasser i grundskolen, hold, fag, studiegrupper eller lærerteams. Der er i gruppebegrebet ingen begrænsninger i forhold til hvad den enkelte institution vil bruge det til. GroupId String 1 GroupId bruges i skolernes infrastruktur (fx AD) og af udbydere i forbindelse med tildeling af adgang til tjenester. Det er derfor vigtigt at koordinere GroupId på tværs importkilder for at der ikke oprettes flere grupper med samme navn og for ikke at risikere at miste adgangen til tjenester ved skifte af importleverandør. Eksisterende grupper på en institution kan kortlægges med wsieksport, som importleverandører automatisk har adgang til, når der er givet adgang til wsaimport. Elever og lærere kan tilknyttes gruppen ved at angive MainGroupId eller GroupId på personen. GroupName String 0-1 Gruppenavn, som vises til brugere. GroupType Enum 1 Hovedgruppe, Årgang, Retning, Hold, SFO, Team eller Andet. Grupper der refereres til som maingroup fra et Person-objekt skal være af typen Hovedgruppe. GroupLevel Enum 0-1 Hovedgruppens/stamklassens 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. Skal angives for grupper med grouptype Hovedgruppe og kun da. Line String 0-1 Spor, linje, studieretning eller lign. for hovedgruppen/stamklassen. Skal angives for grupper med grouptype Hovedgruppe og kun da. For grundskoler fx B. FromDate Date 0-1 Gruppens startdato på formen

3 ToDate Date 0-1 Gruppens slutdato på formen InstitutionPerson LocalPersonId String 1 Den lokale identifikation af personen på institutionen. Identifikationen bruges til at genkende personer fra en import til den næste. Identifikationen skal derfor være unik inden for en import, således at <institutionnumber><source><localpersonid> skal være unik. Identifikationen skal være uforanderlig, således at en person der en gang er importeret med et LocalPersonId skal have det samme LocalPersonId i alle fremtidige importer. Person Person 1 Personoplysninger Student Student 0-1 Elevoplysninger om personen. (Student, Employee og Extern udelukker gensidigt hinanden) Employee Employee 0-1 Ansat person. (Student, Employee og Extern udelukker gensidigt hinanden) Extern Extern 0-1 Ikke-ansat person.(student, Employee og Extern udelukker gensidigt hinanden) Employee Role Enum 1-n Den ansattes roller: "Lærer", "Pædagog", "Vikar", "Leder", "Ledelse", "TAP", "Konsulent". ShortName String 0-1 Initialer Occupation String 0-1 Stilling Location String 0-1 Afdeling, bygning eller værelsesnu mmer på efterskoler. GroupId String 0-n De grupper medarbejderen er tilknyttet. Feltet skal indeholde gruppernes unikke id på institutionen GroupId. Extern Role Enum 1 Den ikke-ansattes rolle: "Ekstern" eller "Praktikant" Student Role Enum 1 Elevens Rolle: "Barn" for barn i dagtilbud, "Elev" for alle der går i skole eller "Studerende". StudentNumber String 0-1 Elevens studienummer fra lokalt administrativt system. Level Enum 1 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. Location String 0-1 Afdeling, bygning eller værelsesnu mmer på efterskoler.

4 MainGroupId String 1 Elevens hovedgruppe. For grundskoler elevens klasse og kan for andre institutioner for eksempel studieretning eller stamhold. Feltet skal indeholde gruppens unikke id på institutionen - GroupId. Skal udfyldes! MainGroiupId må kun referere til grupper med grouptype Hovedgruppe. GroupId String 0-n Yderligere grupper eleven er tilknyttet, ud over tilknytningen via MainGroupId. ContactPerson Contact-Person 0-10 Kontaktperson Feltet skal indeholde gruppernes unikke id på institutionen - GroupId. ContactPerson relation Enum 1 Kontaktpersonens relation til eleven. Skal udfyldes. En af værdierne: Mor, Far, Andet. childcustody Bool 1 Har personen forældremyndighed? Person Person 1 Personoplysninger på kontaktpersonen Person protected Bool 1 Har personen navne- og adressebeskyttelse? verificationlevel Enum 1 Er informationen vedrørende personen verificeret i CPR-registret? 1=CPR-verificeret, 0=uverificeret FirstName String 1 Fornavne. Feltet skal mindst indeholde et bogstav. FamilyName String 1 Efternavn. Feltet skal mindst indeholde et bogstav. CivilRegistrationNumber String 1 Personnummer.Bruges blandt andet til at se om personen allerede har et UNI Login på samme eller anden institution og derfor ikke skal have et nyt. Address RegEx 0-1 BirthDate String 0-1 Fødselsdato på formen Gender Enum 0-1 Personens køn. En af værdierne M, K. PhotoId String 0-1 Reference til foto i kildesystemet AliasFirstName String 0-1 Fornavne som importeres i UNI Login ved navn og adresse-beskyttelse. Feltet skal være angivet og mindst indeholde et bogstav ved navne- og adressebeskyttelse. AliasFamilyName String 0-1 Efternavn som importeres i UNI Login ved navn og adresse-beskyttelse. Feltet skal være angivet og mindst indeholde et bogstav ved navne- og adressebeskyttelse.

5 Address Address 0-1 Adresse HomePhoneNumber PhoneNumber 0-1 Hjemmetelefon WorkPhoneNumber PhoneNumber 0-1 Arbejdstelefon MobilePhoneNumber PhoneNumber 0-1 Mobiltelefon PhoneNumber protected Bool 1 Er telefonnummeret beskyttet? (element value) RegEx 1 Telefonnummer Address 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 alpha-2. Fx DK Country String 0-1 Adressens land MunicipalityCode String 0-1 Kommunekode MunicipalityName String 0-1 Kommunenavn