GET workUnit/getSupervisors?Name={Name}&Token={Token}

Retrieve all supervisors of the working unit. Privilege "View" of licensed agenda "Work units" required. Data may also be restricted by record permission "View" of agenda "Working units" and "Persons".

Request Information

Authorization

  • Authorization by token required

Availability

  • Method can be used

URI Parameters

NameDescriptionTypeAdditional information
Name

Working unit name

string

Required

String length: inclusive between 0 and 100

Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

globally unique identifier

Required

Body Parameters

None.

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 successfully done
202 request accepted 2205 successfully done, but some data of the agenda Persons blocked by record permission
400 bad request 1002 Entry parameter missing or parameter bindigs failed
401 unauthorized 1000 Token {0} not found
401 unauthorized 1001 Token {0} already expired
401 unauthorized 1006 Ip filter violated for ip client address [{0}]
401 unauthorized 1007 Ip filter [{0}] parsing failed
401 unauthorized 1008 Request rate policy violated for [{0}]
403 server refuses fo fulfill the request 2200 Privilege View of agenda Working units violated for [all]
403 server refuses fo fulfill the request 2202 Record permission View of agenda Working unit and Persons violated for [{0}]
404 required resource does not exist on the server 2201 Working units [{0}] not found
404 required resource does not exist on the server 2203 No supervisors of working unit [{0}] found
404 required resource does not exist on the server 2205 some data of the agenda Persons blocked by record permission
500 internal error Server exception description

Resource Description

WorkUnitGetSupervisorsResp
NameDescriptionTypeAdditional information
Supervisors

Collection of WorkUnitSupervisor

None.

Response Formats

application/json

Sample:
{"Supervisors":[{"PersonId":"0000125","ValidFrom":"\/Date(1729228398215)\/","ValidTo":"\/Date(1729228398215)\/","ApproverOrder":1,"SentCopy":1,"IsApprover":0,"DeputyFor":"0000032"}]}

application/xml

Sample:

<Response>
  <Supervisors>
    <WorkUnitSupervisor>
      <PersonId>0000125</PersonId>
      <ValidFrom>2024-10-18T05:13:18.2155801Z</ValidFrom>
      <ValidTo>2024-10-18T05:13:18.2155801Z</ValidTo>
      <ApproverOrder>1</ApproverOrder>
      <SentCopy>1</SentCopy>
      <IsApprover>0</IsApprover>
      <DeputyFor>0000032</DeputyFor>
    </WorkUnitSupervisor>
  </Supervisors>
</Response>

text/json

Sample:
{
  "Supervisors": [
    {},
    {}
  ]
}

text/xml

Sample:
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Supervisors>
    <WorkUnitSupervisor />
    <WorkUnitSupervisor />
  </Supervisors>
</Response>