GS: AssessmentModel: API: GET /quality-api/assessment-models/{id}
Üldkirjeldus
Teenus võimaldab pärida hindamismudeli üldandmeid.
Seotud andmeobjektid:
NSIL-63 - Getting issue details... STATUS NSIL-710 - Getting issue details... STATUS NSIL-988 - Getting issue details... STATUS
Eeltingimused ja kasutusõigused
- Kasutajal peab olema privileeg NSILM_ASSESSMENT_MODEL_MANAGE
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| id | 1 | String | Hindamismudeli id (UUID). |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| id | 1 | String | Hindamismudeli id (UUID). |
| code | 1 | String | Hindamismudeli unikaalne äriline id ehk kood. |
| name | 1 | String | Hindamismudeli nimetus. |
| assessmentType | 1 | Object | Hindamise liik. |
| assessmentType.definitionCode | 1 | Object | Hindamise liigi klassifikaatori objekt. |
| assessmentType.code | 1 | String | Klassifikaatori rea tähis. |
| assessmentType.name | 1 | String | Klassifikaatori rea tekst (rea pealkiri ehk nimetus). |
| assessmentType.officialName | 0..1 | String | Klassifikaatori rea tekst, mis tuleneb seadusest ja mida kasutatakse ametlikel väljundvormidel. Vaikeväärtus on name. |
| assessmentType.shortName | 0..1 | String | Klassifikaatori rea tekst, mida kasutatakse kasutajaliidesel siis, kui teksti pikkus on oluline (nt dropdown valikunimistutes). Vaikeväärtus on name. |
| assessmentType.seqNo | 0..1 | Number | Klassifikaatori rea järjekorranumber. Määrab ridade kuvamise järjekorra enne muid atribuute (nt nimetus). |
| assessmentScope | 1 | String | Määrab, kas hindamine on mõeldud asutusepõhiseks hindamiseks (INSTITUTIONAL) või isikupõhiseks hindamiseks (INDIVIDUAL). |
| validFrom | 1 | Date | Hindamismudeli kehtivuse algus |
| validUntil | 0..1 | Date | Hindamismudeli kehtivuse lõpp |
| confirmed | 1 | Boolean | Määrab, kas hindamismudel on kinnitatud või mitte.
|
| numberOfAssessments | 1 | Number | Hindamismudeliga seotud hindamiste arv. Kui ühtegi ei leita, siis tagastatakse arv 0.
|
| domainType | 1 | Object | Hindamismudeli valdkond. |
| domainType.definitionCode | 1 | Object | Hindamismudeli valdkonna klassifikaatori objekt. |
| domainType.code | 1 | String | Klassifikaatori rea tähis. |
| domainType.name | 1 | String | Klassifikaatori rea tekst (rea pealkiri ehk nimetus). |
| domainType.officialName | 0..1 | String | Klassifikaatori rea tekst, mis tuleneb seadusest ja mida kasutatakse ametlikel väljundvormidel. Vaikeväärtus on name. |
| domainType.shortName | 0..1 | String | Klassifikaatori rea tekst, mida kasutatakse kasutajaliidesel siis, kui teksti pikkus on oluline (nt dropdown valikunimistutes). Vaikeväärtus on name. |
| domainType.seqNo | 0..1 | Number | Klassifikaatori rea järjekorranumber. Määrab ridade kuvamise järjekorra enne muid atribuute (nt nimetus). |
| phaseTypes | 1..* | Array | Hindamismudeli etapid. |
| phasesTypes.definitionCode | 1 | Object | Hindamismudeli etapp. |
| phasesTypes.code | 1 | String | Klassifikaatori rea tähis. |
| phasesTypes.name | 1 | String | Klassifikaatori rea tekst (rea pealkiri ehk nimetus). |
| phaseTypes.officialName | 0..1 | String | Klassifikaatori rea tekst, mis tuleneb seadusest ja mida kasutatakse ametlikel väljundvormidel. Vaikeväärtus on name. |
| phaseTypes.shortName | 0..1 | String | Klassifikaatori rea tekst, mida kasutatakse kasutajaliidesel siis, kui teksti pikkus on oluline (nt dropdown valikunimistutes). Vaikeväärtus on name. |
| phaseTypes.seqNo | 0..1 | Number | Klassifikaatori rea järjekorranumber. Määrab ridade kuvamise järjekorra enne muid atribuute (nt nimetus). |
| institutions | 1..* | Array | Asutuste liikide nimekiri, mille kasutajatele hindamismudel avaldatakse. Ühele mudelile võidakse lisada mitu asutuse liiki. |
| institutions.institutionType | 1 | Object | Asutuse liigi objekt. |
| institutions.institutionType.definitionCode | 1 | Object | Hindamise liik. |
| institutions.institutionType.code | 1 | String | Klassifikaatori rea tähis. |
| institutions.institutionType.name | 1 | String | Klassifikaatori rea tekst (rea pealkiri ehk nimetus). |
| institutions.institutionType.officialName | 0..1 | String | Klassifikaatori rea tekst, mis tuleneb seadusest ja mida kasutatakse ametlikel väljundvormidel. Vaikeväärtus on name. |
| institutions.institutionType.shortName | 0..1 | String | Klassifikaatori rea tekst, mida kasutatakse kasutajaliidesel siis, kui teksti pikkus on oluline (nt dropdown valikunimistutes). Vaikeväärtus on name. |
| institutions.institutionType.seqNo | 0..1 | Number | Klassifikaatori rea järjekorranumber. Määrab ridade kuvamise järjekorra enne muid atribuute (nt nimetus). |
| institutions.specificationTypes | 0..* | Array | Asutuse liigi täpsustused. Ühel asutuse liigil võib olla mitu täpsustust. |
| institutions.specificationTypes.definitionCode | 1 | Object | Asutuse liigi objekt. |
| institutions.specificationTypes.code | 1 | String | Klassifikaatori rea tähis. |
| institutions.specificationTypes.name | 1 | String | Klassifikaatori rea tekst (rea pealkiri ehk nimetus). |
| institutions.specificationTypes.officialName | 0..1 | String | Klassifikaatori rea tekst, mis tuleneb seadusest ja mida kasutatakse ametlikel väljundvormidel. Vaikeväärtus on name. |
| institutions.specificationTypes.shortName | 0..1 | String | Klassifikaatori rea tekst, mida kasutatakse kasutajaliidesel siis, kui teksti pikkus on oluline (nt dropdown valikunimistutes). Vaikeväärtus on name. |
| institutions.specificationTypes.seqNo | 0..1 | Number | Klassifikaatori rea järjekorranumber. Määrab ridade kuvamise järjekorra enne muid atribuute (nt nimetus). |
| institutions.institutionIds | 0..1 | Array | Asutuste nimekiri. |
| jobsites | 0..* | 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) |
| statusType | 1 | Object | Hindamismudeli äriline staatus. Staatused ja tingimused:
|
| statusType.definitionCode | 1 | Object | Hindamismudeli staatus. |
| statusType.code | 1 | String | Klassifikaatori rea tähis. |
| statusType.name | 1 | String | Klassifikaatori rea tekst (rea pealkiri ehk nimetus). |
| statusType.officialName | 0..1 | String | Klassifikaatori rea tekst, mis tuleneb seadusest ja mida kasutatakse ametlikel väljundvormidel. Vaikeväärtus on name. |
| statusType.shortName | 0..1 | String | Klassifikaatori rea tekst, mida kasutatakse kasutajaliidesel siis, kui teksti pikkus on oluline (nt dropdown valikunimistutes). Vaikeväärtus on name. |
| statusType.seqNo | 0..1 | Number | Klassifikaatori rea järjekorranumber. Määrab ridade kuvamise järjekorra enne muid atribuute (nt nimetus). |
| assessmentHierarchyType | 0..1 | String | Määrab hindamise hierarhia tüübi. Kasutatakse hierarhiliste hindamismudelite korra. Väärtused:
|
| includedSubRoles | 0..* | Array | Hierarhilise hindamismudeli kaasatud rollide nimistu. Kasutatakse hierarhilise mudeli peamise hindamise juures. |
| includedSubRoles.roleType | 1 | EHIS Classifier | Kaasatud rolli EHIS klassifikaatori objekt. Väärtusena kasutatakse Klassifikaatorid#KlassifikaatorASSESSMENT_ROLE väärtust. |
| includedSubRoles.minimumRespondentsCount | 1 | Integer | Defineerib palju peab olema antud rollis minimaalselt vastanuid, et hierarhilises hindamises saaks hinnatav enesehindamise etapi kinnitada. |
| includedSubRoles.questionnaireDeadlineDays | 1 | Integer | Defineerib mitme päeva jooksul peab rollil küsimustik täidetud olema. |
| publishedToAllUsers | 1 | Boolean | Defineerib, kas hindamismudel on avaldatud kõikidele sisseloginud kasutajatele või mitte. |
| objectStatus | 1 | String | Objekti staatus. |
Tegevused
- Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
- Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem otsib päringus esitatud tingimustele vastava objekti.
- Süsteem otsib Objektid#AssessmentModel objekti, mille
- id = Sisendis esitatud id väärtus.
- objectStatus = CURRENT
- Süsteem otsib Objektid#AssessmentModel objekti, mille
- Süsteem tagastab leitud andmed.
- Kui tingimustele vastavat objekti ei leitud, lõpetatakse päringu töötlemine ja tagastatakse http veakood.