Koulutuskalenterin JSON-rajapinta

Päivitetty viimeksi: 21.3.2019

Tässä ohjeessa on kerrottu Wilman koulutuskalenterin JSON-rajapinnasta saatavista tiedoista ja niiden formaatista.

Koulutuskalenterin koko listauksen saa JSON-muodossa osoitteella wilmaurl/browsecourses/index_json. Muista Wilman sivuista poiketen koulutuskalenterin tietojen saamiseksi JSON-rajapinnasta ei tarvita Visman myöntämää kehittäjäavainta. Myöskään login-tunnuksia ei tarvita, sillä kaikki koulutuskalenteriin laitettu materiaali on julkista. JSON-rajapinta on aina käytössä, kun koulutuskalenteri on käytössä, eli JSON-rajapintaa ei tarvitse asettaa erikseen päälle eikä sitä voi kytkeä erikseen pois.

Lisätiedot saadaan osoitteella wilmaurl/browsecourses/popup?short-term=18383&school-id=4&format=json. Tällä voidaan myös hakea useampi koulutus lisäämällä short-term-parametriin korttinumeroita pilkulla erotettuna. Pitkäkestoisia koulutuksia voi hakea long-term-parameterilla. Pilkku pitää enkoodata muotoon %2C, esimerkiksi wilmaurl/browsecourses/popup?short-term=18383%2C19895&school-id=4&format=json.

Haettavat tiedot voi hakea myös oppilaitoksittain. Esimerkiksi wilmaurl/browsecourses/index_json?school-id=4 palauttaa koulutukset oppilaitokselta, jonka korttinumero on 4.

Parametrit

Parametri	Tarkoitus
short-term	Pilkulla erotettu lista lyhytkestoisista eli kurssimuotoisista koulutuksista.
long-term	Pilkulla erotettu lista pitkäkestoisista eli tutkintoon tähtäävistä koulutuksista.
school-id	Oppilaitoksen korttinumero
format	Toistaiseksi ainoa mahdollinen arvo "json".
langid	Kieli. Mahdolliset arvot 1, 2, 3 ja tyhjä, joista 1 ja tyhjä = suomi, 2 = ruotsi ja 3 = englanti.
callback	asettaa JSON-vastauksen olion callback-parametrissä annettun funktion parametriksi. Esimerkiksi ...&callback=parseJSON palauttaa tuloksena parseJSON({...})
readablejson	asettaa JSONin selkokieliseen muotoon

Isoilla ja pienillä kirjaimilla ei ole merkitystä toimivuuden suhteen.

Koulutukset jaotellaan oppilaitoksittain ja näiden sisällä lyhyt- ja pitkäkestoisiin. Oppilaitokset päättävät itse, mitä tietoja ja lisätietoja koulutuksista näytetään julkisesti ja millä otsikoilla.

JSON-vastauksessa kaikkien tietojen listaus koostuu pääasiassa seuraavista olioista:

Oppilaitos, jolla on nimi, tunniste ja kategoriat.
Kategoria, jolla on nimi, tyyppi, oppilaitoksen korttinumero ja koulutukset.
Koulutus, jolla on tunniste, tyyppi ja näytettävät tiedot.

Avaimet

Avain	Tarkoitus
Id	Entiteetin korttinumero
Caption	Loppukäyttäjälle näkyvä nimi
Categories	Kategoriat
Type	Tyyppi, lyhyt- tai pitkäkestoinen eli "short" tai "long"
SchoolId	Oppilaitoksen korttinumero
PaymentMethod	Maksutapa. Mahdolliset arvot 0, 1, 2 ja 3, joista 0 = maksutapaa ei ole merkitty, 1 = lasku, 2 = lasku tai verkkopankki ja 3 = pakotettu verkkopankkimaksu.
Headers	Oppilaitoksen valitsemat otsikot näytettäville tiedoille
Courses	Koulutukset
Cells	Loppukäyttäjälle näkyvät tiedot koulutuksesta. Yhtenä koulutuksena näkyvän rivin solut.

Huom. PaymentMethod-avaimet ovat käytössä Wilman 2.18-versiosta eteenpäin.

Muita tietoja

Avain	Tarkoitus
NoSMTPCheckRequiredCourses	Lyhytkestoiset koulutukset, jotka eivät vaadi sähköpostivahvistusta.
NoSMTPCheckRequiredSchoolings	Pitkäkestoiset koulutukset, jotka eivät vaadi sähköpostivahvistusta.
CorporationFormsOK, esim. [4,5]	Tyyppiä string, suluissa koulut, joilla yrityspuolen hakulomakkeet on kunnossa.

Lisätiedot JSON-muodossa

Mikäli lisätiedot ovat täytetty, niin lisätiedoista palautetaan JSON-lista, jossa on koulutuksia, joiden tietueina on x-määrä avain-arvo-pareina oppilaitoksen valitsemia tietoja, jossa avain on valittu otsikko ja tietona tiedoksi valitun kentän tai kenttien tiedot.