NSILM

GS: Assessment: API: GET /quality-api/assessments

Muutja: Andres Mill · 2025-10-20

Üldkirjeldus

Teenus võimaldab otsida hindamise andmeid.

Seotud andmeobjektid:

NSIL-825 - Getting issue details... STATUS NSIL-863 - Getting issue details... STATUS NSIL-1022 - Getting issue details... STATUS NSIL-1358 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused


Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
institutionId0..1String (FK)
  • Kui otsitakse asutusepõhiseid hindamisi, siis peab kasutajal olema seos asutusega.
    • institutionId = EHIS x-tee teenus GET/users/v1/userAccounts.response.data.institutionId/token
  • Isikupõhistel hindamistel ei pea seost olema.
  • Ei saa kasutada koos teamMemberRoles väärtusega.

Viide hindamisega seotud asutusele.

Peab olema täidetud, kui sisendatribuut "teamMemberRole" ei ole täidetud ja assessmentScopes ei ole ["INDIVIDUAL"] (ainult isikupõhised hindamised).

teamMemberRoles0..*ArrayHindamisega seotud tiimiliikmete rolli klassifikaatori väärtusele (AssessmentTeamMember.roleType)
jobsites0..*Array
  • Väärtustena lubatud kasutada EHIS klassifikaatorit PEDAGOOG_AMETIKOHT väärtuseid.
  • Ei saa kasutada koos teamMemberRoles väärtusega.
  • Ei saa kasutada ilma asutuse id väärtuseta.
  • Ei saa kasutada, kui publishedToAllUsers = true

Loend ametikohtadest, millele hindamine on avatud.


assessmentScopes0..*Array
  • Lubatud väärtused:
    • INSTITUTIONAL
      • Ei saa kasutada ilma institutionId või teamMemberRoles väärtuseta.
    • 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/tühi, siis eirame Assessments.publishedToAllUsers väärtust ehk sobivad nii true kui ka false väärtused
  • publishedToAllUsers null/tühi saab kasutada kui sisendis teamMemberRoles != null. Kui teamMemberRoles = null, siis publishedToAllUsers != null/tühi.

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

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
assessments0..*Array

Nimekiri hindamistest. Süsteem eemaldab vastusest duplikaadid.

assessments.id1String (PK)

Hindamise id (UUID).

assessments.assessmentModelId1String (FK)

Viide hindamismudelile (UUID).

assessments.domain

1

EHIS ClassifierHindamise valdkond.
assessments.assessmentType

1

EHIS ClassifierHindamise liik.
assessments.assessmentScope

1

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

1

Date Hindamise algusaeg.
assessments.endDate

0..1

Date Hindamise lõppaeg.
assessments.institution

1

ObjectHindamisega seotud asutuse objekt.
assessments.institution.id

1

StringViide hindamisega seotud asutusele.
assessments.institution.type1EHIS Classifier

Asutuste liikide nimekiri, mille kasutajatele hindamismudel avaldatakse. Ühele mudelile võidakse lisada mitu asutuse liiki.

assessments.institution.name

0..1

StringMeeskonna liikme asutus
assessments.institution.regCode0..1String

Asutuse registrikood.

assessments.institution.ehakCode0..1String

Hindamisega seotud asutuse (KOVi) EHAK kood.

assessments.personalCode0..1StringIsiku isikukood, kelle kohta hindamine luuakse. Isikupõhistel hindamisel annab isiku isikukood õiguse hindamist hallata.
assessments.evaluatee0..1ObjektIsik kelle suhtes hindamist teostakse. Kasutatakse ainult isikupõhiste hindamist korral (assessmentScope = INDIVIDUAL). Asutusepõhistel hindamistel evaluatee = null 
assessments.evaluatee.firstName
String
  • Hinnatava isiku eesnimi.
  • AssessmentTeamMember.firstName, mille
    • assessmentId = Assessment.id 
    • personalCode = Assessment.personalCode 
    • roleType = TEAM_LEAD
    • objectStatus = CURRENT
assessments.evaluatee.lastName
String
  • Hinnatava isiku perekonnanimi.
  • AssessmentTeamMember.lastName, mille
    • assessmentId = Assessment.id 
    • personalCode = Assessment.personalCode 
    • roleType = TEAM_LEAD
    • objectStatus = CURRENT
assessments.evaluatee.personalCode
String
  • Hinnatava isiku eesnimi.
  • AssessmentTeamMember.personalCode, mille
    • assessmentId = Assessment.id 
    • personalCode = Assessment.personalCode 
    • roleType = TEAM_LEAD
    • objectStatus = CURRENT
assessments.jobsite0..1EHIS Classifier Object

Ametikoht, mille suhtes isiku hindamist teostatakse.. Väärtustena kasutatakse EHIS klassifikaatorit PEDAGOOG_AMETIKOHT.

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

assessments.assessmentRoles0..*Array

Nimekiri hindamisega seotud meeskonna liikme rollidest.

  • Kui sisendis ei ole määratud meeskonna liikme rolli, siis array väärtust ei täideta.
    • Kui sisendis teamMemberRoles = null, siis assessments.assessmentRoles = null
  • Kui sisendis on määratud meeskonna liikme rolli, siis array täidetakse väärtustega.
    • Kui sisendis teamMemberRoles != null, siis assessments.assessmentRoles != null
assessments.assessmentRoles.alias1String

Rolli nimetus või sellele määratud aliase väärtus.

  • Kui AssessmentModelAlias.alias != null, siis assessments.assessmentRoles.alias = AssessmentModelAlias.alias
  • Kui AssessmentModelAlias.alias = null, siis assessments.assessmentRoles.alias = AssessmentModelAlias.classifierElement.name
assessments.assessmentRoles.roleCode1Sttring

Rolli kood.

AssessmentModelAlias.classifierElement.code

assessments.archivedAt0..1Date and time

Hindamise arhiveerimise aeg. Kuupäev ja kellaaeg.

assessments.assessmentHierarchyType0..1String

Määrab hindamise hierarhia tüübi. Kasutatakse hierarhiliste hindamismudelite korra.

Väärtused:

  • null - tegemist ei ole hierarhilise hindamismudeliga.
  • MAIN_ASSESSMENT - Hierarhilise hindamismudeli peamine hindamismudel.
  • SUB_ASSESSMENT - Hierarhilise hindamismudeli ala hindamismudel.
assessments.publishedToAllUsers1Boolean

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

assessments.objectStatus1String

Objekti staatus.

  • CURRENT - Kehtiv
  • DELETED - Kustutatud

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 kontrollib, kas andmed vastavad nõuetele.
    1. Kui andmed ei vasta nõuetele, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  3. Asutusepõhiste hindamiste otsing.
    • Süsteem otsib Objektid#Assessment objekte, mille
      • assessmentScope = INSTITUTIONAL
      • institution.id = sisendis esitatud institutionId väärtus.
      • domainType = Classifier.classifierItemCode, mille
        • Classifier.definitionCode = DOMAIN
        • Classifier.classifierAttributeDefinitionCode = ASSESSMENT_VIEW_PRIVILEGE
        • Classifier.attributeValue = Kasutaja poolt valitud asutusega seotud privileegide hulgas olevad privileegid.
      • assessmentHierarchyType = null või MAIN_ASSESSMENT (!= SUB_ASSESSMENT)
      • publishedToAllUsers = Sisendis publishedToAllUsers väärtus.
      • objectStatus = CURRENT
  4. Isikupõhiste hindamiste otsing
    1. Süsteem otsib hindamiste andmed.
      • Süsteem otsib Objektid#Assessment objekte, mille
        • assessmentScope = INDIVIDUAL
        • personalCode = Päringu käivitanud kasutaja isikukood.
        • jobsite = Sisendis esitatud jobsites väärtuste hulgas.
        • institution.id = sisendis esitatud institutionId väärtus.
        • assessmentHierarchyType = null või MAIN_ASSESSMENT (!= SUB_ASSESSMENT)
        • publishedToAllUsers = Sisendis publishedToAllUsers väärtus.
        • objectStatus = CURRENT
    2. Süsteem otsib iga leitud hindamise kohta isiku andmed, kelle suhtes hindamist teostatakse.
      • Süsteem otsib Objektid#AssessmentTeamMember objekti, mille
        • assessmentId = Eelmises sammus (4.a) leitud Assessment.id väärtus.
        • personalCode = Assessment.personalCode 
        • roleType = TEAM_LEAD
        • objectStatus = CURRENT
  5. Hindamiste otsing, kus päringu käivitanud kasutaja on hindamise meeskonna liige.
    1. Süsteem otsib hindamise andmed.
      • Süsteem otsib Objektid#Assessment objekte, mille:
        • id = AssessmentTeamMember.assessmentId, mille:
          • AssessmentTeamMember.roleType = Sisendis esitatud teamMemberRoles väärtused.
          • AssessmentTeamMember.personalCode = Päringu käivitanud isiku isikukood.
          • AssessmentTeamMember.objectStatus = CURRENT
        • assessmentHierarchyType = null või MAIN_ASSESSMENT (!= SUB_ASSESSMENT)
        • publishedToAllUsers = Sisendis publishedToAllUsers väärtus.
        • objectStatus = CURRENT
    2. Süsteem otsib iga leitud hindamise rollide aliaste andmed.
      • Süsteem otsib Objektid#AssessmentModelAlias objekte, mille:
        • assessmentModelId = Assessment.assessmentModelId 
        • classifierElement = Sisendis esitatud teamMemberRoles väärtused.
        • objectStatus = CURRENT
  6. Hindamiste otsing, kui sisendis ei ole asutust, ametikohta või meeskonna liikme rolli määratud. Ehk kui otsitakse ainult isikupõhiseid hindamisi isikupõhiselt (ilma asutuseta).
    1. Süsteem otsib hindamiste andmed.
      • Süsteem otsib Objektid#Assessment objekte, mille
        • assessmentScope = INDIVIDUAL
        • publishedToAllUsers = Sisendis publishedToAllUsers väärtus.
        • personalCode = Päringu käivitanud kasutaja isikukood.
        • assessmentHierarchyType = null või MAIN_ASSESSMENT (!= SUB_ASSESSMENT)
        • objectStatus = CURRENT
  7. Süsteem tagastab leitud andmed.