Opintopolku korkeakouluille, valmistelut

• Palvelun osoite: URL-osoite, josta tietoja haetaan.
• KirjautumisURL: URL-osoite, johon Primus kirjautuu hakiessaan rajapinnasta tietoja saatuaan tiketin tikettipalvelulta.
• Tikettipalvelun URL: URL-osoite, johon Primus ottaa yhteyttä saadakseen "lipun" eli tiketin tiedon tuomista varten.
• REST käyttäjätunnus: korkeakoulukohtainen käyttäjätunnus, jolla kirjaudutaan Opintopolkuun. Käyttäjätunnusta ja salasanaa tarvitaan rajapintasiirron autentikointia varten.
• REST salasana: salasana, joka liittyy Opintopolun käyttäjätunnukseen.
• GET/POST: valintakenttä, johon valitaan arvo "GET" aina kun jostain haetaan tietoa, "POST" aina kun tietoa muutetaan.
• REST parametrit: tieto, jonka perusteella rajapinnasta haettavia tuloksia lähdetään rajaamaan. Opintopolun kutsuparametrit löytyvät CSC:n sivuilta.
• REST parametrien oletusarvot: jos parametrinä käytetään hakukohdetta, tähän syötetään sen hakukohteen numero/arvo, johon liittyvät hakemukset halutaan siirtää Hakijat-rekisteriin.

Lisäksi Tiedoston tyyppi -valintakenttään on lisätty arvo "REST/JSON", joka täytyy olla valittuna Opintopolku-siirtoa varten.

Loaderiin tehdään määritelmä niistä tiedoista, joita Primukseen halutaan siirtää. Koska kyseessä on rajapinta, varsinaista siirtotiedostoa ei missään vaiheessa tarvitse muodostaa ja tallentaa, vaan tiedot haetaan suoraan kohderekisteriin. Loaderille täytetään kentät Nimi, Kanta, Tiedoston tyyppi, Määritys sekä alussa mainitut uudet kentät. Jos rajapinnasta siirretään tietoa Hakijat-rekisteriin, Kanta-kenttään kirjoitetaan "hakijat".

Määritys-kenttään määritellään ne tiedot, joita rajapinnasta halutaan hakea, ja mihin kenttiin ne siirretään kohderekisterissä. Tiedot määritellään seuraavanlaisesti: ensimmäiseksi osaksi laitetaan se rajapinnan osio/tieto, joka halutaan noutaa Primukseen. Tämän perään kirjoitetaan se Primuksen kentän nimi, johon tieto halutaan siirtää kohdekannassa. Tieto ja kenttä erotellaan toisistaan pilkulla, ja Primuksen kentän nimi laitetaan lainausmerkkeihin. Jos rajapinnasta esimerkiksi noudetaan hakijan henkilötunnus, kirjoitetaan määritelmään: hetu,"Henkilötunnus".