Opintojaksot
CREATE_COURSEUNIT_REQUEST
Viesti, jolla voidaan luoda tarjontaan opintojaksoja. Opintojakson alla voidaan antaa myös opintojakson ja opintojakson arvioinninkohteen toteutukset, jolloin myös ne generoidaan järjestelmään tai jos toteutus oli jo olemassa se liitetään luotuun opintojaksoon. Opintojaksolle on annettava tasan yksi järjestäjä, jonka pitää olla viestin lähettävä organisaatio. Tämä annetaan "organisationReferences" listan objektilla jolla on kentässä "organisationRole" rooli arvolla 1 (päävastuu). Keskitetty palvelu käyttää tässä annetun organisaation Id:tä opintojakson luomisen jälkeen opintojakson yksilöimiseen.
UPDATE_COURSEUNIT_REQUEST
Viesti, jolla voidaan päivittää opintojaksoja. Viestissä on annettava kenttä "studyElementId" jota käytetään opintojakson yksilöimiseen lähettävän organisaation id:n lisäksi. Viestiin tarvitsee liittää vain ne kentät, joita halutaan päivittää, mutta päivitettävästä kentästä tulee antaa täydelliset tiedot. Keskitetty palvelu ei siis lisää erikseen esimerkiksi taulukkoon arvoja säästäen edelliset arvot, vaan taulukko korvataan viestissä annetulla taulukolla.
DELETE_COURSEUNIT_REQUEST
Viesti, jolla voidaan poistaa opintojakso kokonaan keskitetystä palvelusta. Viestissä on annettava kenttä "studyElementId" jota käytetään opintojakson yksilöimiseen lähettävän organisaation id:n lisäksi. Oletustoiminnallisuus on siten, että jos löytyy toteutuksia, jotka liittyy poistettavaan opintojaksoon, ei keskitetty palvelu poista opintojaksoa, vaan palauttaa virheen. Jos viestiin asettaa "deleteRealisations" kenttään arvon voidaan kuitenkin kertoa keskitetylle palvelulle, että myös toteutukset voidaan poistaa. Tällöin kaikista poistettavaan opintojaksoon liittyvistä toteutuksista poistetaan viittaus kyseiseen opintojaksoon. Jos toteutukselle ei jää enää muita viitteitä, poistetaan toteutus kokonaan, jotta järjestelmään ei jää orpoja toteutuksia. Jos halutaan poistaa opintojakso esim. vain jonkun verkoston tarjonnasta, tulee tähän käyttää päivitysviestiä ja päivittää "cooperationNetworks" listaa.
COURSEUNIT_CREATED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille uudesta luodusta opintojajaksosta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
COURSEUNIT_UPDATED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille päivitetystä opintojajaksosta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
COURSEUNIT_DELETED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille poistetusta opintojajaksosta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
Opintokokonaisuudet
CREATE_STUDYMODULE_REQUEST
Viesti, jolla voidaan luoda tarjontaan opintokokonaisuuksia. Opintokokonaisuuden alla voidaan antaa myös siihen liittyvät opintojaksot, jolloin myös ne generoidaan järjestelmään tai jos opintojakso oli jo olemassa se liitetään luotuun opintojaksoon. Opintokokonaisuudelle on annettava tasan yksi järjestäjä, jonka pitää olla viestin lähettävä organisaatio. Tämä annetaan "organisationReferences" listan objektilla jolla on kentässä "organisationRole" rooli arvolla 1 (päävastuu). Keskitetty palvelu käyttää tässä annetun organisaation Id:tä opintokokonaisuuden luomisen jälkeen sen yksilöimiseen.
UPDATE_STUDYMODULE_REQUEST
Viesti, jolla voidaan päivittää opintokokonaisuuksia. Viestissä on annettava kenttä "studyElementId" jota käytetään opintojakson yksilöimiseen lähettävän organisaation id:n lisäksi. Viestiin tarvitsee liittää vain ne kentät, joita halutaan päivittää, mutta päivitettävästä kentästä tulee antaa täydelliset tiedot. Keskitetty palvelu ei siis lisää erikseen esimerkiksi taulukkoon arvoja säästäen edelliset arvot, vaan taulukko korvataan viestissä annetulla taulukolla.
DELETE_STUDYMODULE_REQUEST
Viesti, jolla voidaan poistaa opintokokonaisuus kokonaan keskitetystä palvelusta. Viestissä on annettava kenttä "studyElementId" jota käytetään opintokokonaisuuden yksilöimiseen lähettävän organisaation id:n lisäksi. Oletustoiminnallisuus on siten, että jos löytyy opintojaksoja, jotka liittyvät poistettavaan kokonaisuuteen, ei keskitetty palvelu poista opintokokonaisuutta, vaan palauttaa virheen. Asettamalla "deleteCourseUnits" kenttään arvon voidaan kuitenkin kertoa keskitetylle palvelulle, että myös opintojaksot voidaan poistaa. Opintojaksoja ei tällöin kuitenkaan poisteta kokonaan keskitetystä palvelusta vaan ainoastaan viittaukset poistettavaan opintokokonaisuuteen poistetaan. Jos halutaan poistaa opintokokonaisuus esim. vain jonkun verkoston tarjonnasta, tulee tähän käyttää päivitysviestiä ja päivittää "cooperationNetworks" listaa.
STUDYMODULE_CREATED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille uudesta luodusta opintokokonaisuudesta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
STUDYMODULE_UPDATED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille päivitetystä opintokokonaisuudesta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
STUDYMODULE_DELETED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille poistetusta opintokokonaisuudesta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
Opintosuoritukset
CREATE_STUDYRECORD_REQUEST
Opintosuorituksen välitysviesti. Viesti välitetään kohdekorkeakoululle. Välitetyssä viestissä on lisättynä studyRecordRequestId, jonka keskitetty palvelu suoritukselle generoi.
Kun välitetään opintojaksojen osasuorituksia, toimitaan saman kaavan mukaan sekä silloin kun osasuorituksia lähetetään yksitellen kuin silloin kun opintojakson suoritus osineen toimitetaan kerralla.
- Osasuoritus kohdistuu arvioinnin kohteeseen (completedCreditTarget) ja sisältää listassa "completedCreditAssociations" tarkemmat tiedot siitä, mihin opintojaksoon ym. liittyy. Tässä tapauksessa completedCreditType = 3.
- Kun opintojakson suoritus kootaan, välitetään ensin viimeinen osasuoritus ja tämän jälkeen opintojakson kokonaissuoritus joka sisältää viittaukset jo välitettyihin osasuorituksiin. Tällöin completedCreditTarget = opintojakso, completedCreditType = 2.
- Jos lähetetään koko opintojakson suoritus toiseen korkeakouluun vasta kun se on kokonaan suoritettu, tulee tällöin vastaavasti välittää osat ja sen jälkeen opintojakson kokonaissuoritus samalla tavalla kuin kohdissa 1 ja 2.
FORWARDED_CREATE_STUDYRECORD_REQUEST
Kun opintosuoritus välitetään eteenpäin, tehdään se uudella viestityypillä. Viestin sisältö on täysin sama, kuin opintosuorituksen välitysviestillä, paitsi että eteenpäin välitettyyn viestiin liitetään vielä keskitetyn palvelun generoima studyRecordRequestId, jonka avulla vastaanottanut korkeakoulu voi vastata helposti viestiin.
STUDYRECORD_REPLY_REQUEST
Opintosuorituksen vastaanottavan korkeakoulun välittämä viesti, jolla kerrotaan, että suoritus on vastaanotettu ja käsitelty/jätetty käsittelemättä. studyRecordRequestId tulee olla vastaanotetussa suorituksessa tullut keskitetyn palvelun generoima studyRecordRequestId.
FORWARDED_STUDYRECORD_REPLY REQUEST
Opintosuorituksen kuittauksesta opintosuorituksen alkuperäiselle lähettäjälle välitettävä viesti. Viesti sisältää koko alkuperäisen suorituksen välitysviestin sisällön, studyRecordRequestId:n sekä kuittauksen tilan.
Opiskelijan tietojen päivitys
UPDATE_STUDENT_REQUEST
Viesti, jolla päivitetään opiskelijan tiedot.
FORWARDED_UPDATE_STUDENT_REQUEST
Viesti, joka välitetään kohdekorkeakoulu(n/jen) jonoihin lähetetystä opiskelijan tietojen päivitysviestistä. Viesti on muuten samanlainen, kuin lähetetty opiskelijan päivitysviesti, paitsi että siihen on lisätty keskitetyn palvelun luoma "studentRequestId", joka yksilöi viestin. Viesti välitetään kaikille organisaatioille, joilta päivitettävältä opiskelijalta löytyy rekisteröinti.
UPDATE_STUDENT_REPLY_REQUEST
Viesti, jolla opiskelijan tietojen päivitysviestin saanut yliopiston järjestelmä kuittaa saaneensa perille päivitysviestin. "studentRequestId" tulee olla keskitetyn palvelun päivitysviestille generoima id.
FORWARDED_UPDATE_STUDENT_REPLY_REQUEST
Viesti, joka välitetään päivitysviestin lähettäneelle korkeakoululle (kotikorkeakoululle). Viestin sisältö on sama, kuin päivitysviestin kuittauksen.
UPDATE_STUDENT_STUDYRIGHT_REQUEST
Viesti, jolla voidaan ilmoittaa, että opiskelijan opiskeluoikeus on muuttunut.
FORWARDED_UPDATE_STUDENT_STUDYRIGHT_REQUEST
Viesti, joka välitetään eteenpäin opiskelijan opiskeluoikeuden muutosviestistä. Viestin sisältö on sama kuin alkuperäisen viestin, mutta sisältää myös kentän keskitetyn palvelun viestille generoiman kentän "studentRequestId". Viesti välitetään organisaatioihin, joissa opiskelijalla on voimassaoleva opiskeluoikeus.
UPDATE_STUDENT_STUDYRIGHT_REPLY_REQUEST
Viesti, jolla opiskelijan opiskeluoikeuden muutosviestin saanut yliopiston järjestelmä kuittaa saaneensa perille päivitysviestin. "studentRequestId" tulee olla keskitetyn palvelun opiskeluoikeuden päättymisviestille generoima id.
FORWARDED_UPDATE_STUDENT_STUDYRIGHT_REPLY_REQUEST
Viesti, joka välitetään opiskeluoikeuden muutosviestin kuittauksesta peruuttaneelle korkeakoululle (kotikorkeakoululle). Viestin sisältö on täysin sama, kuin kuittausviestin.
Rekisteröintipyynnöt
CREATE_REGISTRATION_REQUEST
Viesti, jolla opiskelija ilmoittautuu kursseille/toteutuksille. Ilmoittautumisen kohteeseen pitää aina liittää koko hierarkia opintojaksoon asti, jotta kohdejärjestelmä tietää aukottomasti, mihin opintojaksoon ilmoittautumisen kohde liittyy. Hierarkia annetaan RegistrationSelection.parent kentässä. Hierarkian ylemmille kentille ei tarvitse antaa muita kenttiä RegistrationSelectionin alta, kuin "selectionItemId", "selectionItemIdentifierCode", "selectionItemType" ja mahdollisesti parent (jos tyyppi ei opintojakso). Juurielementin valinnan tila määrittää koko valinnan tilan, joten näitä ei tarvitse välittää.
FORWARDED_CREATE_REGISTRATION_REQUEST
Viesti, joka välitetään eteepäin lähetetystä rekisteröintipyynnöstä. Viestin sisältö on muuten sama kuin rekisteröintipyynnön, mutta siihen liitetään vielä keskitetyn palvelun generoima "registrationRequestId", jonka avulla kohdekorkeakoulu voi kyseiseen rekisteröintipyyntöön vastata.
REGISTRATION_REPLY_REQUEST
Viesti, jolla kohdekorkeakoulu kertoo kotikorkeakoululle opiskelijan ilmoittautumisen statuksen. Vastausviestissä pitää lähettää keskitetyn palvelun välittämä rekisteröintipyynnölle luotu id kentässä registrationRequestId. Vastauksessa ei tarvitse välittää koko hierarkiaa kuten vaan "selections" kenttään riittää, kun ilmoittaa hyväksyttiinkö henkilö kyseiselle toteutukselle/opintojaksolle. Viesti toimii myös ACK-viestinä vastaanotetulle FORWARDED_CREATE_REGISTRATION_REQUEST-viestille, lähetettäessä ACK-viestiä tulee antaa ainoastaan "registrationRequestId" ja "status": "RECEIVED" Ristiinopiskelupalveluun liittyvien järjestelmien olisi hyvä totetuttaa myös ACK-viestin lähetys, jotta rekisteröintipyynnön lähettänyt korkeakoulu tietää, että viesti on vastaanotettu.
FORWARDED_REGISTRATION_REPLY_REQUEST
Viesti, joka välitetään saapuneesta rekisteröinnin kuittauksesta kotikorkeakoululle. Se sisältää koko rekisteröinnin tiedot sillä erolla, että "selections" kenttä vastaa REGISTRATION_REPLY_REQUEST-viestiessä saapunutta "selections"-listaa.
Toteutukset
CREATE_REALISATION_REQUEST
Viesti, jolla voi luoda tarjontaan toteutuksia. Toteutuksia ei voi luoda ilman viitettä vähintään yhteen opintojaksoon (joko arvioinninkohteen kautta tai suoraan opintojaksoviitteellä). Kuten opintojaksoja ja -kokonaisuuksiakin, voidaan toteutuksia rajata pois eri verkostoilta niin halutessa. Luotavalta toteutukselta tulee löytyä vähintään yksi sama verkosto, kuin siihen liittyvältä opintojaksolta, muuten viestiä ei hyväksytä. Toteutus voidaan kuitenkin merkitä ilmoittautumiskelvottomaksi esim. opintojaksolta - vaikka toteutus olisikin ilmoittautumiskelpoinen - jos näin halutaan.
UPDATE_REALISATION_REQUEST
Viesti, jolla voidaan päivittää toteutuksia. Viestissä on annettava kenttä "studyElementId" jota käytetään toteutuksen yksilöimiseen lähettävän organisaation id:n lisäksi. Viestiin tarvitsee liittää vain ne kentät, joita halutaan päivittää, mutta päivitettävästä kentästä tulee antaa täydelliset tiedot. eskitetty palvelu ei siis lisää erikseen esimerkiksi taulukkoon arvoja säästäen edelliset arvot, vaan taulukko korvataan viestissä annetulla taulukolla. Esimerkiksi lisättäessä toteutusta uuteen opintojaksoon, pitää lähettää kaikki studyElementReferences taulussa lähettää myös kaikki olemassa olevat liitokset.
DELETE_REALISATION_REQUEST
Viesti, jolla voidaan poistaa toteutus kokonaan.
REALISATION_CREATED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille uudesta luodusta toteutuksesta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
REALISATION_UPDATED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille päivitetystä toteutuksesta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
REALISATION_DELETED_NOTIFICATION
Viesti, jolla keskitetty palvelu ilmoittaa verkoston jäsenille poistetusta toteutuksesta. Viesti toimitetaan vain verkoston niille organisaatioille, jotka ovat ottaneet notifikaattiviestit käyttöön ylläpitokäyttöliittymästä.
Verkostot
HUOM! Nämä viestit eivät ole korkeakoulujen lähetettävissä.
CREATE_NETWORK_REQUEST
Kun pääkäyttäjän käyttöliittymällä luodaan uusi verkosto ja merkitään se julkaistavaksi, lähtee kaikille organisaatioille, jotka verkostoon kuuluvat tieto luodusta verkostosta. Viesti sisältää kaikki verkostoon liittyvät tiedot.
UPDATE_NETWORK_REQUEST
Kun pääkäyttäjän käyttöliittymällä päivitetään julkaistua verkosta, lähtee siitä kaikille verkostoon kuuluville organisaatioille ilmoitus, joka uudet verkoston tiedot.
Kuittaukset
ACKNOWLEDGEMENT
Kuittausviesti, jolla korkeakoulu voi kuitata minkä tahansa vastaanottamansa viestin erikseen vastaanotetuksi toiselle korkeakoululle.
Tällä hetkellä ainoa käyttötarkoitus REGISTRATION_REPLY_REQUEST-viestien kuittaus
Keskitetyn palvelun vastausviestit
Keskitetty palvelu vastaa jokaiseen sille lähettyyn viestiin, jotta lähettävä pää voi tietää, onko viestin käsittely keskitetyssä palvelussa onnistunut.
DEFAULT_RESPONSE
Suurimmassa osassa viesteistä, vastaa keskitetty palvelu tällä viestillä.
JSON_VALIDATION_FAILED_RESPONSE
Mikäli lähetetty viesti ei ole läpäissyt JSon-skeemaa vasten validointia, vastaa keskitetty palvelu tällä viestillä. Käsittelyn tila (status) on aina tässä tapauksessa FAILED. Viesti sisältää myös listan virheitä, jotka JSon-validoinnista on syntynyt, jotta korkeakoulun järjestelmän päässä voidaan saada selville mikä meni pieleen.
AUTHENTICATION_FAILED_RESPONSE
Tällä viestityypillä vastataan, jos lähettävä pääty ei läpäise autentikaatiota (virheellinen sertifikaatti ymsyms.). Viestin sisältö on sama kuin DEFAULT_RESPONSE:n, mutta tila on aina FAILED.
REGISTRATION_RESPONSE
Rekisteröintipyynnön lähetyksen käsittelyn onnistuessa, vastaa keskitetty palvelu tällä viestillä.Viestin sisältö on sama kuin DEFAULT_RESPONSE:n, mutta viestissä palautetaan myös rekisteröintipyynnölle generoitu tunniste "registrationRequestId".
STUDYRECORD_RESPONSE
Opintosuorituksen lähetyksen käsittelyn onnistuessa, vastaa keskitetty palvelu tällä viestillä. Viestin sisältö on sama kuin DEFAULT_RESPONSE:n, mutta viestissä palautetaan myös rekisteröintipyynnölle generoitu tunniste "studyRecordRequestId".
STUDENT_RESPONSE
Opiskelijan päivitys ja opiskelijan opiskeluoikeuden peruutuksen lähetyksen käsittelyn onnistuessa, vastaa keskitetty palvelu tällä viestillä. Viestin sisältö on sama kuin DEFAULT_RESPONSE:n, mutta viestissä palautetaan myös rekisteröintipyynnölle generoitu tunniste "studentRequestId".