Päiväys |
Tekijä |
Versio |
Muutoksen kuvaus |
22.11.22 |
Juhani |
|
Rajapinnan dokumentista poistettu viittaukset XML muotoon, koska jatkossa vain JSON muotoa tuetaan. |
Ilmoapix on ilmainen ja julkinen rajapinta kurssitietoihin.
Saatavilla on myös ilmoittautumisrajapinta, josta voi lisätietoja kysyä sähköpostitse api@grynos.com.
Avoimen rajapinnan käyttö on ilmaista niin kaupallisessa sekä ei-kaupallisessa tarkoituksessa. Yleisiä käyttörajoituksia ei ole, mutta Grynos Oy varaa oikeuden estää kohtuutonta rasitusta aiheuttavien osapuolten pääsyn rajapintaan.
Asiakkaan tietojen hallinta on selaimella katsottavissa.
Tietojen hallintaan tarvitaan käyttäjätunnus ja salasana, jotka saa Grynos Oy:ltä lähettämällä pyynnön sähköpostiosoitteeseen api@grynos.com.
Asiakas määrittää uudelleenohjausosoitteen, johon rajapinnan pyynnön vastaus aina palautetaan. Lisäksi asiakas voi muuttaa käyttäjätunnusta ja salasanaansa asiakaskäyttöliittymään.
Asiakaskäyttöliittymässä näkyy luotu rajapinta-avain (Api key), jota käytetään pyyntöjen yhteydessä.
Rajapinta käyttää REST-arkkitehtuuria. Rajapintaan tehdään HTTP GET pyyntö, jonka parametrit välitetään osoitteen query-osassa. Pyyntöön vastataan json muodossa.
Merkistönä käytetään utf-8. Rajapinta palauttaa rajoittamattoman määrän tuloksia, mutta sivutusta voi hallita parametreilla limit ja offset.
Jokaiseen pyyntöön on lisättävä mukaan rajapinta-avain (apikey), joka toimii pyyntöä suorittavan asiakasliittymän tunnisteena. Rajapinta-avain on annettava pyynnön header-osa, jossa 'apikey' avaimessa rajapinta-avaimen arvo.
Pyynnön hakuehdot asetetaan HTTP-polkuun. Kyselyn parametrit yhdistetään JA-konjunktiolla, jolloin tulokseen sisältyvät tietueet, jotka täsmäävät kaikkiin hakuehtoihin. Pilkuilla erotelluissa parametrien arvoissa käytetään TAI-konjunktiota.
Pyyntöjen parametrien kuvauksessa voi olla viittaus päivämäärään tai aikaan esim. 'vvkkpp', tällöin esiintyvillä merkeillä tarkoitetaan seuraavaa vv = vuosi kahdella numerolla, kk = kuukausi kahdella numerolla, pp = päivämäärä kahdella numerolla, hh = tunti kahdella numerolla, mm = minuutti kahdella numerolla ja ss = sekuntti kahdella numerolla.
Pyynnön rakenne on seuraavanlainen:
... /v1/[pyynnön parametrit]
Sisällöt tuotetaan oletusarvoisesti suomeksi, muut kielivaihtoehdot ovat Ruotsi ja englanti.
Parametri |
Sallitut arvot |
Kuvaus |
Oletus |
lang |
fi, en, sv |
Palautettavan tietueen kieliversio |
fi |
limit |
numero |
Rajoittaa tulosten määrää per sivu |
kaikki |
Offset |
numero |
Monennesta sivusta tulos aloitetaan |
0 |
Useita hakuehtoja käytettäessä tulos sisältää ne tietueet, jotka löytyvät kaikilla hakuehdoilla. Yksittäiseen hakuehtoon voi lisätä useita arvoja pilkulla eroteltuna, jolloin vähintään yhden arvon on täsmättävä.
Rajapintaan voi suorittaa testauspyynnön, jolloin palautetaan rajapinnan versionumero sekä palvelimen kellonaika.
Testauspyyntö (ei tarvitse rajapinta-avainta):
... /v1/ping
Vastaus palauttaa esimerkin mukaisen JSON objektin:
{
"message": "It's alive!",
"version": "v1.0.76 (3.1.2020)",
"timestamp": "Fri Jan 03 16:35:57 EET 2020"
}
Virheen sattuessa, palautusviestit sisältävät muuttujan ’error’. Joissain tilanteissa rajapinta saattaa palauttaa onnistuneesta pyynnöstä myös muuttujan 'error', mutta arvona on 'null'.
Jos pyyntö oli virheellinen rajapinta palauttaa HTTP virheen (404) Not Found, (401) Unauthorized tai (503) Service Unavailable.
Jos pyyntö oli oikein, mutta rajapinta ei pystynyt toteuttamaan pyyntöä, virheviesti palautetaan osana paluuviestiä.
Mallivastaus virheelliseen pyyntöön:
{
"error": {
"error_code": 2,
"message": "No permission, wrong apikey.",
"http_status_code": 401
}
}
Mallivastaus onnistuneeseen pyyntöön (OK):
{
"id": 123456,
"coursecode": "X181234",
…
}
Rajapinnan kuvausdokumentin HTML muodossa saa auki selaimella pyynnöllä (ei tarvitse rajapinta-avainta):
... /v1/docs
Rajapinnassa käytetään useissa pyynnöissä opiston id numeroa. Käytettävissä olevat opistot ja id:t saa haettua pyynnöllä
... /v1/company/all
Tässä dokumentissa olevissa pyyntöesimerkeissä opisto id:n paikka URLissa esitetään '[opistoid]'-merkkijonolla.
Parametri |
Tyyppi |
Kuvaus |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
format |
String |
Pyynnön vastauksen tyyppi. |
address |
Int |
Sisällytetäänkö hakutulokseen osoitetiedot (vain arvolla 1). |
contact |
Int |
Sisällytetäänkö hakutulokseen kontaktitiedot (vain arvolla 1). |
opening |
Int |
Sisällytetäänkö hakutulokseen opisto avoinna -tiedot (vain arvolla 1). |
Haku palauttaa opistosta seuraavat tiedot:
Atribuutti |
Kuvaus |
id |
Opiston id |
name |
Opiston nimi |
shortName |
Opiston lyhytnimi |
nameOfficial |
Opiston virallinen nimi |
discountAllowed |
Onko mahdollista saada alennuksia (jos määritelty opistolla) |
addressList |
Osoitelistaus osoitetyypeittäin |
contactList |
Kontaktilistaus kontaktityypeittäin |
openingList |
Opiston aukioloajat |
Atribuutti |
Kuvaus |
streetAddress |
Katuosoite |
postalCode |
Postinumero |
city |
Kaupunki |
type |
Osoitetyyppi |
cryptedAddress |
Katuosoite + kaupunki kryptattuna. Kryptausavain Grynos Keys -ohjelmasta. Omassa käytössä mm. kartan URL -parametrinä. |
Atribuutti |
Kuvaus |
contact |
Katuosoite |
type |
Kontaktityyppi id |
name |
Kontaktityyppi nimi |
Atribuutti |
Kuvaus |
beginTime |
Alkukellonaika |
endTime |
Loppukellonaika |
validBegin |
Alkupäivämäärä |
validEnd |
Loppupäivämäärä |
WeekDayName |
Viikonpäivän lyhytnimi |
freeText |
Vapaateksti |
Kutsun osoitteen muoto on seuraava:
... /v1/course/search?[parametrit]
Parametrit erotellaan toisistaan & -merkillä.
Kaikki kentät hyväksyvät monta valintaa kerralla pilkuin erotettuna listana (foo,bar,cur), ellei erikseen mainita. Osasta hakuehdoista tarkempi kuvaus mahdollisista arvoista alempana.
Parametri |
Tyyppi |
Kuvaus |
txt |
String |
Mikä tahansa teksti, joka voi löytyä kurssin nimesta, kuvauksesta yms. |
com |
String |
Opiston id numero. |
cgt |
Int |
Aineryhmän id numero. Voi sisältää vain yhden arvon. |
str |
String |
Opetuspaikan id numero. |
tar |
String |
Kohderyhmän id numero. |
tla |
String |
Opetuskielen id numero. |
tim |
String |
Aikarajaus. Vähintään yksi kurssin opetuskerroista järjestetään kyseisenä aikana. Voi sisältää vain yhden arvon. |
dat |
String |
Päivärajaus. Vähintään yksi kurssin opetuskerroista järjestetään kyseisenä päivänä. Voi sisältää vain yhden arvon. |
wkd |
Int |
Viikonpäivä. Vähintään yksi kurssin opetuskerroista järjestetään kyseisenä viikonpäivänä. |
lec |
String |
Luennot (vain arvolla 1). Voi sisältää vain yhden arvon. |
eve |
Int |
Tapahtumat (vain arvolla 1). Voi sisältää vain yhden arvon. |
cou |
Int |
Kurssit (vain arvolla 1). Sulkee hausta pois ”Luennot” ja ”Tapahtumat”. Voi sisältää vain yhden arvon. |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
ses |
Int |
Palauta myös opetuskerrat hakutuloksessa (vain arvolla 1). Voi sisältää vain yhden arvon. |
desc |
Int |
Palauta kuvaustekstit hakutuloksessa (vain arvolla 1). Voi sisältää vain yhden arvon. |
changed |
Int |
Palauta muuttuneet kurssit hakutuloksessa (vain arvolla 1). Voi sisältää vain yhden arvon. HUOM! Kun kysely sisältää 'changed'-parametrin, käytetään parametrejä 'dat' ja 'tim' määrittelemään aikaraja, jonka jälkeen muuttuneet kurssit palautetaan. |
format |
String |
Pyynnön vastauksen tyyppi. Voi sisältää vain yhden arvon. |
olec |
Int |
Verkkoluennot (vain arvolla 1). |
otea |
Int |
Verkko-opetus (vain arvolla 1). |
sip |
Int |
Kertalippuilmoittautumispaikkoja määritelty (vain arvolla 1). Voi sisältää vain yhden arvon. |
offset |
Int |
Monennestako tietueesta eteenpäin tuodaan rivejä haussa. Voi sisältää vain yhden arvon. |
limit |
Int |
Montako tietuetta tuodaan haussa. Voi sisältää vain yhden arvon. |
img |
Int |
Sisällytetäänkö hakutulokseen mahdollinen kurssiin liitetyn kuvan URL (vain arvolla 1). Voi sisältää vain yhden arvon. |
cids |
Int |
Palauttaa hakutuloksen kaikkien kurssin ID:t muuttujassa ’resultCRIDs’ (vain arvolla 1). Palauttaa kaikki pyynnön tuottamat kurssi ID:t, vaikka pyyntöön olisi määritelty 'limit' -parametri. |
order |
String |
Järjestetään hakutulos. Voi sisältää arvot 1, -1, 2, -2, ,3, -3. |
uni |
Int |
Avoin yliopisto (vain arvolla 1) |
future |
Int |
Vain tulevat kurssit. Voi sisältää vain yhden arvon. |
seats |
Int |
Vain kurssit, joilla tilaa. Voi sisältää vain yhden arvon. |
lnk |
Int |
Sisällytetäänkö hakutulokseen kurssin linkki-lista (vain arvolla 1). Voi sisältää vain yhden arvon. |
att |
Int |
Sisällytetäänkö hakutulokseen kurssin liitetiedosto urlit (vain arvolla 1). Voi sisältää vain yhden arvon. |
kw |
Int |
Sisällytetäänkö hakutulokseen kurssin avainsanat (vain arvolla 1). Voi sisältää vain yhden arvon. |
in_progress |
Int |
Näytä vain alkaneet kurssit, joihin voi ilmoittautua (vain arvolla 1). Voi sisältää vain yhden arvon. |
Arvo |
Selitys |
hhmmss |
Jos parametrinä yksi aika-arvo, tarkoittaa se alkukellon aikaa |
hhmmss_hhmmss |
Jos parametrinä kaksi aika-arvoa, erotellaan ajat toisistaa alaviivalla ”_”. Tällöin ensin annetaan alkuaika ja jälkimmäisena loppuaika. |
hhmm tai hh |
Parametristä voi jättää minuutti ja sekunttiarvon pois. |
Arvo |
Selitys |
vvkkpp |
Jos parametrinä yksi aika-arvo, tarkoittaa se alkupäivämäärää. |
vvkkpp_vvkkpp |
Jos parametrinä kaksi aika-arvoa, erotellaan ajat toisistaa alaviivalla ”_”. Tällöin ensin annetaan alkuaika ja jälkimmäisena loppuaika. |
Arvo |
Selitys |
0 |
Maanantai |
1 |
Tiistai |
2 |
Keskiviikko |
3 |
Torstai |
4 |
Perjantai |
5 |
Lauantai |
6 |
Sunnuntaui |
Arvo |
Selitys |
1 |
Haetaan luennoksi merkitty kurssi |
Arvo |
Selitys |
1 |
Haetaan tapahtumaksi merkitty kurssi |
Arvo |
Selitys |
1 |
Haetaan kurssit, joilla ei ole merkintää ”Luennot” tai ”Tapahtumat”. |
Arvo |
Selitys |
en |
Englanti |
fi |
Suomi |
sv |
Ruotsi |
Arvo |
Selitys |
1 |
Palautetaan hakutuloksessa kurssin opetuskertalista |
Arvo |
Selitys |
1 |
Palautetaan hakutuloksessa kurssin kuvaus. ja internetkuvaus tekstit |
Arvo |
Selitys |
1 |
Palautetaan hakutuloksessa muuttuneet kurssit. Käytetään parametrejä 'dat' ja 'tim' määrittelemään aikaraja, jonka jälkeen muuttuneet kurssit palautetaan. Jos 'dat'-parametriä ei anneta, palautetaan oletuksena viimeisen vuorokauden sisällä muuttuneet pyynnön tekohetkestä. |
Arvo |
Selitys |
1 |
Ensimmäisen opetuskerran mukaan nousevasti (oletus, jos 'order' -parametria ei ole määritelty). Laskevana arvolla -1. |
2 |
Aakkosittain kurssin nimen, -koodin mukaan nousevasti. Laskevana arvolla -2. |
3 |
Julkinen alkaen päiväyksen mukaan nousevasti. Laskevana arvolla -3. |
Parametri |
Kuvaus |
Pyyntö |
cgt |
Aineryhmän id |
... /v1/subjectgroup/all |
str |
Opetuspaikan id |
... /v1/location/all |
tar |
Kohderyhmän id |
... /v1/commonselection/targetgroup |
tla |
Opetuskielen id |
... /v1/teachinglanguage |
Vapaasanahaussa termi 'testaus' ja näytä vain kaksi ensimmäistä:
... /v1/course/search?txt=testaus&limit=2
kurssikoodina 'H173590':
... /v1/course/search?txt=H173590
Työväenopisto ja aineryhmän id
... /v1/course/search?com=[opistoid]&cgt=86
Aineryhmän id, kaksi eri opetuspaikkaa, Kurssi alkaa '01.08.2017 - 31.12.2017'
... /v1/course/search?cgt=116&str=327,306&dat=170801000000_171231235959
Kahdesta eri opistosta, aineryhmän id
... /v1/course/search?com=[opistoid],[opistoid]&cgt=176
Vastaus suomen kielisenä, 1.9.2017 klo 00:04:00 jälkeen muuttuneet kurssit
... /v1/course/search?lang=fi&dat=170901&tim=000400&changed=1
Viimeisen vuorokauden aikana muuttuneet kurssit
... /v1/course/search?changed=1
Viimeisen vuorokauden aikana muuttuneet kurssit JSON muodossa
... /v1/course/search?changed=1&format=json
Haku palauttaa kurssista seuraavat tiedot:
Atribuutti |
Kuvaus |
language |
Kieli, jolla mahdolliset käännettävät tiedot käännetään |
wholecount |
Haun palauttama tulosmäärä (ilman limit rajoitusta) |
resultCRIDs |
ID Lista kaikista löydetyistä kursseista (pilkku eroteltu). Palautetaan, jos hakuparametri 'cids' arvossa 1. |
total |
Haun palauttama tulosmäärä tähän hakuun |
limit |
Haun palauttama maksimitulosmäärä |
course |
Haun palauttaman yhden kurssin tiedot |
Atribuutti |
Kuvaus |
id |
Kurssin id ilmonetissa |
code |
kurssikoodi |
name |
nimi |
locations |
Kursin opetuspaikkalista |
price |
Kokonaishinta |
priceMaterial |
Lisähinta |
teacher |
Opettaja (mikäli opisto asettanut tiedon näkyväksi). |
firstSession |
Ensimmäisen opetuskerran aloitusaika |
firstSessionEND |
Ensimmäisen opetuskerran lopetusaika |
firstSessionWeekdate |
Ensimmäisen opetuskerran viikonpäivä |
lastSession |
Viimeinen opetuskerta |
InternetEnrollment |
Internet ilmoittautuminen |
minStudentCount |
Oppilaiden minimimääräkurssilla, jotta kurssi mahdollisesti lähtee käyntiin |
maxStudentCount |
Oppilaiden maksimimäärä kurssilla. Ylimenevät jono-tilaan. |
firstEnrollmentDate |
Ensimmäinen ilmoittautumispäivä |
lastEnrollmentDate |
Viimeinen ilmoittautumispäivä |
acceptedCount |
Hyväksyttyjen oppilaiden määrä. Jos arvossa -1, tietoa ei anneta rajapinnan kautta näkyväksi. |
SinglePaymentCount |
Kertalippuilmoittaumiselle varatut paikat. Jos arvossa -1, tietoa ei anneta rajapinnan kautta näkyväksi tai toiminto ei ole käytössä. |
wwwlink |
Kurssin www-osoite ilmoittautumisjärjestelmään |
image |
Kurssille asetettu kuva. |
isEvent |
Onko kurssi tapahtuma |
isGeneralLecture |
Onko kurssi yleisluento |
isCourse |
Onko kurssi kurssi |
isOnlineLecture |
Onko kurssi verkkoluento |
isOnlineTeaching |
Onko kurssi verkko-opetusta |
isOpenUniversity |
Onko kurssi avoin yliopisto-opetusta |
structureName |
Opetuspaikka polku |
structureNameID |
Opetuspaikan id |
companyID |
Opiston id |
lastCancellationDate |
Viimeinen ilmoittautumisen perumispäiväys |
link |
Kurssille määritellyt www-linkit |
attachment |
Kurssille määritellyt liitetiedostot www-linkkeinä |
Ilmoittautuminen mahdollista |
Atribuutti |
Kuvaus |
id |
Kurssin opetuspaikan id. Opetuspaikan tarkemmat tiedot saa kysymällä sen Opetuspaikkahaulla. |
path |
Kurssin opetuspaikan nimi. |
Atribuutti |
Kuvaus |
enrollmentStarted |
Onko ilmoittautuminen alkanut. Arvolla 1, on alkanut. |
enrollmentExpired |
Onko ilmoittautuminen umpeutunut. Arvolla 1, on umpeutunut. |
enrollmentPossible |
Onko ilmoittautuminen mahdollista. Arvolla 1, on mahdollista. |
unenrollmentPossible |
Onko ilmoittautumisen peruminen mahdollista. Arvolla 1, on mahdollista. |
advancedEnrollmentPossible |
Onko ennakkoilmoittautuminen mahdollista. Arvolla 1, on mahdollista. |
seatsRemainingInfo |
Näytetään, mikäli opisto ei ole sallinut vapaiden paikkojen määrän näyttämistä. Tarkempi kuvaus alla. |
Atribuutti |
Kuvaus |
name |
Sisältää numeroarvon, jos vapaita paikkoja on kolme tai vähemmän. Muussa tapauksessa tekstin ’Ilmoittaudu’ tai ’Ilmoittaudu jonoon’. |
value |
Sisältää arvon 1, jos vapaita paikkoja enemmän kuin kolme. Arvon 2, jos ilmoittautuminen vain jonoon. Aarvon 3, jos vapaita paikkoja kolma tai vähemmän. |
Parametri |
Tyyppi |
Kuvaus |
ses |
Int |
Palauta myös opetuskerrat hakutuloksessa (vain arvolla 1),. Voi sisältää vain yhden arvon. |
format |
String |
Pyynnön vastauksen tyyppi. |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
img |
Int |
Sisällytetäänkö hakutulokseen mahdollinen kurssiin liitetyn kuvan URL (vain arvolla 1). |
lnk |
Int |
Sisällytetäänkö hakutulokseen mahdolliset kurssiin liitetyt linkit (URL:it) (vain arvolla 1). |
att |
Int |
Sisällytetäänkö hakutulokseen mahdolliset kurssiin liitetyt liitetiedostot (URL:it) (vain arvolla 1). |
Kurssi tiedot tunnetulla kurssi id:llä:
... /v1/course/11325
Kurssi tiedot tunnetulla kurssikoodilla:
... /v1/course/code/H173590
Kurssi tiedot tunnetulla kurssikoodilla JSON-muodossa:
... /v1/course/code/H173590?format=json
Haku palauttaa kurssista seuraavat tiedot:
Atribuutti |
Kuvaus |
id |
Kurssin id ilmonetissa |
code |
kurssikoodi |
name |
nimi |
departmentID |
Kurssin ainealuetiimin id |
description |
kuvausteksti |
descriptionInternet |
kuvausteksti |
location |
Sisältää listan kurssin käyttämistä opetuspaikoista |
price |
hinta |
priceMaterial |
lisähinta |
teacher |
Opettaja (mikäli opisto asettanut tiedon näkyväksi). |
firstSession |
Ensimmäinen opetuskerta |
lastSession |
Viimeinen opetuskerta |
companyID |
Opiston id numero. |
firstEnrollmentDate |
Ensimmäinen ilmoittautumispäivä |
lastEnrollmentDate |
Viimeinen ilmoittautumispäivä |
lastCancellationDate |
Viimeinen perusmispäivä |
minStudentCount |
Oppilaiden minimimääräkurssilla, jotta kurssi mahdollisesti lähtee käyntiin |
maxStudentCount |
Oppilaiden maksimimäärä kurssilla. Ylimenevät jono-tilaan. |
startingDateFromCalendar |
Ensimmäisen opetuskerran päiväys |
internetRegistering |
Internet ilmoittautuminen mahdollista |
reviewDate |
Kurssin tarkistuspäiväys |
additionalInfoLink |
Lisätiedot-linkki (ei välttämättä ole URL) |
wwwLink |
Kurssin www-osoite ilmoittautumisjärjestelmään |
equipment |
Väline |
book |
Oppikirja/oppimateriaali |
descriptionForFirstSession |
Ensimmäiselle kerralle mukaan -teksti |
enrollmentNotPossible |
Ilmoittautuminen ei mahdollista -valinta kurssilla |
useFollowDate |
Ennakkoilmoittautumispäiväykset asetettu |
followDateStart |
Ennakkoilmoittautumisen alkupäiväys |
followDateEnd |
Ennakkoilmoittautumisen loppupäiväys |
parentIDs |
Edeltävän kurssin id |
status |
Kurssin tilan id |
skillLevel |
Taitotaso |
skillLevelName |
Taitotason nimi |
discounts |
Alennukset |
acceptedCount |
Hyväksyttyjen oppilaiden määrä. Jos arvossa -1, tietoa ei anneta rajapinnan kautta näkyväksi. |
singlePaymentCount |
Kertalippuilmoittaumiselle varatut paikat. Jos arvossa -1, tietoa ei anneta rajapinnan kautta näkyväksi tai toiminto ei ole käytössä. |
reserveCount |
Varapaikat. Jos arvossa -1, tietoa ei anneta rajapinnan kautta näkyväksi. |
queueCount |
Jonopaikat. Jos arvossa -1, tietoa ei anneta rajapinnan kautta näkyväksi. |
plannedHours |
Suunnitellut tunnit. |
teachingLanguages |
Opetuskielet. |
companyName |
Opiston pitkä nimi. |
companyNameShort |
Opiston lyhyt nimi |
childCourseName |
Jatkokurssin koodi ja nimi |
parentCourseCode |
Edeltävän kurssin koodi |
parentCourseName |
Edeltävän kurssin nimi |
courseTypeID |
Kurssityypin id (mikäli opisto asettanut tiedon näkyväksi) |
courseTypeName |
Kurssityyppi (mikäli opisto asettanut tiedon näkyväksi) |
image |
Kurssille asetettu kuva. |
teachingSession |
Opetuskertalista |
link |
Kurssille määritellyt www-linkit |
attachment |
Kurssille määritellyt liitetiedostot www-linkkeinä |
isEvent |
Onko tapahtuma |
isGeneralLecture |
Onko yleisluento |
isCourse |
Onko kurssi |
isOnlineLecture |
Onko verkkoluento |
isOnlineTeaching |
On verko-opetus |
isOpenUniversity |
Onko avoin yliopsito |
structureName |
Opetuspaikan nimi (alue tasolle) |
structureNameID |
Opetuspaikan id (alue tasolle) |
structureNameB |
Opetuspaikan nimi (rakennus tasolle) |
structureNameBID |
Opetuspaikan id (rakennus tasolle) |
payable |
Onko kurssi maksettavissa ilmonetin kautta (vain arvolla 1) |
enrollmentData |
Sisältää muuttujia ilmoittautumiseen liittyen |
id |
Opetuskerran id |
start |
aloituspäivä ja aika |
end |
Loppumispäivä ja aika |
teachingplace |
Opetuspaikka |
status |
tila-tieto |
enrollmentStarted |
Onko ilmoittautuminen alkanut |
enrollmentExpired |
Onko ilmoittautuminen umpeutunut |
enrollmentPossible |
Onko ilmoittautuminen mahdollista |
unenrollmentPossible |
Onko ilmoittautumisen peruminen mahdollista |
advancedEnrollmentPossible |
Onko ennakkoilmoittautuminen mahdollista. Arvolla 1, on mahdollista. |
seatsRemainingInfo |
Näytetään, mikäli opisto ei ole sallinut vapaiden paikkojen määrän näyttämistä. Tarkempi kuvaus alla. |
notification |
Suositellut ilmoitukset käyttäjälle |
Atribuutti |
Kuvaus |
name |
Sisältää numeroarvon, jos vapaita paikkoja on kolme tai vähemmän. Muussa tapauksessa tekstin ’Ilmoittaudu’ tai ’Ilmoittaudu jonoon’. |
value |
Sisältää arvon 1, jos vapaita paikkoja enemmän kuin kolme. Arvon 2, jos ilmoittautuminen vain jonoon. Aarvon 3, jos vapaita paikkoja kolma tai vähemmän. |
Parametri |
Tyyppi |
Kuvaus |
format |
String |
Pyynnön vastauksen tyyppi. |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
Kaikki aineryhmät saa haettua kyselyllä
... /v1/subjectgroup/all
Yksi tunnettu aineryhmä:
... /v1/subjectgroup/576
Haku palauttaa kurssista seuraavat tiedot:
id |
Aineryhmän id |
name |
Nimi |
parentid |
Aineryhmän isäntäaineryhmä (puurakenteessa) |
tkid |
Tilastokeskuksen aineryhmä luokitus (Opetushallinnon koulutusluokitus 2002). |
Parametri |
Tyyppi |
Kuvaus |
format |
String |
Pyynnön vastauksen tyyppi. |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
level |
Int |
Polkutason numero. Voi sisältää vain yhden arvon. Arvolla 1=polun ensimmäinen taso, 2 = toinen taso jne. |
separator |
String |
Erotinmerkki, jolla polun tasot erotellaan toisistaan |
Kaikki aineryhmät saa haettua polkumuotoisena kyselyllä
... /v1/subjectgroup/path
Kaikki aineryhmät, tasoon 2 asti, erotinmerkkinä ;
... /v1/subjectgroup/path?level=2&separator=;
Haku palauttaa kurssista seuraavat tiedot:
id |
Aineryhmän id ilmonetissa |
name |
Nimi |
path |
Aineryhmän puurakenne |
pathid |
Aineryhmän puurakenne id:t |
level |
Aineryhmän taso |
Parametri |
Tyyppi |
Kuvaus |
com |
String |
Opiston id numero. |
format |
String |
Pyynnön vastauksen tyyppi. |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
status |
Int |
Voi sisältää arvon 0 tai 1 (ne, joita ei näytetä ilmoittautumisjärjestelmässä). Jos arvo muu kuin 0 tai 1, asetetaan 0. |
Kaikki opetuspaikat saa haettua kyselyllä
... /v1/location/all
Kaikki tietyn opiston opetuspaikat saa haettua kyselyllä
... /v1/location/all?com=[opistoid]
Yksi tunnettu opetuspaikka
... /v1/location/39
Haku palauttaa kurssista seuraavat tiedot:
id |
Aineryhmän id ilmonetissa |
name |
Nimi |
path |
Opetuspaikan nimi (alue, kaupunginosa, rakennus, huone) |
pathid |
Opetuspaikan id. Jos useita erotinmerkillä eroteltuna, vastaa id 'path'-attribuutin vastaavia. |
streetAddress |
Opetuspaikan osoite |
postalCode |
Opetuspaikan postinumero |
city |
Opetuspaikan kaupunki |
parentid |
Opetuspaikan isäntäopetuspaikan id |
parentName |
Opetuspaikan isäntäopetuspaikan nimi |
companyID |
Opetuspaikan opistoid |
ownerID |
Opetuspaikan omistajaopiston opistoid (tämä opisto on jakanut paikan) |
typeID |
Opetuspaikan tason tyyppi, 101 = rakennus, 102 = huone, 103 = alue, 104 = asuinalue |
timeRangeList |
Opetuspaikan avoinna/suljettu tieto. |
formated |
Päivämääräväli tekstimuotona. esim. 2021-12-21 15:00:00 - 2021-12-25 16:00:00 |
validBegin |
Aloitusajankohta |
validEnd |
Lopetusajankohta |
type |
Määrittää onko kyseessä aukiolo (open) vai suljettu (closed) tieto |
Parametri |
Tyyppi |
Kuvaus |
com |
String |
Opiston id numero. |
str |
String |
|
dat |
String |
Päiväysrajaus. Annetaan muodossa vvkkpp tai vvkkpphhmmss. Jos vain yksi arvo määritelty, asetetaan se haun alkupäiväykseksi ja haetaan kaikki tapahtumat siitä eteenpäin. Jos halutaan määrittää aikaväli, annetaan se muodossa vvkkpp_ vvkkpp tai vvkkpphhmmss_vvkkpphhmmss. Jos tämä hakuehto jätetään tyhjäksi, haetaan hakuhetkestä vuorokausi eteenpäin. |
sct |
String |
Varaustapahtuman tyyppi. Voi sisältää arvot 'R' (varaus) ja/tai 'C' (paikka suljettu). Ilman parametriä, vastaa arvoa 'R'. |
format |
String |
Pyynnön vastauksen tyyppi. |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
Hakuhetkestä vuorokausi eteenpäin olevat kaikkien opetuspaikkojen varaukset
... /v1/location/reservation
Suljetut opetuspaikat aikaväliltä 3.9.2018 klo 00:00:00– 5.9.2018 klo 23:59:59
.../v1/location/reservation?dat=180903_180905&sct=C
Varaukset aikaväliltä 3.9.2018 klo 12:30:00 – 5.9.2018 klo 17:00:00
.../v1/location/reservation?dat=180903123000_180905170000
Varaukset kahdessa opetuspaikassa, aikaväliltä 1.9.2018 klo 00:00:00 – 5.9.2018 klo 23:59:59
.../v1/location/reservation?dat=180901_180905&str=44,69
Haku palauttaa varauksesta seuraavat tiedot:
Atribuutti 'type' |
Tapahtuman tyyppi. Arvo 'Reservation' = varaus. Arvo 'Closed' = paikka suljettu. |
id |
Varaustapahtuman id |
start |
Alkamispäiväys |
end |
Päättymispäiväys |
teachingPlace |
Opetuspaikka |
caption |
Otsikkoteksti |
description |
Kuvausteksti |
company |
Varauksen tehneen opiston tiedot |
id |
Opetuspaikan id |
path |
Nimi puurakenteena |
id |
Opiston id |
name |
Nimi |
discountAllowed |
Onko alennusmahdollistettu. Arvolla 1, on mahdollistettu. |
Valintalistat ovat samanrakenteista tietoa, mutta lajiteltu tyyppeihin. Tyyppi asetetaan URL-parametriin kyselyn polussa.
URL-parametri |
Kuvaus |
coursetypes |
Kurssityyppi |
educations |
Koulutus |
workstatuses |
Työtilanne |
Parametri |
Tyyppi |
Kuvaus |
com |
String |
Opiston id numero. Voi sisältää vain yhden arvon. |
format |
String |
Pyynnön vastauksen tyyppi. |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
Kaikki tyypin objektit saa haettua kyselyllä
... /v1/commonselection/[URL-parametri]
Kaikki tietyn opiston tyypin objektit saa haettua kyselyllä
... /v1/commonselection/[URL-parametri]?com=[opiston id]
Yhden tietyn tyypin objekti, jonka csid on 70
... /v1/commonselection/[URL-parametri]/70
Mikäli opisto ei ole sallinut tyypin tietojen palautusta rajapinnan kautta, palautetaan kyseisen opiston tiedoista error-objekti.
Haku palauttaa kurssista seuraavat tiedot:
Atribuutti |
Kuvaus |
csid |
Valintalistaobjektin id |
id |
Tyypin id |
name |
Tyypin nimi |
companyID |
Opiston id, jolle tyyppi kuuluu. Voi puuttua pyynnön vastauksesta tai olla arvossa 0, jolloin tieto ei ole opistokohtainen. |
Parametri |
Tyyppi |
Kuvaus |
format |
String |
Pyynnön vastauksen tyyppi. |
lang |
String |
Kieli. Voi sisältää vain yhden arvon. |
Kaikki opetuskeilet saa haettua kyselyllä
... /v1/teachinglanguage
Haku palauttaa opetuskielestä seuraavat tiedot:
Atribuutti |
Kuvaus |
id |
Tyypin id |
name |
Tyypin nimi |
nameFI |
Tyypin nimi suomeksi |
nameEN |
Tyypin nimi englanniksi |
nameSV |
Tyypin nimi ruotsiksi |