...
Tuontirajapinnat ovat autentikoituja rest-rajapintoja, lue lisää: Rajapintojen autentikaatio. Tutustu myös CAS-integraatioon.
Swagger-dokumentaatio: Rajapinta oppija-controller
- Testi:https://virkailija.testiopintopolku.fi/oppijanumerorekisteri-service/swagger-ui/
- Tuotanto:https://virkailija.opintopolku.fi/oppijanumerorekisteri-service/swagger-ui/
Rajapintaan toteutetut ominaisuudet
...
- 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:
- testiympäristössä: https://virkailija.testiopintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/createUsingPUT tuotantoympäristössä: https://virkailija.opintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/createUsingPUT PUT/oppija
- 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
...
- Kutsuva järjestelmä saa vastaukseksi batchId tunnisteen.
- Rajapinta:
- testiympäristössä: https://virkailija.testiopintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/createUsingPUT tuotantoympäristössä: https://virkailija.opintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/createUsingPUT
- Tarvitset batch-id:tä, kun haet vastauksen.
- Batch-id vastauksen muoto on seuraavanlainen:
{ "id": 164087967, "kasiteltavia": 1, "kasiteltyja": 0, "kasitelty": false }
- Kutsuva järjestelmä voi kysellä tuonnin edistymistä batchId-rajapinnalla.
- Rajapinta:
- testiympäristössä: https://virkailija.testiopintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/getTuontiByIdUsingGET
- tuotantoympäristössä: https://virkailija.opintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/getTuontiByIdUsingGET
- Rajapinta:
Kuvan kohta 3
- Perustietojen lisäksi palauttaa tuontiin liittyvät oppijat
- Rajapinta:
- testiympäristössä: https://virkailija.testiopintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/getOppijatByTuontiIdUsingGET tuotantoympäristössä: https://virkailija.opintopolku.fi/oppijanumerorekisteri-service/swagger-ui/#/oppija-controller/getOppijatByTuontiIdUsingGETGet/oppija/tuonti={id}/perustiedot
- 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 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: GET/oppija/muuttuneet
- 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!
...