Rest API

Opetuselementtien tyypit

Opetuselementti tyyppi	Haun tyypin tunniste	Haun tulos
Erilliset opintokokonaisuudet	OFFERING	StudyModuleQueryResultDTO
Ilmoittautumisen kohteet	REGISTRATION_PACKAGE	ExportRegistrationPackageQueryResultDTO
Opintojaksojen toteutukset	COURSE_UNIT_REALIZATION	CourseUnitRealisationQueryResultDTO
Opintojaksot	COURSE_UNIT	CourseUnitQueryResultDTO
Opintokokonaisuudet	STUDY_MODULE	StudyModuleQueryResultDTO
Ryhmittely	CATEGORY	StudyModuleQueryResultDTO

Tietojen haku

Tietojen hakuun on toteutettu REST-rajapinta, joka toimii CXF-kirjaston avulla palvelukerroksessa. REST-rajapinta löytyy osoitteesta

<palvelukerroksen domain>:<portti>/api/rs/generic-export-service/query

Tarvittavat parametrit ovat (suluissa oletusarvo)

• type haettavan opetuselementin tyyppi
• size kerralla haettavien elementtien määrä (10)

Sivutukseen käytettävä parametrit ovat

• nextKey seuraavan sivun tunniste
• nextMethod sivutuksen metodi (riippuu välivaraston tallenukseen käytettävästä moduulista)

Hakua voi tarkentaa parametreilla

• createdAfter=yyyy-MM-dd palautetaan kaikki elementit, jotka on tehty annetun päivämäärän jälkeen
• modifiedAfter=yyyy-MM-dd palautetaan kaikki elementit, joita on muokattu annetun päivämäärän jälkeen
• validDate=yyyy-MM-dd palautetaan kaikki elementit, jotka ovat voimassa annettuna päivämääränä

Jos rikastuksessa on käytetty juuritason organisaatioiden määrittelyä, voidaan haku kohdistaa tiettyyn organisaatioon

• organisation palautetaan kaikki elementit, joihin on liitetty mainittu organisaatio (koodi)

Haku palauttaa tuloksen muodossa

{
  "result": {
    "total": N,
    "rows": [ ... ]
  },
  "next": "URL"
}

jossa N on haussa läydettyjen elementtien kokonaismäärä ja URL on seuraavan sivun haun osoite.

Esimerkkihaku ja sen tulos lyhennettynä:

curl -XGET "http://localhost:8181/api/rs/generic-export-service/query?type=COURSE_UNIT&size=10"
{
  "result":{
    "total":376,
    "rows":[ ... ]
  }
  "next":"http://localhost:8181/api/rs/generic-export-service/query?type=COURSE_UNIT&size=10&nextKey=10&nextMethod=paging"
}

Swagger