Rajapinnoista yleistä

Arvo - opetushallinnon vaikuttavuustietopalvelu hyödyntää useiden palveluiden rajapintoja järjestelmällä toteutetuissa tiedonkeruissa. Rajapintoja käytetään muun muassa taustatietojen hakemiseen, kyselytoteutusten automatisointiin että vastaajien kontaktointiin. Tiedonkeruissa kertynyt kysely- ja vastausdata viedään kansalliseen raportointiin Vipunen-palveluun Arvo-palvelun omien rajapintojen kautta. Myös koulutuksen järjestäjien organisaatiokohtaisen datan lataamista varten on omat rajapintansa (lisäpalvelu). Kaikki käytössä olevat rajapinnat on koottu sivulle Palvelun rajapinnat.

Arvo-API

Arvo-API on Arvoa käyttäville organisaatioille tarjottava lisäpalvelu, jonka tavoitteena on parantaa kerätyn palautedatan hyödynnettävyyttä ja käyttöä tiedolla johtamisen tukena. Se on usean REST-rajapinnan kokonaisuus, jonka avulla organisaatioiden on mahdollista tallentaa tietovarastoonsa Arvolla kerättyjen tiedonkeruiden kysely- ja vastausdata taustatietoineen. Rajapinnassa on tarjolla kulloinkin ne aineistot, joiden hyödyntämiseen koulutuksen järjestäjä on oikeutettu ja joiden tarjoamiseen rajapinnan kautta ei ole muita esteitä.

Vastausaineistojen siirtämiseen liittyy rajoitteita, joiden vuoksi kaikkea kyselyjärjestelmän kautta kerättyä vastausaineistoa ei voida tarjota rajapinnan kautta koulutuksen järjestäjille. Määrittäviä tekijöitä ovat henkilötietojen käsittelyn ohjeistukset (rekisterinpitäjä laatii, ohjeistukset eroavat tiedonkeruittain) ja tiedonkeruun vastausaineiston sijainti eli rajapintojen kautta on mahdollista siirtää aineistoja vain kyselyistä, joiden vastausaineisto on tallennettu Arvo-palvelun tietokantaan.

Arvo-API:a on mahdollista hyödyntää korkeakoulujen tiedonkeruiden datoissa (AVOP, Kandipalaute, ammattikorkeakoulujen uraseuranta, yliopistojen uraseuranta) sekä ammatillisen koulutuksen valtakunnallisissa palautedatoissa. Lisätietoja ja korkeakoulujen tilaukset sekä ammatillisten koulutuksen järjestäjien ilmoittautuminen mukaan käyttöönottoihin: arvo@csc.fi

Kysymyksen versioinnilla vaikutusta Arvo-API:n käyttöön

Kun Arvon tiedonkeruussa esiintyvään kysymykseen tulee muutos, kysymys versioidaan. Kysymyksen versiointi helpottaa tiedonkeruisiin sisältyvien valtakunnallisten kysymysmuutosten hallintaa CSC:n Arvon ylläpitäjille. Versiointi vaikuttaa Arvo-APIn rajapintakäytössä. Rajapintakutsujan tulee huomioida ID:n muodostumisperuste ja tehdä rajapintatoteutus siten, että koulutuksen järjestäjä ottaa rajapinnan kautta vastaan sekä kysymys-ID:n, kysymysversion että järjestyksen. Korkeakouluille rajapinnan kautta tulee uusi kenttä kysymysversio ja näin ollen toteutus ei enää voi nojata kysymys-ID:n ja järjestyksen uniikkiuteen. Versionumero näkyy myös Arvon käyttöliittymäkäyttäjille, tutustu ohjeistukseen.

Arvossa kysymyksen versiointi otettiin käyttöön 20.6.2023. Versoinnilla oli ensimmäisen kerran vaikutusta rajapintakäyttöön syksyllä 2023 ammattikorkeakoulujen ja yliopistojen uraseurantoissa, mihin mennessä toteutuksen muutokset oli tarvittaessa tehtävä.


Tutustu sisältöön:

Rajapinnan dokumentaatio Swaggerissa:



  • No labels