projectal.entities.department

 1from projectal.entity import Entity
 2from projectal import api
 3from projectal.linkers import *
 4
 5
 6class Department(Entity, StaffLinker, DepartmentLinker, CompanyLinker, NoteLinker,
 7                 TagLinker):
 8    """
 9    Implementation of the [Department](https://projectal.com/docs/latest/#tag/Department) API.
10    """
11    _path = 'department'
12    _name = 'department'
13    _links = [StaffLinker, DepartmentLinker, NoteLinker, TagLinker]
14    _links_reverse = [CompanyLinker]
15
16    @staticmethod
17    def tree(holder=None, level=None, active_staff=True, inactive_staff=True,
18             generic_staff=False):
19        """
20        Return department list in tree format
21
22        `holder`: Project, Company, or Staff. If None, the full department chart
23        is returned (default: `None`)
24
25        `level`: If `True`, only returns the top level of the
26        hierarchy (default: `False`)
27
28        `active_staff`: If `True`, includes the list of staff in each
29        department who are considered 'active' (i.e, today is within
30        their start and end dates) (default: `True`)
31
32        'inactive_staff`: If `True`, includes the list of staff in each
33        department who are considered 'inactive' (i.e, today is outside
34        their start and end dates) (default: `True`)
35
36        `generic_staff`: Include generic staff in results
37        """
38        url = '/api/department/tree?'
39        params = []
40        params.append('uuId={}'.format(holder['uuId'])) if holder else None
41        params.append('level=true') if level else None
42        params.append('activeStaff={}'.format('true' if active_staff else 'false'))
43        params.append('inactiveStaff={}'.format('true' if inactive_staff else 'false'))
44        params.append('genericStaff={}'.format('true' if generic_staff else 'false'))
45        url += '&'.join(params)
46
47        return api.get(url)