NSILM

PM: API: Team: GET /planning-api/goal-team-members

Muutja: Natalja Selivjorstova · 2025-04-10

Üldkirjeldus

Teenus võimaldab pärida meeskonnaliikmete nimekirja, kes on seotud kasutaja rollis valitud asutuse või ametikoha arhiveerimata eesmärkidega.

Iga unikaalse isikukoodi kohta saab ühe asutuse / ametikoha piires olla ainult üks meeskonnaliikme kirje. Seetõttu sisaldab päringu vastus ainult unikaalsete isikukoodidega meeskonnaliikmeid. 

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-802 - Getting issue details... STATUS

NSIL-922 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kui päritakse asutuse eesmärkide meeskonnaliikmeid (goalScope = INSTITUTIONAL):

    • Kasutajal on seos meeskonnaliikmete eesmärkide asutusega ja tal on selle asutuse eesmärkide vaatamise õigus.  
      • GoalTeamMember.id = Goal.teamMembersIds.id, mille: 
        • Goal.institution.id = Sisendis esitatud "institutionId" väärtus = Kasutaja poolt valitud rolliga seotud asutus
      • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_VIEW.
  • Kui päritakse ametikoha eesmärkide meeskonnaliikmeid (goalScope = INDIVIDUAL):
    • Kasutaja on meeskonnaliikmete eesmärkide omanik.
      • GoalTeamMember.id = Goal.teamMembers.id, mille: 
        • Goal.personalCode = Kasutaja isikukood

Planeerimise mooduli kasutusrollide ja õiguste kohta saab täpsemalt infot leida lehelt Kasutusõigused ja rollid.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info

goalScope

1

String
  • Võimalikud väärtused:
    • INSTITUTIONAL
    • INDIVIDUAL

Määrab, millis tüüpi eesmärkidest meeskonnaliikmeid otsitakse:

  • INSTITUTIONAL — Meeskonnaliiget otsitakse ainult asutusega seotud eesmärkide alusel.
  • INDIVIDUAL — Meeskonnaliiget otsitakse ainult konkreetse isikuga seotud eesmärkide alusel.

institutionId

1

String
  • Väärtus peab vastama kasutaja valitud rolliga seotud asutuse ID-le.
Viide asutusele, millega eesmärgid peavad olema seotud. 

jobsite

0..1

String
  • Väärtus peab vastama kasutaja valitud rolliga seotud ametikohale.
  • Väärtus peab vastama EHIS klassifikaatorile PEDAGOOG_AMETIKOHT.
  • Kohustuslik, kui goalScope = "INDIVIDUAL".
  • Ei tohi olla määratud, kui goalScope = "INSTITUTIONAL".
Viide ametikohale, millega eesmärgid peavad olema seotud. 

Väljundid

Atribuut

Kohustuslikkus, mitmesus

TüüpKirjeldus, täiendav info

goalTeamMembers

0..*

Array

Kasutaja asutuse/ametikoha eesmärkidega seotud meeskonnaliikmed.

goalTeamMembers.id

1

StringMeeskonnaliikme unikaalne identifikaator.

goalTeamMembers.personalCode

1

StringMeeskonnaliikme isikukood.

goalTeamMembers.firstName

0..1

StringMeeskonnaliikme eesnimi.
goalTeamMembers.lastName

0..1

StringMeeskonnaliikme perenimi.
goalTeamMembers.email

0..1

StringMeeskonnaliikme e-posti aadress.

goalTeamMembers.phoneNumber

0..1

StringMeeskonnaliikme telefoninumber.

goalTeamMembers.institution

0..1

StringMeeskonnaliikme asutuse nimetus.

goalTeamMembers.jobTitle

0..1

StringMeeskonnaliikme ametinimetus.

goalTeamMembers.profileColor

1

StringMeeskonnaliikme profiili värvikood.


Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui õigust ei ole, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  2. Süsteem kontrollib, kas sisendandmed vastavad nõuetele.
    1. Kui andmed ei vasta nõuetele, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  3. Süsteem otsib sisendis esitatud asutuse või ametikohaga seotud arhiveerimata eesmärkide meeskonnaliikmeid: 
    1. Süsteem otsib sisendis esitatud asutuse või ametikohaga seotud arhiveerimata eesmärke:
      1. Otsitakse Objektid#Goal objekte, mille:
        1. institution.id = Sisendis esitatud "institutionId" väärtus
        2. goalScope = Sisendis esitatud "goalScope" väärtus
        3. archived = false
        4. Kui sisendis esitatud goalScope = "INSTITUTIONAL", siis:  
          1. jobsite = NULL
          2. personalCode = NULL
        5. Kui sisendis esitatud goalScope = "INDIVIDUAL", siis:
          1. personalCode = Päringu käivitanud kasutaja isikukood
          2. jobsite = Sisendis esitatud "jobsite" väärtus
      2. Kui ühtegi sobivat eesmärki ei leita, tagastatakse tühi vastus. See tähendab, et asutusel/ametikohal ei ole ühtegi arhiveerimata eesmärki ja seetõttu ei ole ka meeskonnaliikmeid. 
    2. Süsteem otsib leitud eesmärkide meeskonnaliikmeid. 
      1. Süsteem otsib Objektid#GoalTeamMember objekte, mille:
        • id = leitud eesmärkide meeskonnaliikmete ID-d (Objektid#Goal.goalTeamMemberIds.id)
      2. Kui mõnda meeskonnaliiget ei leita, logitakse viga. 
  4. Süsteem tagastab leitud meeskonnaliikmete nimekirja.