NSILM

GS: AssessmentModel: API: GET /quality-api/dashboard/assessment-models

Muutja: Andres Mill · 2025-10-08

Üldkirjeldus

Teenus võimaldab pärida hindamismudelite nimekirja töölaua jaoks.

Teenus tagastab kasutaja poolt valitud asutuse tüübile avaldatud kehtivad ja kehtetud hindamismudelid.

NSIL-822 - Getting issue details... STATUS NSIL-1018 - Getting issue details... STATUS NSIL-1342 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Puuduvad


Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
institutionId 0..1String
  • Kasutajal peab olema seos asutusega.
    • institutionId = EHIS x-tee teenus GET/users/v1/userAccounts.response.data.institutionId/token
  • Kohustuslik, kui otsitakse asutusepõhiseid hindamisis.
    • Sisendis on määratud assessmentScopes = INSTITUTIONAL

Asutuse id, mille eest päring teostatakse.

jobsites0..*Array
  • Kasutajal peab olema määratud sisendis esitatud ametikoht sisendis esitatud asutuses.
    • jobsites = EHIS x-tee teenus GET/users/v1/userAccounts.response.data.jobsiteList, mis on seotud sisendis esitatud asutusega. 
  • Väärtustena lubatud kasutada EHIS klassifikaatorit PEDAGOOG_AMETIKOHT väärtuseid.
  • Saab kasutada (ei ole kohustuslik), kui otsitakse isikupõhiseid hindamisi.
    • Sisendis on määratud assessmentScopes = INDIVIDUAL
  • Ei saa kasutada, kui publishedToAllUsers = true

Loend ametikohtadest, kellele hindamismudel on avatud.


assessmentScopes1..*Array
  • Lubatud väärtused:
    • INSTITUTIONAL
    • INDIVIDUAL
  • Väärtusi võib ka koos kasutada.

Määrab, kas mudel on mõeldud asutusepõhiseks hindamiseks (INSTITUTIONAL) või isikupõhiseks hindamiseks (INDIVIDUAL).

publishedToAllUsers0..1Boolean
  • Lubatud väärtused:
    • true
    • false
  • Kui null, siis vaikimisi publishedToAllUsers = false

Defineerib, kas hindamismudel on avaldatud kõikidele sisseloginud kasutajatele või mitte.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
assessmentModels0..*Array
  • Nimekiri hindamismudelitest.
  • Objektid peavad olema järjestatud hindamismudeli liigi nimetuse (assessmentType.name) järgi kasvavas järjekorras. 
assessmentModels.id1StringHindamismudeli id (UUID).
assessmentModels.name1StringHindamismudeli nimetus.
assessmentModels.domainType1EHIS ClassifierHindamismudeliga seotud valdkond.
assessmentModels.statusType1EHIS ClassifierHindamismudeli staatus.
assessmentModels.phaseTypes1..*EHIS Classifier arrayHindamismudeliga seotud hindamise etapid.
assessmentModels.assessmentType1EHIS ClassifierHindamise liik.
assessmentModels.jobsites0..*EHIS Classifier Array

Loend ametikohtadest, kellele hindamismudel on avatud. Väärtustena kasutatakse EHIS klassifikaatorit PEDAGOOG_AMETIKOHT.

Kasutatakse, kui hindamismudel on mõeldud isikupõhiseks hindamiseks (assessmentScope = INDIVIDUAL).

Päringu vastuses tagastatakse ainult need ametikohad, mis on sisendis määratud.

publishedToAllUsers1Boolean

Defineerib, kas hindamismudel on avaldatud kõikidele sisseloginud kasutajatele või mitte.

assessmentScope1StringMäärab, kas hindamine on mõeldud asutusepõhiseks hindamiseks (INSTITUTIONAL) või isikupõhiseks hindamiseks (INDIVIDUAL).

Tegevused

  1. 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.
  2. Süsteem otsib hindamismudeleid.
    • Asutusepõhised hindamismudelid (Sisendis on määratud assessmentScopes = INSTITUTIONAL)
      1. Kasutaja poolt valitud asutus on KOV (EHIS x-tee teenus GET/users/v1/userAccounts.response.data.institutionType = LOCAL_GOVERNMENT, mis on seotud sisendis esitatud asutusega.)
        1. Süsteem otsib KOVile avatud hindamismudelid.
          • Süsteem otsib Objektid#AssessmentModel objekte, mille
            • domainType = Classifier.classifierItemCode, mille
              • Classifier.definitionCode = DOMAIN
              • Classifier.classifierAttributeDefinitionCode = ASSESSMENT_MANAGE_PRIVILEGE
              • Classifier.attributeValue = Kasutaja poolt valitud asutusega seotud privileegide hulgas olevad privileegid.
            • assessmentScope = INSTITUTIONAL
            • status =
              • Kehtiv: confirmed = true, validFrom <= päringu teostamise aeg, validUntil > päringu teostamise aeg. Või 
              • Kehtetu: confirmed = true,  validUntil <= päringu teostamise aeg.
            • institutionTypes.institutionType = institutionType, mille institutionId = sisendis esitatud institutionId väärtus.
            • assessmentHierarchyType != SUB_ASSESSMENT 
            • publishedToAllUsers = Sisendis publishedToAllUsers väärtus.
            • objectStatus = CURRENT
      2. Kasutaja poolt valitud asutus on õppeasutus (EHIS x-tee teenus GET/users/v1/userAccounts.response.data.institutionType = EDUCATIONAL_INSTITUTION, mis on seotud sisendis esitatud asutusega.)
        1. Süsteem otsib õppeasutusele avatud hindamismudelid.
          • Süsteem otsib Objektid#AssessmentModel objekte, mille
            • domainType = Classifier.classifierItemCode, mille
              • Classifier.definitionCode = DOMAIN
              • Classifier.classifierAttributeDefinitionCode = ASSESSMENT_MANAGE_PRIVILEGE
              • Classifier.attributeValue = Kasutaja poolt valitud asutusega seotud privileegide hulgas olevad privileegid.
            • assessmentScope = INSTITUTIONAL
            • status =
              • Kehtiv: confirmed = true, validFrom <= päringu teostamise aeg, validUntil > päringu teostamise aeg. Või 
              • Kehtetu: confirmed = true,  validUntil <= päringu teostamise aeg.
            • institutionTypes.institutionType = institutionType, mille institutionId = sisendis esitatud institutionId väärtus.
            • institutions.specificationTypes = EHIS x-tee teenus GET/users/v1/userAccounts.response.data.institutionTypeCl või data.institutionTypeClUpper
            • assessmentHierarchyType != SUB_ASSESSMENT 
            • publishedToAllUsers = Sisendis publishedToAllUsers väärtus.
            • objectStatus = CURRENT
        2. Registrikoodile avatud hindamismudelite otsing.
          1. Süsteem otsib registrikoodile avatud hindamismudelid.
            • Süsteem otsib Objektid#AssessmentModel objekte, mille
              • domainType = Classifier.classifierItemCode, mille
                • Classifier.definitionCode = DOMAIN
                • Classifier.classifierAttributeDefinitionCode = ASSESSMENT_MANAGE_PRIVILEGE
                • Classifier.attributeValue = Kasutaja poolt valitud asutusega seotud privileegide hulgas olevad privileegid.
              • assessmentScope = INSTITUTIONAL
              • status =
                • Kehtiv: confirmed = true, validFrom <= päringu teostamise aeg, validUntil > päringu teostamise aeg. Või 
                • Kehtetu: confirmed = true,  validUntil <= päringu teostamise aeg.
              • institutions.institutionIds = sisendis esitatud institutionId väärtus.
              • assessmentHierarchyType != SUB_ASSESSMENT 
              • publishedToAllUsers = Sisendis publishedToAllUsers väärtus.
              • objectStatus = CURRENT
    • Isikupõhised hindamismudelid (Sisendis on määratud assessmentScopes = INDIVIDUAL)
      1. Ametikohale avatud hindamismudelite otsing.
        1. Süsteem otsib kasutaja ametikohale avatud hindamismudelid.
          • Süsteem otsib Objektid#AssessmentModel objekte, mille
            • assessmentScope = INDIVIDUAL
            • status =
              • Kehtiv: confirmed = true, validFrom <= päringu teostamise aeg, validUntil > päringu teostamise aeg. Või 
              • Kehtetu: confirmed = true,  validUntil <= päringu teostamise aeg.
            • jobsites hulgas on sisendis esitatud jobsites väärtused.
            • assessmentHierarchyType != SUB_ASSESSMENT 
            • publishedToAllUsers = Sisendis publishedToAllUsers väärtus.
            • objectStatus = CURRENT
  3. Süsteem eemaldab leitud hindamismudelite hulgast duplikaadid.
  4. Süsteem tagastab leitud andmed.