...
Varaus sisältää perustiedot varauksesta kuten sen ajankohdan, ja lisäksi listan "resursseja" jotka voivat olla esimerkiksi tiloja tai opintojaksototeutuksia.
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| id | numero | Varauksen yksilöllinen id |
| modifiedDate | pvm | Koska varausta on viimeksi muokattu |
subject | teksti | Varauksen otsikko |
| description | teksti | Mahdollinen varauksen lisätieto |
| startDate | pvm | Varauksen alkamisajankohta |
| endDate | pvm | Varauksen päättymisajankohta |
| resources | lista | Varaukseen linkitetyt resurssit |
Varauksen resurssi
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| id | numero | Resurssin yksilöllinen id |
type | teksti | Resurssin tyyppi. realization - opintojaksototeutus, student_group - ryhmä, scheduling_group - opetusryhmä, room - tila, building - rakennus josssa tila sijaitsee |
| code | teksti | Resurssin koodi |
| name | teksti | Resurssin nimi |
Esimerkki:
| Code Block | ||
|---|---|---|
| ||
{
"id": "838403",
"subject": "Spanish 3 LX00AC52-3001",
"modifiedDate": "2013-09-02T14:31",
"startDate": "2013-11-01T08:00",
"endDate": "2013-11-01T10:45",
"resources": [{
"id": "32961",
"type": "realization",
"code": "LX00AC52-3001",
"name": "Spanish 3"
}, {
"id": "32858",
"type": "student_group",
"code": "LITO_VV",
"name": "LITO_VV"
}, {
"id": "786",
"type": "room",
"code": "VTYA215",
"name": "Teorialuokka",
"parent": {
"id": "764",
"type": "building",
"code": "VTY",
"name": "Leiritie 1"
}
}]
}
|
Haku
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
subject | teksti | Vapaa tekstihaku otsikosta |
| startDate | pvm | Varauksen alkuajankohdan pitää olla sama tai suurempi kuin annettu arvo |
| endDate | pvm | Varauksen päättymisajankohdan pitää olla sama tai pienempi kuin annettu arvo. |
| rangeStart | pvm | Varauksen loppu-ajankohta on annettuna ajankohtana tai sen jälkeen. Varaus osuu rangeStart - rangeEnd päivämäärävälille. Molemmat parametrit pitää antaa jos jompi kumpi määritelty. |
| rangeEnd | pvm | Varauksen alku-ajankohta on ennen annettua ajankohtaa |
| realization | lista | Varaus koskee annettua opintojaksototeutusta (opintojaksototeutuksen koodi) |
| studentGroup | lista | Varaus koskee annettua ryhmää (ryhmän koodi). |
| room | lista | Varaus on annetussa tilassa (tilan koodi) |
| building | lista | Varaus on tilassa joka sijaitsee annetussa rakennuksessa (rakennuksen koodi) |
| from | numero | Palauta hakutulokset annetusta numerosta eteenpäin. Oletus 0. |
| size | numero | Palautettavien tulosten maksimimäärä. Oletus 1000. |
Haku on "AND" -haku kenttien välillä. Lista -tyyppiset parametrit ovat "OR" saman tyyppisen listan sisällä olevien elementtien välillä.
...
| Code Block | ||
|---|---|---|
| ||
{
"startDate": "2013-11-22T09:00",
"endDate": "2013-11-22T10:00",
"room": ["G201"]
} |
Vastaus
| Kenttä | Kuvaus |
|---|---|
| status | Tieto onnistuiko pyyntö vai oliko mahdollisia virheitä. "success", "warn", "error" |
| message | Mahdollinen tarkentava viesti esimerkiksi virhetilanteissa. |
| reservations | Lista varauksia. |
| Code Block | ||
|---|---|---|
| ||
{
"status": "success",
"reservations": [{
"id": "840509",
"subject": "G201 test",
"modifiedDate": "2013-11-18T13:11",
"startDate": "2013-11-22T09:00",
"endDate": "2013-11-22T10:00",
"resources": [{
"id": "3",
"type": "room",
"code": "G201",
"name": "Auditorio",
"parent": {
"id": "2",
"type": "building",
"code": "AGRICO",
"name": "Agricolankatu 1-3"
}
}]
}]
}
|
...
| Code Block | ||
|---|---|---|
| ||
curl -u "oma_api_key:" -X POST https://opendata.metropolia.fi/r1/reservation/search -d '{
"startDate":"2013-11-22T09:00",
"endDate":"2013-11-22T15:00",
"room":["G205"]
}'
|
Huomaa että opintojaksototeutuksen varaukset voivat olla merkitty joko pelkästään opintojaksototeutukselle tai ryhmälle, tai sitten varauksella voi olla molemmat tiedot asetettuna.
...
| Code Block | ||
|---|---|---|
| ||
curl -u "oma_api_key:" -X POST https://opendata.metropolia.fi/r1/reservation/search -d '{
"rangeStart": "2013-11-22T09:00",
"rangeEnd": "2013-11-22T10:00",
"building": ["AGRICO"]
}'
|
...
Jos haluat hakea esimerkiksi mitä opetusta on tiettynä ajankohtana, voit hakea varaukset jotka alkavat tietyn ajankohdan jälkeen. Vastaukesta voit kerätä yksilölliset opintojaksototeutukset ja luokkahuoneet joissa opetus järjestetään. Voit lisätä vielä hakuehdon rakennukselle jos haluat vain tietyn toimipisteen opetustapahtumat.
...
| Code Block | ||
|---|---|---|
| ||
curl -u "oma_api_key:" https://opendata.metropolia.fi/r1/reservation/building/373 |
Esimerkki vastauksesta:
Kenttä officialIdentifier lisätty, joka sisältää Virallisen tilakoodin.
Korjattu, että size (neliömäärä) tieto tulee myös huoneille (building toimi jo tältä osin). Tässä voi olla ongelmaa koska alunperin toteutettu käsittelemään kokonaislukuja ja huoneilla voidaan syöttää tekstiä. Jos tekstiä syötetty tai desimaaliarvoja niin ottaa ensimmäisen numeraalisen osan. Esim "n.10,5 neliötä" → 10 size kentässä.
Huone sisältää building kyselyssä resources listan, jossa kiinteät varusteet (type:resource) ja muut resurssit (type:movable)
Varusteniput (accessoryBundles) sisältyy myös esimerkin mukaisesti mikäli ominaisuus on kytkettynä pepissä.
| Code Block | ||
|---|---|---|
| ||
{
"status": "success",
"building": {
"id": "373",
"type": "building",
"code": "Test",
"name": "Test Street 3 D",
"places": 0
},
"resources": [{
"id": "374",
"type": "room",
"code": "Testroom1",
"name": "ATK-luokka",
"resourceType": "ATK-luokka",
"description": "Vain testikäytössä oleva virtuaalinen tila, jolla ei ole fyysisessä maailmassa vastinetta.",
"places": 22
}, {
"id": "375",
"type": "room",
"code": "Testroom2",
"name": "Opetustila",
"resourceType": "Opetustila",
"description": "Vain testikäytössä oleva virtuaalinen tila, jolla ei ole fyysisessä maailmassa vastinetta.\r\n",
"places": 30
}]
}
|