Arvo-API v. 2.0 -rajapintakokonaisuus on käytössä ammatillisen koulutuksen järjestäjillä. Ammattikorkeakoulut ja yliopistot käyttävät Arvo-API v. 1.0 -rajapintakokonaisuutta. Arvo-tiimi tiedottaa, kun Arvo-API v. 2.0 on käyttöönotettavissa myös yliopistoilla ja ammattikorkeakouluilla.
Alla olevaan taulukkoon on koottu Arvo-API v. 2.0 -rajapintojen kuvaukset. Tiedonkeruiden sisältöön kannattaa tutustua myös yhdessä oman organisaation Arvo-vastuukäyttäjän kanssa.
Tutustu myös Arvon rajapintojen Swaggeriin: https://arvo.csc.fi/api-docs/index.html#/export-v2
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
- Tiedonkeruiden sisällöt (mm. kysymykset, rakenne):
- ammatillisen opiskelijapalautteet: Kyselyiden sisältö (ammatillisen opiskelijapalautteet)
- ammatillisen työelämäpalaute: Kyselyt
- Arvon rajapintojen käyttöönotto ammatillisilla koulutuksen järjestäjillä
- Arvon yksinkertaistettu tietomalli löytyy palvelukortilta: Palvelukortti
Arvo-API v. 2.0 käyttö
Arvo-API v. 2.0 -rajapinnat ovat käytössä ammatillisen koulutuksen palautetiedonkeruissa:
- opiskelijapalaute: Ammatillisen opiskelijapalaute
- työelämäpalaute: Työelämäpalaute
Yleisiä huomioita
- rajapinnoissa päivämäärät ja kellonajat on ilmoitettu UTC-aikaleimoilla, aikaleiman mukana on aikavyöhyke, esim. 31.07.2023 15.04.23 UTC + 00
- kukin rajapintakäyttäjä voi vaihtaa omaan raportointiinsa käyttöön tarvitsemansa aikavyöhykkeen
- Suomen aikaa käyttäessä huomioitava kesä- ja talviaika
- kukin rajapintakäyttäjä voi vaihtaa omaan raportointiinsa käyttöön tarvitsemansa aikavyöhykkeen
- työelämäpalautteiden työpaikkaohjaajakyselyssä on toteutettu sekä niputettujen tunnusten että koko datan nouto
- oletuksena tunnukset annetaan rajapinnoista niputettuna
- uusia nippuja rajapintojen kautta on mahdollista saada 2 viikon välein
- kun haetaan työpaikkakyselyiden datoja, jaksot yhdistetään työpaikkakyselyn tunnukseen ja tämän pohjalta saadaan lista jaksoista ja listan pohjalta työpaikkajaksojen kesto
- Huomioi rajapintojen kautta tulevien datojen laatu, uusimpien tiedonkeruiden laatu on parempi kuin tiedonkeruun alkuaikoina
- Rajapintahaut on tarkoitus tehdä kuormituksen välttämiseksi kullekin koulutuksen järjestäjälle annettuna kellonaikana, ks. sivu Arvo-API:n porrastettu käyttöönotto.
- Palvelunestohyökkäyksiä ja muuta häirintää varten hakujen määrä on rajoitettu IP-osoitekohtaisesti 100 hakuun/minuutti. Määrän ylittäminen estää pyynnöt 10 minuutin ajaksi. Kun haet ensimmäisen kerran datoja, lataa kaikki ja sen jälkeen korkeintaan kerran päivässä uudet datat. Kun uusi tiedonkeruu alkaa, lataa tällöin ensimmäisen kerran kaikki ja sen jälkeen vain uudet datat.
Arvo-API v. 2.0:
Lokalisoitu teksti
Objekti joka sisältää tekstin kieliversiot, esim:
| Kenttä | Arvo |
|---|---|
| fi | Teksti suomeksi |
| sv | Text på svenska |
| en | Text in english |
Sivutus
Sivutettujen rajapintojen tiedot palautetaan Pagination-objektissa
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| data-key | String | avain jonka alla varsinainen tietosisältö on. Vaihtelee rajapinnoittain. esim. kohteet, vastaukset, muutetut_tunnukset, poistetut_tunnukset Tarkempi kuvaus swaggerissa |
| next_url | String | Seuraavan sivun osoite |
next_url-kentässä oleva seuraavan sivun pyyntö sisältää parametrit:
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| since | Int | Sivun alun määräävä id |
| limit | Int | Sivun pituu |
Tiedonkeruut (/api/export/v2/tiedonkeruut)
Sisältää valtakunnallisten tiedonkeruiden perustiedot. Vanhimpiin kyselyihin tieto tiedonkeruusta on lisätty jälkikäteen, tämän vuoksi tiedoissa voi olla puutteita.
Palauttaa listan koulutuksen järjestäjän tiedonkeruita (1/kysely/vuosi)
Parametrit
| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
| alkupvm | ISO-date | ei | Rajaa haetut tiedonkeruut voimassa_alkupvm perusteella. |
Tietosisältö
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| tunniste | String | Tiedonkeruun yksilöivä tunniste (kyselytyyppi-tarkenne-vuosi) Voi saada arvoja: 'ammatillisen opiskelijapalaute', 'tyopaikkaohjaajakysely', 'tyopaikkakysely' |
| kyselytyyppi | String | |
| tarkenne | String | Kyselytyypin tarkenne joka eriyttää saman kyselyn eri kohdejoukot esim. ammatillisen opiskelijapalautteessa voi saada arvoja aloittaneet, tutkinnon_osia_suorittaneet, tutkinnon_suorittaneet |
| vuosi | Int | Kertoo vuoden, jolloin kysely alkaa. Kyselyvuoteen haetaan tieto kyselyn voimassaolosta. Ammatillisen koulutuksen tiedonkeruissa tiedonkeruut eli kyselyt jakaantuvat kahdelle vuodelle, sillä tiedonkeruita tehdään rahoituskausittain (1.7.-30.6.). |
| voimassa_alkupvm | ISO-date | |
| voimassa_loppupvm | ISO-date | |
| nimi | Lokalisoitu teksti | Kyselyn nimi |
| johdantoteksti | Lokalisoitu teksti | Kyselyn valtakunnallinen johdantoteksti |
| kasittelyajan_paattymispvm | ISO-date | Käsittelyajan päättyminen esitetään muodossa pp.kk.vvvv. Jos kenttä on tyhjä, päättymisaika puuttuu. |
Kysely (/api/export/v2/kyselyt)
Kyselyt-rajapinta tarjoaa koulutuksen järjestäjän version valtakunnallisesta tiedonkeruusta, rajapinta sisältää valtakunnallisten kysymysten lisäksi omat kysymykset ja muokatut johdantotekstit sekä uudelleenohjauslinkin.
Palauttaa listan kyselyitä, tiedonkeruun tunnisteella tai kyselyid:llä rajattuna useimmissa tapauksissa aina yhden.
Parametrit
| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
| kyselyid | Int | kyllä (ellei tiedonkeruu-parametria) | Hakee kyselyn id:llä |
| tiedonkeruu | String | kyllä (ellei kyselyid-parametria) | Hakee tiedonkeruuseen kuuluvat kyselyt (lähes aina 1 kpl) |
Tietosisältö
Kysely sisältää koko kyselylomakkeen hierarkisena dokumenttina (kysely->kysymysryhmät->kysymykset->monivalintavaihtoehdot)
ISO-date
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| kyselyid | Int | Kyselyn yksilöivä id |
| kyselytyyppi | String | |
| tiedonkeruu | String | Tiedonkeruun tunniste Vanhimpiin kyselyihin tieto tiedonkeruusta on lisätty jälkikäteen, tämän vuoksi tiedoissa voi olla puutteita. |
| nimi | Lokalisoitu teksti | Kyselyn nimi (pääotsikko lomakkeella) |
| johdantoteksti | Lokalisoitu teksti | Kyselyn johdantoteksti |
| uudelleenohjaus_url | String | Kyselyn uudelleenohjauksen osoite, jos asetettu |
| voimassa_alkupvm | ISO-date | |
| voimassa_loppupvm | ISO-date | |
| kysymysryhmät | Lista kysymysryhmiä | |
| koulutustoimija_oid | String (koodiarvo) | Valtakunnallisille rajapintakäyttäjille, esim. Vipunen, tarkoitettu tietosisältö. Yksittäisen koulutuksen järjestäjän ei tarvitse käyttää tätä tietoa Kysely-rajapinnasta. Lisätty rajapintaan 9.4.2025. |
Kysymysryhmä
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| kysymysryhmaid | Int | Kysymysryhmän yksilöivä id |
| jarjestys | Int | Kysymysryhmän järjestys kyselyssä |
| nimi | Lokalisoitu teksti | Kysymysryhmän nimi (otsikko lomakkeella) |
| kuvaus | Lokalisoitu teksti | Kysymysryhmän kuvausteksti |
| kysymykset | Lista kysymyksiä | |
| jatkokysymykset | Lista kysymysryhmän jatkokysymysliitoksista |
Kysymys
Kyselyn kysymys tai väittämä
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| kysymysid | Int | Kysymyksen yksilöivä id |
| kysymysversio | Int | Kysymyksen versionumero, muodostaa uniikin id:n yhdessä kysymysid:n kanssa |
| jarjestys | Int | Kysymyksen järjestys kysymysryhmässä |
| kysymys | Lokalisoitu teksti | |
| ohjeteksti | Lokalisoitu teksti | |
| kysymystyyppi | String | Kertoo missä muodossa vastauksia on ollut mahdollista antaa, lisätietoja täältä: Arvon keskeiset käsitteet#Kysymystyyppi |
| metatiedot | Kysymyksen metatiedot | |
| monivalinta_max | Int | Monivalintakysymysten sallittujen valintojen maksimimäärä |
| pakollinen | Boolean | |
| eos_vastaus_sallittu | Boolean | |
| monivalintavaihtoehdot | Lista monivalintavaihtoehtoja |
Jatkokysymys
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| kysymysid | Int | Kysymys, josta jatkokysymys on riippuvainen |
| kysymysversio | Int | |
| jatkokysymysid | Int | Jatkokysymys, joka on ehdollisesti näkyvissä |
| jatkokysymysversio | Int | |
vastaus | String | Millä vastauksella jatkokysymys on näkyvissä Arvona joko string-esitys asteikon tai monivalintavaihtoehdon arvosta tai kyllä-ei kysymyksen tapauksessa 'kylla' tai 'ei' |
Monivalintavaihtoehto
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| kysymysid | Int | Kysymys johon vaihtoehto sisältyy |
| kysymysversio | Int | |
| jarjestys | Int | Vaihtoehdon järjestys |
| arvo | Int | Vaihtoehdon arvo (usein sama kuin järjestys muttei aina, esim. jos uuteen kysymysversioon on lisätty uusi vaihtoehto väliin) |
| teksti | Lokalisoitu teksti |
Kysymyksen metatiedot
| Kenttä | Tyyppi | Kysymystyyppi | Kuvaus |
|---|---|---|---|
| rahoitusmallikysymys | Boolean | kaikki | Metatieto, jonka avulla löytää helposti tiedonkeruussa mukana olevat rahoitukseen vaikuttavat kysymykset. Vastausvaihtoehtojen pisteytys kannattaa tarkistaa tiedonkeruuseen liittyvästä asetuksesta. |
| taustakysymyksen_tyyppi | String | kaikki | kenttä, jonka avulla on helppo poimia kyselylomakkeella olleita kysymyksiä taustatiedoiksi raportoinnissa. Voi saada esim. arvoja: 'sukupuoli', 'ika', 'aidinkieli' |
| min | Int | luku | Lukukysymyksen maksimiarvo |
| max | Int | luku | Lukukysymyksen minimiarvo |
| decimals | Int | luku | Lukukysymyksen desimaali-tarkkuus |
| eos_teksti | Lokalisoitu teksti | En osaa sanoa-valinnan kustomoitu teksti. | |
| koodisto | String (koodiarvo) | Alasvetovalikko | Koodiston nimi, josta alasvetovalikko-tyyppisen kysymyksen vastausten selitteet löytyvät. Tällä hetkellä tuetaan vain Opintopolusta löytyviä numeroarvollisia koodistoja. |
| teema | String | ||
| ei_vastaus_ensin | Boolean | kylla_ei | Näytetäänkö ei-vaihtoehto ensimmäisenä |
Vastaajatunnukset (/api/export/v2/vastaajatunnukset)
Tiedonkeruuseen/kyselyyn luodut vastaajatunnukset
Parametrit
| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
| tiedonkeruu | String | Kyllä, ellei kyselyid-parametria | Tiedonkeruu, johon kohteet kuuluvat (käytännössä aina 1 kysely) |
| kyselyid | Int | Kyllä, ellei tiedonkeruu-parametria | Kysely johon kohteet kuuluvat |
| alkupvm | String (YYYY-MM-DD) | Ei | Päivämäärä josta alkaen kohteet haetaan, verrataan vastaajatunnuksen luontiaikaan |
| niputtamattomat | Boolean | Ei | Näytä niputtamattomat tunnukset. Huom. Työpaikkaohjaajakyselyn niputtamattomille tunnuksille ei ole laskettu työpaikkajakson kestoa. |
| vain-vastatut | Boolean | Ei | Näytä pelkästään tunnukset joihin on vastattu |
| since | Int | Sivutuksen parametri | |
| limit | Int | Sivun pituus |
Tietosisältö
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| vastaajatunnusid | Int | Yksilöi vastaustapahtuman |
| tunnus | String | 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. |
| kyselyid | Int | Kysely johon vastaajatunnus kuuluu |
| tiedonkeruu | String | Tiedonkeruu johon vastaajatunnus kuuluu |
| oppilaitoskoodi | String (koodiarvo) | Tilastokeskuksen oppilaitoksille antama koodi. Huom: Oppisopimustoimistoilla ei ole Tilastokeskuksen oppilaitoskoodia joten ne täytyy tunnistaa Opetushallituksen oppilaitos_oid:n avulla. |
| oppilaitos_oid | String (oid) | OPH:n organisaatiopalvelun oid oppilaitokselle |
| taustatiedot | Taustatiedot | Kyselytyyppikohtaiset vastaajasta kerätyt taustatiedot |
| voimassa_alkupvm | ISO-Date | Tunnuksen voimassaolon alkupvm (YYYY-MM-DD) |
| voimassa_loppupvm | ISO-Date | Tunnuksen voimassaolon päättymispvm (YYYY-MM-DD) |
| nippu | String | Niputettujen tunnusten nipun tunniste, käytössä työpaikkaohjaajakyselyssä. Työpaikkakyselyn data tarjotaan rajapinnassa vasta sitten, kun niputus on tehty. Oletuksena rajapinnassa on käytössä parametri Niputetut ja tunnukset näkyvät viiveellä lähetyspäivänä. Jos koulutuksen järjestäjä haluaa datat käyttöönsä rajapinnan kautta ennen niputusta, käytä Boolean-parametriä Tulossa: Työpaikkakyselyn itsenäisen niputtamisen nippujen tunniste. Tuotantoonmenon aikataulu: 1.7.2025. |
| koulutustoimija_oid | String (koodiarvo) | Valtakunnallisille rajapintakäyttäjille, esim. Vipunen, tarkoitettu tietosisältö. Yksittäisen koulutuksen järjestäjän ei tarvitse käyttää tätä tietoa Tiedonkeruut-rajapinnasta. Lisätty rajapintaan 9.4.2025. |
Taustatiedot
Kohteet-rajapinnan kautta haettavat taustatiedot ovat vastaajatunnuksen luomisvaiheessa tunnukselle asetettuja taustatietoja ja ne haetaan tietovarastosta järjestelmän kautta luotaville tunnuksille. Ne eivät sisällä vastaajan antamia taustatietoja. Koodimuotoiset taustatiedot annetaan koodiarvoina, jotka pitää itse yhdistää Opetushallituksen Koodistopalvelusta saataviin selitteisiin, ks. Koodistopalvelu.
Oidit ja oppilaitoskoodiin liittyvät tiedot löytyvät Opintopolun Organisaatiopalvelusta ja muut edellä mainitusta Koodistopalvelusta. Näiden rajapinnat ovat julkisia, mutta käyttöä varten tarvitsee luoda Caller-ID, ks. Opintopolun ohjesivut Organisaatiopalvelu ja Kutsujan tunnisteen (caller-id) lisääminen rajapintakutsuihin.
| Kenttä | Tyyppi | Kyselytyyppi | Kuvaus |
|---|---|---|---|
| tutkinnon_suorituskieli | String (koodiarvo) | ammatillisen opiskelijapalaute | Tutkinnon suorituskieli 2-merkkinen kielikoodi |
| tutkinto | String (koodiarvo) | ammatillisen opiskelijapalaute työpaikkaohjaajakysely | Tilastokeskuksen 6-numeroinen tutkintokoodi |
| toimipiste | String | ammatillisen opiskelijapalaute työpaikkaohjaajakysely | Toimipistekoodi, Opetushallituksen Organisaatiopalvelun koodiarvo |
| toimipiste_oid | String (oid) | ammatillisen opiskelijapalaute työpaikkaohjaajakysely | OPH:n organisaatiopalvelun oid toimipisteelle |
| osaamisala | [String (koodiarvo)] | ammatillisen opiskelijapalaute | Lista Opintopolun osaamisala-koodiston arvoja. Voi olla tyhjä lista. |
| tutkinnonosat_hankkimistavoittain | {"oppisopimus":[String(koodiarvo)], "koulutussopimus": [String(koodiarvo], "oppilaitosmuotoinenkoulutus": [String(koodiarvo) } | ammatillisen opiskelijapalaute (2024 kyselystä alkaen) | |
| hankintakoulutuksen_toteuttaja | String (y-tunnus) | ammatillisen opiskelijapalaute | Hankintakoulutuksen toteuttajan y-tunnus |
| osaamisala | [String (koodiarvo)] | työpaikkaohjaajakysely | Lista Opintopolun osaamisala-koodiston arvoja |
| tutkintonimike | [String (koodiarvo)] | työpaikkaohjaajakysely | Lista Opintopolun tutkintonimikkeet-koodiston arvoja |
| tutkinnon_osa | String (koodiarvo) | työpaikkaohjaajakysely | Opintopolun tutkinnon osat -koodiston arvo |
| paikallinen_tutkinnon_osa | String | työpaikkaohjaajakysely | Paikallisen tutkinnonosan nimi |
| osaamisen_hankkimistapa | String | työpaikkaohjaajakysely | Osaamisen hankkimistapa. 'oppisopimus' tai 'koulutussopimus' |
| tyonantaja | String (y-tunnus) | työpaikkaohjaajakysely työpaikkakysely | Työpaikan y-tunnus |
| tyopaikka | String | työpaikkaohjaajakysely työpaikkakysely | Työpaikan nimi |
| tyopaikka_normalisoitu | String | työpaikkaohjaajakysely työpaikkakysely | Työpaikan nimen siistitty versio josta poistettu isot kirjaimet, erikois- ja välimerkit ym. Käytetään työpaikkojen tunnistamiseen. |
| tyopaikkajakson_alkupvm | ISO-date | työpaikkaohjaajakysely | |
| tyopaikkajakson_loppupvm | ISO-date | työpaikkaohjaajakysely | |
| osa_aikaisuus | Int | työpaikkaohjaajakysely | Työpaikkajakson osa-aikaisuus % Osa-aikaisuus sisältyy keston laskentaan, sitä ei tarvitse enää erikseen laskea kestoon mukaan. Huomaa, että tiedonkeruukaudella 1.7.2022-30.6.2023 osa-aikaisuus on poistettu keston laskennasta kaikilta. |
| tyopaikkajakson_kesto | Int | työpaikkaohjaajakysely | Työpaikkajakson kesto päivinä. Tiedonkeruukausilla 1.7.2021-30.6.2022 sekä 1.7.2022-30.6.2023 työelämäpalautteiden kestoja laskettiin poikkeuksellisesti uudelleen takautuvasti. Arvon rajapintojen kautta on tarjolla vain uudelleen lasketut kestot. |
| oppisopimuksen_perusta | String (koodiarvo) | työpaikkaohjaajakysely | Opintopolun oppisopimuksen perusta -koodiston arvo. 01 = työ-, virka- tai palvelussuhde , 02 = yrittäjä |
| tiedonkeruu_alkupvm | ISO-date | työpaikkakysely | Työpaikkakyselyyn liittyvien työpaikkajaksojen aikavälin alkupvm. Käytetään poimittaessa työpaikkakyselyn tunnuksiin liittyviä jaksoja Kuvattu tarkemmin osiossa Työpaikkajaksojen yhdistäminen työpaikkakyselyn tunnuksille |
| tiedonkeruu_loppupvm | ISO-date | työpaikkakysely | |
| herätepvm | ISO-date | ammatillisen opiskelijapalaute | herätepvm. on koulutuksen järjestäjän tallentama tieto, joka laukaisee palautteen keräämisen prosessin, esim. HOKSin ensikertaisen hyväksymisen päivämäärä |
Vastaus (/api/export/v2/vastaukset)
Yksittäisen vastauksen tiedot. Monivalintakysymysten tapauksessa jokainen valittu valihtoehto on oma vastauksensa, jolla on sama kysymysid ja vastaajaid.
Parametrit
| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
| tiedonkeruu | String | kyllä (ellei kyselyid-parametria) | |
| kyselyid | Int | kyllä (ellei tiedonkeruu-parametria) | |
| alkupvm | ISO-date | ei | vastausajan alkupvm |
| loppupvm | ISO-date | ei | vastausajan päättymispvm |
| since | Int | ei | Sivutuksen parametri |
| limit | Int | ei | Haluttu sivun pituus, oletuksena 50 000 riviä |
Tietosisältö
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| vastausid | Int | Vastauksen yksilöivä id |
| vastaajaid | Int | Vastaajan yksilöivä id (jos samalla tunnuksella on useampi vastaaja) |
| vastaajatunnusid | int | Vastaajan yksilöivä id |
| kyselyid | Int | Kysely, johon vastaus kuuluu |
| tiedonkeruu | String | Tiedonkeruu johon vastaus kuuluu |
| kysymysid | Int | Kysymys johon vastaus liittyy |
| kysymysversio | Int | Kysymysversio johon vastaus liittyy |
| vastausaika | Aikaleima | |
| numerovalinta | Int | Valintatyyppisten kysymysten vastaus:
|
| vapaateksti | String | Vapaatekstikysymyksen vastaus |
| vaihtoehto | String | kyllä/ei kysymyksen vataus, saa arvot 'kylla' ja 'ei' |
| luku | Double | lukukysymyksen vastaus |
| en_osaa_sanoa | Boolean | Onko kysymyksen EOS-valinta valittu (tällöin muissa sisätökentissä ei ole mitään) |
| koodi | String | Opetushallituksen Koodistopalvelun koodi sisältää myös mahdolliset etunollat käyttöön 18.12.2024 |
Muutetut tunnukset (/api/export/v2/muutetut-tunnukset)
Palauttaa muuttuneet tunnukset.
Työpaikkaohjaajakyselyn tapauksessa kaikki tunnukset päivitetään siinä vaiheessa kun ne lisätään nippuihin ja työpaikkajakson kesto lasketaan.
Parametrit
| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
| tiedonkeruu | String | Kyllä (ellei kyselyid-parametria) | tiedonkeruun tunniste |
| kyselyid | Int | Kyllä (ellei tiedonkeruu-parametria) | kyselyn id |
| alkupvm | ISO-date | Ei | Mistä alkaen muutetut tunnukset näytetään |
| since | Int | Ei | Sivutuksen parametri |
| limit | Int | Ei | Sivun pituus |
Tietosisältö
Sama kuin vastaajatunnukset-rajapinnassa.
Poistetut tunnukset (/api/export/v2/poistetut-tunnukset)
Palauttaa poistettujen vastaajatunnusten id:t ja poistoajat, jotta ne voi poistaa omasta tietovarastosta.
Parametrit
| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
| tiedonkeruu | String | Kyllä (ellei kyselyid-parametria | Tiedonkeruun tunniste |
| kyselyid | Int | Kyllä (ellei tiedonkeruu-parametria) | Kyselyn id |
| alkupvm | ISO-date | Ei | Mistä alkaen poistetut tunnukset näytetään |
Tietosisältö
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| vastaajatunnusid | String | Poistetun tunnuksen vastaajatunnusid |
| poistettuaika | ISO-date | Poiston päivämäärä |
Tietojen haku rajapinnoista:
Opiskelijapalautteet:
Kyselyn tietojen haku:
- Hae
/tiedonkeruurajapinnasta tiedonkeruut ja etsi niistä haluttu tiedonkeruu kyselytyypillä, tarkenteella (jos tarvetta) ja tiedonkeruuvuodella.- esim. ammatillisen opiskelijapalaute, aloittaneet, 2024
- tiedonkeruun tunniste on aina muotoa kyselytyyppi-tarkenne-vuosi joten tämä on myös pääteltävissä
- Hae kyselyn sisältö
/kyselyt-rajapinnasta tiedonkeruun tunnisteella- Tämä riittää tehdä kerran sen jälkeen kun mahdolliset omat kysymysryhmät on lisätty kyselyyn
- Tiedonkeruun alun jälkeen kyselyn sisältö ei enää muutu
Vastausdatan haku:
- Hae halutulla aikavälillä (esim. päivittäin tai viikoittain) tiedonkeruun uudet vastaajatunnukset /vastaajatunnukset-rajapinnasta
- Yhdistetään kyselyyn
kyselyid:n perusteella
- Yhdistetään kyselyyn
- Hae mahdolliset muuttuneet tunnukset
/muuttuneet-tunnukset-rajapinnasta - Hae vastausdata
/vastaukset-rajapinnasta- Yhdistetään tunnuksiin
vastaajatunnusid:n perusteella ja kysymyksiinkysymysid:n perusteella Vastaajaidyksilöi vastaajan (esim. ryhmätunnusten tapauksessa, jolloinvastaajatunnusidei riitä)- Monivalintakysymyksissä jokainen vastaajan valitsema vaihtoehto on oma vastauksensa
- Yhdistetään tunnuksiin
Työpaikkaohjaajakysely:
Toimii muuten samoin kuin opiskelijapalaute paitsi että vastaajatunnuksia ei oletuksena palauteta luontihetkellä.
Tunnukset niputetaan ryhmissä vastattaviksi työpaikkaohjaajille ja työpaikkajaksojen kestot lasketaan vasta niputtamisen yhteydessä.
- "Keskeneräiset" tunnukset saa tarvittaessa niputtamattomat-parametrilla
- Normaalitapauksissa tunnukset kannattanee hakea pelkästään /muuttuneet-tunnukset rajapinnasta (ellei ole tarvetta saada tunnusten lukumääristä reaaliaikaista tietoa) koska kaikki tullaan joka tapauksessa päivittämään luontihetken jälkeen.
Työpaikkajaksojen yhdistäminen työpaikkakyselyn tunnuksille
Työpaikkajaksot (eli työpaikkaohjaajakyselyn tunnukset) yhdistetään työpaikkakyselyn tunnuksille seuraavasti:
Työpaikkakyselyn tunnukseen liittyvät ne jaksot, joilla:
tyonantajajatyopaikka_normalisoitutaustatiedot ovat samatJaksotunnuksen tyopaikkajakson_loppupvm on työpaikkakyselyn tunnuksen
tiedonkeruu_alkupvmjatiedonkeruu_loppupvmvälissä- Jaksotunnuksen
oppisopimuksen_perustaon jotain muuta kuin02(yrittäjä)
Tätä kautta liitetyistä jaksotunnuksista voi tarvittaessa laskea työpaikkakyselyn tunnukselle työpaikkajaksojen yhteiskestot, tutkinnot, tutkinnon osat ym.