Skip to content

Organization unit

delete_organization_units(ids, delete_children=False, logger=None, session=None)

Delete organization units

:param ids: List of organization unit id :param logger: Logger object instance :param session: SQLAlchemy session :return: Array of deleted id

get_organization_unit(organization_id, relations, id=None, logger=None, session=None, orm_entities=False)

Get detail of organization unit

:param organization_id: Organization identifier :param relations: Flag sum of associated enities type. Use Entities enum type. :param id: Organization unit identifier :param session: SQLAlchemy session :param orm_entities: If True, return mapping models, else domain models :return: Dictionary with 2 keys. [Data]: a list of OrganizationUnitModel entities (if orm_entities==True) or a list of OrganizationUnit (if orm_entities=False). [Total]: record count.

get_organization_units(organization_id, relations, ids=None, order=None, offset=0, limit=100, filters=None, logger=None, session=None, orm_entities=False)

Get list of organization units

:param organization_id: Organization identifier :param relations: Flag sum of associated enities type. Use Entities enum type. :param ids: List of identifiers of organization units. If empty, load all data. :param order: Order field :param offset: Index of first record :param limit: Number of records to be returned :param filters: JSON string with query filter :param session: SQLAlchemy session :param orm_entities: If True, return mapping models, else domain models :return: Dictionary with 2 keys. [Data]: a list of OrganizationUnitModel entities (if orm_entities==True) or a list of OrganizationUnit (if orm_entities=False). [Total]: record count.

save_organization_unit(organization_id, payload, logger=None, session=None)

Save organization unit

Parameters:

Name Type Description Default
organization_id uuid

Organization unit identifier

required
obj OrganizationUnit

Organization unit object

required
session SQLAlchemy

SQLAlchemy session

None

Returns:

Name Type Description
OrganizationUnit OrganizationUnit

Organization unit object