Üldkirjeldus

Teenuse abil saab kasutaja otsida temaga seotud asutusele avaldatud juhtimislaudu.

Seotud andmeobjektid:

Objektid#DashboardDefinition

NSIL-471 - Getting issue details... STATUS NSIL-1134 - Getting issue details... STATUS NSIL-1224 - Getting issue details... STATUS NSIL-1239 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kasutajal peab olema autenditud ja autoriseeritud (Omab kehtivat tokenit).

Sisendid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Vaikeväärtus, valideerimine	Kirjeldus, täiendav info
institutionId	1	String	Kasutajal peab olema seos asutusega. Või kasutaja peab olema seotud sisendis esitatud pidajaga ja tal peab olema pidaja asutuses pidaja töölaua vaatamise õigus. GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.id = institutionId GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.owner.regCode = GET hsilm-gateway/userinfo.response.organizations.regCode, mille privilegeList sisaldab privileegi HSILM_OWNER_DASHBOARD_SEARCH	Viide asutusele, mille eest päring teostatakse.
scope	0..1	Enum	Lubatud väärtused: OWNER - Pidaja kontekstis INSTITUTION - Asutuse kontekstis Kui määramata, siis vaikimisi rakendatakse INSTITUTION skoopi.	Määrab, kas juhtimislaudu vaadatakse pidaja või asutuse kontekstis.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

Tüüp

Kirjeldus, täiendav info

dashboards

0..*

Array

Nimekiri juhtimislaudade definitsioonidest.

Nimekirja elemendid on samad, mis GS: DashboardDefinition: API: GET /dashboard-api/dashboards/{dashboardId}#V%C3%A4ljundid

Tegevused

Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
1. Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem valideerib sisendi.
1. Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem otsib juhtimislaua üldandmed.
- Süsteem otsib Objektid#DashboardDefinition objekte, mille:
  1. Asutuse tüübile avaldatud juhtimislaud.
    - statusType = PUBLIC
    - institutions.institutionType =
      - Kasutaja rollidele määratud asutuse tüüp (GET /hsilm-gateway/userinfo.response.organizations.institutionType), mille institution.id = Sisendis esitatud institutionId väärtus.
      - Või GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.type, mille institution.id = Sisendis esitatud institutionId väärtus.
    - institutions.specificationTypes =
      - Asutusele määratud õppeasutuse tüüp (GET /hsilm-gateway/userinfo.response.organizations.institutionSubType), mille institution.id = Sisendis esitatud institutionId väärtus.
      - Või GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.type, mille institution.id = Sisendis esitatud institutionId väärtus.
        specificationTypes järgi filtreerimist kasutatakse, kui asutuse tüüp on õppeasutus.
        GET /hsilm-gateway/userinfo.response.organizations.institutionType = EDUCATIONAL_INSTITUTION
    - objectStatus = CURRENT
    - Kui kasutaja on pidaja rollis (scope = OWNER), siis visibleToOwner = true, muudel juhtudel visibleToOwner parameetri kitsendust ei rakendata.
    - Kui kasutaja ei ole pidaja rollis (scope = INSTITUTION), siis kitsendatakse päringut valdkondaega, mille vaatamise õigus kasutajal (pidaja rollis seda ei tehta) on ehk:
      - domainType = Klassifikaatorid#KlassifikaatorDOMAIN väärtused, mille ClassifierAttributeValue.classifierAttributeDefinitionCode = DASHBOARD_VIEW_PRIVILEGE ja ClassifierAttributeValue.attributeValue = tokenist organizations.privilegeList, mille organizations.institutionId = Sisendis esitatud institutionId.
  2. Registrikoodile avaldatud juhtimislauad.
    - statusType = PUBLIC
    - institutions.institutionId = Sisendis esitatud institutionId väärtus.
    - Kui kasutaja on pidaja rollis, siis visibleToOwner = true, muudel juhtudel visibleToOwner parameetri kitsendust ei rakendata.
    - Kui kasutaja ei ole pidaja rollis (scope = INSTITUTION), siis kitsendatakse päringut valdkondaega, mille vaatamise õigus kasutajal (pidaja rollis seda ei tehta) on ehk:
      - domainType = Klassifikaatorid#KlassifikaatorDOMAIN väärtused, mille ClassifierAttributeValue.classifierAttributeDefinitionCode = DASHBOARD_VIEW_PRIVILEGE ja ClassifierAttributeValue.attributeValue = tokenist organizations.privilegeList, mille organizations.institutionId = Sisendis esitatud institutionId.
    - objectStatus = CURRENT
  3. HTM struktuuriüksusele avaldatud juhtimislaud
    1. Kui sisendis esitatud asutus on HTM (GET /hsilm-gateway/userinfo.response.organizations.institutionType = HTM, mille institution.id = Sisendis esitatud institutionId väärtus), siis otsib süsteem ka kasutaja HTM struktuuriüksusele avaldatud juhtimislauad. Süsteem otsib Objektid#DashboardDefinition objekte, mille:
      - statusType = PUBLIC
      - htmStructureUnits = GET /hsilm-gateway/userinfo.response.relatedHtmStructures.id
      - objectStatus = CURRENT
Süsteem tagastab leitud andmed.