GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions
Üldkirjeldus
Teenus võimaldab otsida EHIS avaandmete hulgast õppeasutuste andmeid.
NSIL-709 - Getting issue details... STATUS NSIL-1222 - Getting issue details... STATUS
Eeltingimused ja kasutusõigused
- Puuduvad
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| includeClosedInstitutions | 0..1 | Boolean |
| Määrab, kas otsitakse ainult registreeritud õppeasutusi või registreeritud ja suletud õppeasutusi. |
| ownerRegCode | 0..1 | String | Õppeasutuste otsing omaniku registrikoodi järgi. Otsitakse täpset vastet. Vastuses tagastatakse kirjed, mille educationalInstitutions.owner.regCode = ownerRegCode |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| educationalInstitutions | 0..* | Array | Nimekiri õppeasutustest. |
| educationalInstitutions.id | 1 | Number | Õppeasutuse EHIS id. oppeasutused.oppeasutus.koolId |
| educationalInstitutions.code | 1 | Number | Õppeasutuse registrikood. oppeasutused.oppeasutus.regNr |
| educationalInstitutions.name | 1 | String | Õppeasutuse nimetus. oppeasutused.oppeasutus.nimetus |
| educationalInstitutions.type | String | Õppeasutuse tüüp. oppeasutused.oppeasutus.tyyp | |
| educationalInstitutions.subType | String | Õppeasutuse alamtüüp. oppeasutused.oppeasutus.alamTyyp | |
| educationalInstitutions.status | 1 | String | Õppeasutuse staatus. oppeasutused.oppeasutus.staatus |
| educationalInstitutions.owner | 1 | Object | Õppeasutuse haldaja/omaniku andmed. |
| educationalInstitutions.owner.ownershipType | 0..1 | String | Omandi tüüp. oppeasutused.oppeasutus.omandivorm |
| educationalInstitutions.owner.code | 0..1 | Number | Õppeasutuse haldaja registrikood. oppeasutused.oppeasutus.haldajaOmanikuRegKood |
| educationalInstitutions.owner.name | 0..1 | String | Õppeasutuse haldaja nimi. oppeasutused.oppeasutus.haldajaOmanikuNimi |
| educationalInstitutions.owner.subType | 0..1 | String | Õppeasutuse omaniku liik. oppeasutused.oppeasutus.omanikuLiik |
Tegevused
- Süsteem otsib Haridussilma kvaliteedimooduli vahemälust (cache) õppeasutuste andmeid.
- Kui vahemälus ei ole õppeasutuste andmeid, siis:
- Süsteem otsib õppeasutuste andmeid EHIS avaandmete hulgast (9. EHISe avaandmed#7.EHISeavaandmed-_Toc106283570).
- Kui avaandmete päring ebaõnnestub, siis lõpetab süsteem päringu töötlemise ja tagastab http veakoodi.
- Süsteem salvestab avaandmetest leitud õppeasutuste andmed Haridussilma kvaliteedimooduli vahemällu ja tagastab need.
- Andmed aeguvad iga 1 tunni järel (rakenduses konfiguratsioonist muudetav).
- Süsteem otsib õppeasutuste andmeid EHIS avaandmete hulgast (9. EHISe avaandmed#7.EHISeavaandmed-_Toc106283570).
- Süsteem tagastab leitud õppeasutuse andmed