Arvo-API v. 1.0 tietosisältö

Arvo-API v. 1.0 -rajapintakokonaisuus on käytössä ammattikorkeakouluilla ja yliopistoilla.

Alla olevaan taulukkoon on koottu lisätietoa rajapinnan tietosisältöön liittyen. Lisäksi kyselyiden sisältöön kannattaa tutustua yhdessä oman organisaation Arvo-vastuukäyttäjän kanssa.

Rajapintojen kautta käyttöön saa sekä valtakunnallisen datan että koulutuksen järjestäjän oman datan eli omat kysymykset ja niihin liittyvät vastaukset.

Myös seuraavat linkit saattavat antaa vastauksia kysymyksiin tietosisältöön liittyen:

Keskeisiä käsitteitä
Tiedonkeruulomakkeen rakenne ja sisällöt: Tiedonkeruulomakkeen sisältö
Eri kysymystyypit ja asteikot: Kysymysryhmän luominen ja muokkaaminen#Kysymystyypit
Eri kyselyiden sisältö (mm. kysymykset, rakenne ja muutokset)

Yliopistojen uraseurantojen rajapintakäytön ohjeistus: Yliopistojen uraseurantojen datojen rajapintakäyttö

Huomioita Arvo-API:n v. 1.0 käyttöön:

Suosittelemme käyttämään kohteet-rajapintaa vastaajat-rajapinnan sijaan. Rajapinta on sisällöltään identtinen kohteet-rajapinnan kanssa, mutta voi olla hyödyllistä hakea vastaamattomat tunnukset esim. myöhässä tulleiden vastausten (eli vastaaja siirtyy kyselyyn mutta palaa vastaamaan myöhemmin) tapauksessa.
Teethän rajaukset mielellään kyselyyn tai tiedonkeruuseen rajattuna.

Tarkennuksia Arvo-API v. 1.0 -rajapintojen tietosisältöön:

Rajapinta	Käytössä kyselytyypeillä (tiedonkeruissa)	Käyttötarkoitus	Siirtyvä tieto	Sivutus	Parametrit	Tarkennuksia
kyselykerrat	AVOP KANDIPALAUTE REKRYKYSELY URASEURANTA AMMATILLISEN OPISKELIJAPALAUTE TYÖELÄMÄPALAUTE DIGIKYVYKKYYS MOVE!	Kyselykerrat ovat kansioita vastauksille. Kyselykerrat rajapinta tarjoaa kyselyiden ja niihin liittyvien kansioiden (kyselykertojen) voimassaolo- ja tilatietoa sekä tiedon käytetystä kyselypohjasta (kansallisesta kysymyspatteristosta).	kyselykerran tiedot: kyselykertaid nimi kyselyvuosi kyselyn tiedot: kyselyid nimi tyyppi tila voimassaolo tiedonkeruun tunniste käytetyn kyselypohjan tiedot: kyselypohjaid tarkenne nimi	ei	ei	tyyppi string-muotoinen kenttä, joka kertoo mistä tiedonkeruusta on kyse. Voi saada arvoja: 'avop', 'kandipalaute', 'rekrykysely', 'amk-uraseuranta', 'yo-uraseuranta', 'amispalaute', 'tyoelamapalaute', 'tyopaikkakysely' 'itsearviointi', 'move'* ) itsearviointi = digikyvykkyyden itsearviointi kyselypohja_tarkenne* string-muotoinen kenttä, joka voi saada arvoja: KANDIPALAUTE: ekonomit, laakarit, tek ** AVOP: amk, yamk AMMATILLISEN OPISKELIJAPALAUTE: aloittaneet, tutkinnon_osia_suorittaneet, tutkinnon_suorittaneet Kyselypohjat poistuvat Arvosta käyttöliittymäuudistuksen myötä. Kyselypohja_tarkenne -kenttään ohjataan Arvo-API v. 1.0:ssa tiedonkeruu-rajapinnan tunniste-kentän sisältö 20.12.2023 lähtien. ) poistuneet tiedonkeruusta 1.1.2021 alkaen kysely_tila** string-muotoinen kenttä, joka voi saada arvoja: 'julkaistu', 'suljettu', 'luonnos' voimassaolo tarkoittaa alkamispäivää ja päättymispäivää kyselypohjan tiedoissa nimi siirretään vain suomeksi
kysely_kysymysryhmä	AVOP KANDIPALAUTE URASEURANTA AMMATILLISEN OPISKELIJAPALAUTE TYÖELÄMÄPALAUTE DIGIKYVYKKYYS MOVE!	Rajapinta tarjoaa kyselyiden ja kysymysryhmien suhteet eli mitkä kysymysryhmät kyselyyn sisältyy ja mikä on niiden järjestys kyselyssä. Raportoinnin kannalta oleellisin data on järjestys, jos tämä ei ole koulutuksen järjestäjän raportoinnissa mukana, tätä rajapintaa ei ole tarpeen kutsua.	kyselyn tiedot: kyselyid kysymysryhmän tiedot: kysymysryhmäid järjestys	ei	kyselyid	Kyselyiden sisältöön kannattaa tutustua yhdessä oman organisaation Arvo-vastuukäyttäjän kanssa. Kaikkien kyselyiden sisällöstä löytyy tietoa myös wikistä. Huomioithan muutokset eri tiedonkeruuvuosien välillä! Järjestys antaa järjestysnumeron.
kysymykset	Korkeakoulut: AVOP KANDIPALAUTE URASEURANTA Ammatillisen koulutuksen järjestäjät: AMMATILLISEN OPISKELIJAPALAUTE TYÖELÄMÄPALAUTE Muu raportointi: DIGIKYVYKKYYS MOVE!	Kysymykset rajapinnan kautta saa kyselyissä käytetyt kysymysryhmät (kyselyn otsikkotaso) ja kysymykset kieliversioineen sekä kysymysten järjestys ja keskinäiset suhteet (jatkokysymykset). Saatavilla myös tieto rahoitusmalliin sisältyvistä kysymyksistä.	kysymysryhmän tiedot: kysymysryhmä kysymysryhmäid kysymyksen tiedot (esim): kysymys järjestys kysymysryhmässä taustakysymyksen tyyppi jatkokysymys valtakunnallinen rahoitusmalli koodisto vastaustyyppi	ei	kyselyid	kysymysryhmä tarkoittaa kysymysryhmän nimeä suomi, ruotsi, englanti kysymys tarkoittaa kysymystekstiä suomeksi, ruotsiksi ja englanniksi järjestys kysymysryhmän sisällä vastaustyyppi string-muotoinen kenttä, joka kertoo missä muodossa vastauksia on ollut mahdollista antaa. Voi saada arvoja: 'arvosana4_ja_eos'*, 'arvosana7', 'nps', 'arvosana6', 'arvosana6_ja_eos', 'arvosana', 'likert_asteikko', 'monivalinta', 'kylla_ei_valinta', 'asteikko5_1', 'valiotsikko', 'luku', 'alasvetovalikko', 'vapaateksti' ) ja_eos -tyyppiset asteikot ovat vaikeimmin tulkittavia ja siksi poistumassa. Vastaukset saavat arvoja kuten: :arvosana4-ja-eos {1 "En pysty arvioimaan" 2 "2" 3 "3" 4 "4" 5 "5"} :arvosana6-ja-eos {0 "0" 1 "1" 2 "2" 3 "3" 4 "4" 5 "5" 6 "En pysty arvioimaan"} taustakysymyksen tyyppi string-muotoinen kenttä, jonka avulla on helppo poimia kyselylomakkeella olleita kysymyksiä taustatiedoiksi raportoinnissa. Voi saada esim. arvoja: 'sukupuoli', 'ika', 'aidinkieli', 'tietojen luovutus', 'tietojen yhdistäminen', 'teema' HUOM! AVOP, KANDIPALAUTE Huomioithan vastaajan antaman suostumuksen luovuttaessasi aineistoa tutkimuskäyttöön! Taustakysymyksiin annetut vastaukset löydät taustakysymyksen tyypin perusteella: 'tietojen_luovutus', 'tietojen_yhdistaminen' jatkokysymys koostuu kahdesta tiedosta: jatkokysymys (kyllä/ei) ja jatkokysymys_kysymysid kategoria Kysymyksen metatiedot. Voi sisältää ainakin muut täällä olevat kentät. valtakunnallinen Kysymykseen liitetty metatieto, jonka avulla tunnistaa tiedonkeruussa mukana olevat kansallisesti yhtenäiset kysymykset. Muut kysymykset ovat organisaationne omia lisäkysymyksiä. rahoitusmallikysymys Kysymykseen liitetty metatieto, jonka avulla löytää helposti tiedonkeuussa mukana olevat rahoitukseen vaikuttavat kysymykset. Vastausvaihtoehtojen pisteytys kannattaa tarkistaa tiedonkeruuseen liittyvästä asetuksesta. teema Kysymykseen liitetty metatieto, jonka avulla voi hyödyntää tiedonkeuussa mukana olevia teemoja. Teemat käytössä tiedonkeruussa: KANDIPALAUTE koodisto** Koodiston nimi josta vastausten selitteet löytyvät. Tällä hetkellä tuetaan vain opintopolusta löytyviä numeroarvollisia koodistoja.
monivalintavaihtoehdot	AVOP KANDIPALAUTE URASEURANTA AMMATILLISEN OPISKELIJAPALAUTE TYÖELÄMÄPALAUTE DIGIKYVYKKYYS MOVE!	Rajapinta tarjoaa vastausvaihtoehdot monivalinta-tyyppisiin kysymyksiin. Yhdessä edellisten rajapintojen kanssa, monivalintavaihtoehtoja on mahdollista hyödyntää jo ennen tiedonkeruun alkua ja luoda raporttipohja valmiiksi vastausaineistoa varten.	kysymyksen tiedot: kysymysid järjestys kieliversiot	ei	kyselyid
vastaukset	AVOP KANDIPALAUTE URASEURANTA AMMATILLISEN OPISKELIJAPALAUTE TYÖELÄMÄPALAUTE DIGIKYVYKKYYS MOVE!	Vastaukset rajapinnan kautta saa kysymyksiin annetut vastaukset ja niihin liittyvä vastaaja- ja vastaajatunnustieto.	vastausid kyselykertaid kyselyid kysymysid vastaajatunnusid vastausaika numerovalinta vapaateksti vaihtoehto koulutustoimija monivalintavaihtoehto	kyllä	alkupvm loppupvm since limit kyselyid	vastausaika ilmoittaa päivämäärän koulutustoimija Ilmoitetaan y-tunnuksella. monivalintavastausvaihtoehto Saa arvoikseen monivalinta-vaihtoehdoista ne, joihin on annettu vastauksia. HUOM! Kaikki vaihtoehdot saa ladattua rajapinnasta: monivalintavaihtoehdot. 29.11.2022 saakka vastaukset-rajapinnassa on tehty päivämäärien käsittelyä päiviä (date) vertailemalla, 29.11.2022 eteenpäin aikaleimojen (time stamp) avulla. Tämä tarkoittaa, että jos koulutuksen järjestäjä hakee datoja vastaukset-rajapinnasta käyttämällä rajausta päivämäärien mukaan, voi loppupäivämäärä jäädä haun ulkopuolelle, jolloin rajapinta ei palauta datoja. Jos käytät vastaukset-rajapinnan haussa päättymispäivämäärää, saat puuttuvat datat käyttöösi lataamalla ne uudelleen 29.11.2022 lähtien. Sivutusta käyttäessä vastaukset-rajapinta toimii kuten ennenkin.
vastaajat Suosittelemme käyttämään kohteet-rajapintaa vastaajat-rajapinnan sijaan.	AVOP KANDIPALAUTE URASEURANTA AMMATILLISEN OPISKELIJAPALAUTE TYÖELÄMÄPALAUTE DIGIKYVYKKYYS MOVE!	Rajapinnan kautta saa vastaajat ja niihin liittyvien vastaajatunnusten tarkemmat tiedot.	kyselykerran tiedot: kyselykertaid vastaajatunnuksen tiedot: vastaajatunnusid vastaajatunnus vastaaja-id tunnuksen voimassaolo oppilaitos taustatiedot	kyllä	since limit kyselyid nayta_vastaamattomat voimassa_alkupvm	vastaajatunnusid yksilöi vastaustapahtuman vastaajatunnus string-muotoinen kenttä, jonka merkkimäärä voi vaihdella 5-7 merkin välillä riippuen tiedonkeruusta. Vastaajatunnus sisältää 1 tai useamman vastausmahdollisuuden eli vastaajatunnus voi toistua aineistossa. vastaaja-id integer-muotoinen kenttä, joka yksilöi vastaajan. tunnuksen voimassaolo ilmoittaa alkamispäivämäärän ja päättymispäivämäärän taustatiedot Vastaajat-rajapinnan kautta haettavat taustatiedot ovat vastaajatunnuksen luomisvaiheessa tunnukselle asetettuja taustatietoja. Joko virkailija syöttää ne tunnusta luodessaan käyttöliittymän kautta tai ne haetaan tietovarastosta järjestelmän kautta luotaville tunnuksille. Eivät sisällä vastaajan antamia taustatietoja. Taustatiedot vaihtelevat kyselytyypin mukaan. nayta_vastaamattomat -parametria voi hyödyntää kaikkien luotujen tunnusten hakuun. Tietoja voi käyttää kohdejoukon koon tarkasteluun tai esim. katoanalyyseihin. HUOM! Kaikissa kyselyissä koko kohdejoukolle ei ole olemassa tunnuksia.
opiskeluoikeudet	AVOP KANDIPALAUTE	Rajapinnan kautta on mahdollista hakea vastaajatunnuksen ja Virran opiskeluoikeuden suhteet.	vastaajatunnuksen tiedot: vastaajatunnus vastaajan tiedot: opiskeluoikeus	ei		Vain HAKA-kirjautumisen ja kyselyynohjauksen kautta vastanneista tallentuu opiskeluoikeustieto. HUOM! Opiskeluoikeustiedon hyödyntämistä varten kannattaa tutustua korkeakoulujen toimittamiin ohjeisiin henkilötiedonkäsittelystä (AMK ohjeet, YO ohjeet) sekä tarkistaa mitä oma korkeakoulu (tietosuojailmoitus ja tarkentavat tiedot: AVOP, Kandipalaute) on kertonut vastaajalle tietojen yhdistämisestä rekisteritietoihin. Huomioithan myös vastaajan antaman suostumuksen luovuttaessasi aineistoa tutkimuskäyttöön! (kts. kysymykset-rajapinta)
luodut_tunnukset	AMMATILLISEN OPISKELIJAPALAUTE TYÖELÄMÄPALAUTE	Rajapinta tarjoaa koosteen kuukausittain luoduista tunnuksista kyselykertaa kohden. Samat tiedot saa kohteet-rajapinnasta ja nämä tiedot voi ryhmitellä koulutuksen järjestäjälle parhaalla tavalla.	kyselykerran tiedot: kyselykertaid oppilaitoskoodi tutkintotunnus kuukausi tunnusten määrä vastauskertojen määrä	ei	kyselyid	kuukausi sisältää vuosiluvun ja kuukauden (yyyymm) tunnusten määrä ilmoittaa lukumäärän vastauskertojen määrä ilmoittaa kaikkien tunnusten vastauskertojen lukumäärän
kohteet Suosittelemme käyttämään kohteet-rajapintaa vastaajat-rajapinnan sijaan.	AVOP KANDIPALAUTE URASEURANTA AMMATILLISEN OPISKELIJAPALAUTE TYÖELÄMÄPALAUTE DIGIKYVYKKYYS MOVE!	Rajapinnan kautta saa vastaajatunnukset ja niihin liittyvät tarkemmat tiedot.	kyselykerran tiedot: kyselykertaid vastaajatunnuksen tiedot: vastaajatunnusid vastaajatunnus vastaaja-id tunnuksen voimassaolo oppilaitos taustatiedot	kyllä	since limit kyselyid (pakollinen) nayta_vastaamattomat voimassa_alkupvm	vastaajatunnus string-muotoinen kenttä, jonka merkkimäärä voi vaihdella 5-7 merkin välillä riippuen tiedonkeruusta. Vastaajatunnus sisältää 1 tai useamman vastausmahdollisuuden eli vastaajatunnus voi toistua aineistossa. taustatiedot Vastaajat-rajapinnan kautta haettavat taustatiedot ovat vastaajatunnuksen luomisvaiheessa tunnukselle asetettuja taustatietoja. Joko virkailija syöttää ne tunnusta luodessaan käyttöliittymän kautta tai ne haetaan tietovarastosta järjestelmän kautta luotaville tunnuksille. Eivät sisällä vastaajan antamia taustatietoja. Taustatiedot vaihtelevat kyselytyypin mukaan. Yliopistojen uraseurannoissa (maisterit ja tohtorit) taustatietoja on tarjolla vuoden 2021 tiedonkeruusta lähtien. nayta_vastaamattomat -parametria voi hyödyntää kaikkien luotujen tunnusten hakuun. Tietoja voi käyttää kohdejoukon koon tarkasteluun tai esim. katoanalyyseihin. Kohteet-rajapinnassa kyselyid on pakollinen parametri. HUOM! Kaikissa kyselyissä koko kohdejoukolle ei ole olemassa tunnuksia.
tiedonkeruut	AVOP KANDIPALAUTE URASEURANTA AMISPALAUTE TYÖELÄMÄPALAUTE DIGIKYVYKKYYS MOVE!	Valtakunnallisten tiedonkeruiden perustiedot	nimi tarkenne vuosi selite tunniste käsittelyajan päättymispäivä voimassaolo kyselytyyppi selite	ei	ei	Otettu käyttöön Arvo-API v. 1.0 -rajapintakokonaisuuteen 29.8.2023. Lisätty 3.10.2023 rajapintaan kyselytyyppi, nimi, selite ja voimassaolo sekä hakuehdoksi kysely-id:n rinnalle tiedonkeruun tunniste. Kyseessä on uusi Arvo-APIn rajapinta, muutos ei riko koulutuksen järjestäjien toteutuksia. String-muotoisia kenttiä, voimassaolo kertoo kyselyn voimassaolon Arvossa. Käsittelyajan päättyminen esitetään muodossa pp.kk.vvvv. Jos kenttä on tyhjä, päättymisaika puuttuu. Vanhimpiin kyselyihin tieto tiedonkeruusta on lisätty jälkikäteen, tämän vuoksi tiedoissa voi olla puutteita.

Page tree

Arvo-API v. 1.0 tietosisältö

Tarkennuksia Arvo-API v. 1.0 -rajapintojen tietosisältöön: