Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

KenttäTyyppiKuvaus
tunnisteString

Tiedonkeruun yksilöivä tunniste (kyselytyyppi-tarkenne-vuosi)

Voi saada arvoja:'ammatillisen opiskelijapalaute', 'tyopaikkaohjaajakysely', 'tyopaikkakysely'

kyselytyyppiString


tarkenneString

Kyselytyypin tarkenne joka eriyttää saman kyselyn eri kohdejoukot

esim. ammatillisen opiskelijapalautteessa voi saada arvoja aloittaneet, tutkinnon_osia_suorittaneet, tutkinnon_suorittaneet 

vuosiInt

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_alkupvmISO-date


voimassa_loppupvmISO-date


nimiLokalisoitu teksti

Kyselyn nimi

johdantotekstiLokalisoitu teksti

Kyselyn valtakunnallinen johdantoteksti

kasittelyajan_paattymispvmISO-date

Käsittelyajan päättyminen esitetään muodossa pp.kk.vvvv. Jos kenttä on tyhjä, päättymisaika puuttuu.

koulutustoimija_oidString (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.

Kysely (/api/export/v2/kyselyt)

...

KenttäTyyppiKuvaus
vastaajatunnusidIntYksilöi vastaustapahtuman
tunnusStringString-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.
kyselyidInt

Kysely johon vastaajatunnus kuuluu

tiedonkeruuString

Tiedonkeruu johon vastaajatunnus kuuluu

oppilaitoskoodiString (koodiarvo)

Tilastokeskuksen oppilaitoksille antama koodi. 

Huom: Oppisopimustoimistoilla ei ole Tilastokeskuksen oppilaitoskoodia joten ne täytyy tunnistaa Opetushallituksen oppilaitos_oid:n avulla.

oppilaitos_oidString (oid)

OPH:n organisaatiopalvelun oid oppilaitokselle

taustatiedot Taustatiedot

Kyselytyyppikohtaiset vastaajasta kerätyt taustatiedot

voimassa_alkupvmISO-Date

Tunnuksen voimassaolon alkupvm (YYYY-MM-DD)

voimassa_loppupvmISO-Date

Tunnuksen voimassaolon päättymispvm (YYYY-MM-DD)

nippuString

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ä niputtamattomat.

Tulossa: Työpaikkakyselyn itsenäisen niputtamisen nippujen tunniste. Tuotantoonmenon aikataulu: 1.7.2025.

koulutustoimija_oidString (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.

...