NSILM

GS: AssessmentSummary: API: GET /quality-api/assessments/{assessmentId}/assessment-summaries/{assessmentSummaryId}/files/{fileId}/download

Muutja: Andres Mill · 2025-05-17

Üldkirjeldus

Teenus võimaldab kasutajal laadida alla hindamise kokkuvõtte pdf fail.

Seotud andmeobjektid:

NSIL-946 - Getting issue details... STATUS NSIL-1101 - Getting issue details... STATUS


Eeltingimused ja kasutusõigused

  • Kui tegemist on asutusepõhise hindamisega (assessmentScope = INSTITUTIONAL):
    • Kasutajal peab olema hindamise valdkonnaga seotud hindamise kokkuvõtte haldamise õigus hindamisega seotud asutuses. 
      • Classifier.classifierItemCode = Assessment.domain
      • Classifier.classifierAttributeDefinitionCode = ASSESSMENT_SHARE_MANAGE_PRIVILEGE
      • Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
      • Assessment.institution.id = Kasutaja poolt valitud rolliga seotud asutus.
  • Kui tegemist on isikupõhise hindamisega (assessmentScope =INDIVIDUAL) ja mittehierarhilise hindamisega või hierarhilise hindamise peamise hindamisega (assessmentHierarchyType = null või MAIN_ASSESSMENT (!= SUB_ASSESSMENT)):
    • Päringu käivitanud kasutaja on isik, kelle suhtes hindamist läbi viiakse.
      • Assessment.presonalCode = Päringu käivitanud isiku isikukood.
  • Kui kasutaja on hindamise meeskonna liige (Kehtib asutusepõhistel ja isikupõhistel hindamistel).
    • Kasutajal peab olema hindamise valdkonnaga seotud hindamise kokkuvõtte haldamise õigus töödeldava hindamisega seoses ja kasutaja peab olema seotud hindamisega. 
      • AssessmentTeamMember.personalCode = Päringu käivitanud isiku isikukood.
      • AssessmentTeamMember.objectStatus = CURRENT
      • Classifier.classifierItemCode = Assessment.domain
      • Classifier.classifierAttributeDefinitionCode = ASSESSMENT_SHARE_MANAGE_PRIVILEGE
      • Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
  • Kui tegemist on isikupõhise hierarhilise hindamise alamhindamisega (assessmentHierarchyType = SUB_ASSESSMENT), siis objekti andmeid hallata ei saa.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
assessmentId1String
  • Hindamine ei tohi olla kustutatud.
    • Assessment.id = assessmentId
Hindamise id.
assessmentSummaryId1Enum
  • Kokkuvõte ei tohi olla kustutatud.
    • AssessmentSummary.id = assessmentSummaryId
  • Kokkuvõte peab olema seotud sisendis esitatud hindamisega.
    • AssessmentSummary.assessmentId = Sisendis esitatud assessmentId väärtus.
  • Kokkuvõtte tüüp peab olema pdf.
    • AssessmentSummary.assessmentSummaryType = PDF
Hindamise PDF/URL jagatava kokkuvõtva aruande id.
fileId1
  • Faili viide ei tohi kokkuvõtte küljest olla kustutatud.
    • AssessmentSummary.files.fileId = Sisendis esitatud fileId väärtus.

Kokkuvõttega seotud fail.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
file0..1file

Fail

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. Süsteem otsib failisüsteemist faili, mille File.id =AssessmentSummary.files.fileId ja AssessmentComponentElement.files.id = Sisendis esitatud fileId väärtus.
  4. Süsteem tagastab leitud faili.