Integraation toteutus oppija controller -rajapintaan
Pähkinänkuoressa:
- Jokaiselle oppijalle voidaan luoda Opetushallituksen Oppijanumerorekisterin tuottama oppijanumero.
- Oppijanumeron luomiseen on olemassa batch-muotoinen rajapinta jolla voi tuoda yhden tai useita oppijoita.
- Tuontirajapinnat ovat autentikoituja rest-rajapintoja, lue lisää: Rajapintojen autentikaatio. Tutustu myös CAS-integraatioon.
- Opintohallintojärjestelmä käyttää annettua palvelukäyttäjätunnusta tunnistautumiseen. Palvelukäyttäjätunnukseen liitetty organisaatio määrittää minkä organisaation oppijaksi tieto liitetään.
- Kun oppija on liitetty organisaatioon, oppijalle ruvetaan tuottamaan muutostietorajapinnasta muutostietoja (esim. nimi- ja osoitemuutokset).
Alla olevassa kuvassa kuvataan kaikki käytössä olevat ominaisuudet.
Rajapintojen autentikaatio
Tuontirajapinnat ovat autentikoituja rest-rajapintoja, lue lisää: Rajapintojen autentikaatio. Tutustu myös CAS-integraatioon.
Rajapintaan toteutetut ominaisuudet
Oppijoiden tuonti
Kuvan kohta 1
- Hetullisia henkilöitä voi tuoda opintohallintojärjestelmästä rest-rajapinnan yli batch-muotoisesti. Samaa rajapintaa käytetään alkulatauksessa (tuodaan isompi massa), kuin yksittäisten pienempien erien tuonnissa.
- Rajapinta:
- Pakolliset tiedot
- Joku näistä: 1. OID/oppijanumero, 2. hetu, 3. passinumero tai 4. oppijan hakemukselle annettu sähköpostiosoite.
- Näitä tietoja käytetään oppijan kohdistamiseen ONR-kantaan
- Mitä kattavammat tiedot, sitä luotettavammin henkilön voi yksilöidä oppijanumerorekisterissä.
- Huom. passinumerotieto ei yhdisty hakemuspalvelusta mahdollisesti löytyvään passinumerotietoon automaattisesti mutta sitä voi käyttää yksilöivänä tietona duplikaattinäkymässä
- Voi lähettää kaikki, käytetään luotetuinta tietoa. Huom. Sähköpostitunnistetta ei suositella käytettäväksi
- Oppilasjärjestelmän tunniste oppijalle
- Palautuvan vastausdatan kohdistamiseen, mihin oppijaan liittyy
- etunimet
- hetuttomien ja ongelmatapausten selvittämiseen opintopolun päässä
- sukunimi
- hetuttomien ja ongelmatapausten selvittämiseen opintopolun päässä
- hetuttomien ja ongelmatapausten selvittämiseen opintopolun päässä
- kutsumanimi
- Kutsumanimen on oltava yksi etunimistä.
- kansalaisuus
- jos kansalaisuus on suomi, hetu vaaditaan
- Joku näistä: 1. OID/oppijanumero, 2. hetu, 3. passinumero tai 4. oppijan hakemukselle annettu sähköpostiosoite.
- Vapaaehtoiset tiedot
- sähköpostisoite
- Mihin voidaan lähettää batch-ajon lopputuloksen tieto.
- seuraavat tiedot ovat valinnaisia, mutta niiden tuontia suositellaan, sillä tietoja edellytetään, jotta hetuttoman henkilön voi yksilöidä ja hänelle voi muodostaa kansallisen oppijanumeron
- äidinkieli
- sukupuoli (mies 1, nainen 2)
- syntymäaika
- seuraavat valinnaiset tiedot voivat lisätä varmuutta yksilöintiin mutta niiden tuonnissa kannattaa huomioida, että tiedot saattavat vanheta.
- passinumero
- sähköpostiosoite
- sähköpostisoite
Kuvan kohta 2
- Kutsuva järjestelmä saa vastaukseksi batchId tunnisteen.
- Kutsuva järjestelmä voi kysellä tuonnin edistymistä batchId-rajapinnalla.
Kuvan kohta 3
- Perustietojen lisäksi palauttaa tuontiin liittyvät oppijat
- Rajapinta:
- Palautetaan jokaiselle oppijariville:
- Mihin opintohallintojärjestelmän tunnisteeseen henkilö liittyy
- Jos henkilö löytyy jo
- palautetaan henkilön oppijanumero ja muut tiedot.
- Muussa tapauksessa palautetaan luotu henkilö-oid.
- Oppijoiden sisäänluku on asynkroninen, kun tila "kasitelty": true. Oppijat on luettu sisään ja pitäisi palautua tilapäinen henkilö-oid ja/tai oppijanumero kaikille.
- Henkilö-oid on "alustava oppijanumero". Henkilö-oidista tulee oppijanumero kun oppija on merkitty yksilöilöidyksi.
- Tämän jälkeen jatketaan pollaamista muutosrajapinnan kautta (kohta 5). Jolloin tulee esimerkiksi VTJ-yksilöinnin tulos (joka on myös asynkroninen toiminto, voi kestää kauemmin).
ONR-muutostietorajapinta
Kuvan kohta 5
- ONR-muutostietorajapinta tarjoaa oppijaan kohdistuvia muutostietoja joita saadaan joko a) virkailijan tekemistä operaatioista b) VTJ:n muutos- tai yksilöintitietojen perusteella.
- Esimerkkejä muutoksista:
- Oppijanumeron vahvistuminen. (Oppijan yksilöinti, esim onnistunut vtj yksilöinti)
- Nimenmuutos
- Osoitteenmuutos
- Oppijan linkitys toiseen oppijaan (kuka on master)
- Passiivinen -tieto, joka indikoi, ettei henkilö ole enää aktiivinen VTJ:ssä (esim. kuoleman johdosta)
- Rajapinta:
- testiympäristössä: https://virkailija.testiopintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/getMuuttuneetUsingGET
- tuotantoympäristössä: https://virkailija.opintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/getMuuttuneetUsingGET
- Huomioi rajapinnan sivutustuki suuria muutosmääriä varten!
- Muutosrajapinta tarjoaa vastauksen aina organisaatiokohtaisesti:
- Listan joka sisältää oppijoiden henkilö-oideja ja oidiin liittyvän masterin tiedot.
- ONR palauttaa aina myös kaikki masteriin linkiteyt slave-oidit jotka liittyvät yhteen oppijaan omina tietoinaan. Eli muutoksen kohdistaminen onnistuu näin aina alkuperäisellä oidilla mikä on saatu oppijan tuonti -vaiheessa.
- Jos "oppijanumero"-kenttä löytyy masterista, kyseessä on yksilöity oppija
- Masterin tiedoista voi päätellä esimerkiksi hetun vaihtumiset, mahdollisen henkilö-oid-linkityksen ja osoitemuutokset.
- Listan joka sisältää oppijoiden henkilö-oideja ja oidiin liittyvän masterin tiedot.
Sähköpostin lähettäminen virkailijalle
Kuvan kohta 4a&b.
- Lähetetään email oppilaitosjärjestelmän virkailijalle batch importin tuloksesta (jos sähköpostiosoite on ilmoitettu, ks. kohta 1). Hetuttomia ja vääriä hetuja, duplikaatteja jne käsitellään käsin organisaation virkailijoiden toimesta opintopolun käyttöliittymässä. Suosittelemme käyttämään yhteiskäyttöistä sähköpostiosoitetta tähän tarkoitukseen.
- Katso kohta Käyttöliittymällä suoritettavat toiminnot.