Skip to content

Office area

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

Delete office area

Parameters:

Name Type Description Default
ids list[str]

List of office area identifiers

required
delete_children bool

Flag to delete children

False
logger

Logger object instance

None
session SQLAlchemy

SQLAlchemy session

None

Returns:

Name Type Description
ids list[str]

List of deleted office area identifiers

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

Get detail of office area

:param organization_id: Organization identifier :param relations: Flag sum of associated enities type. Use Entities enum type. :param id: Office area 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 OfficeAreaModel entities (if orm_entities==True) or a list of OfficeArea (if orm_entities=False). [Total]: record count.

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

Get list of office areas

:param organization_id: Organization identifier :param relations: Flag sum of associated enities type. Use Entities enum type. :param ids: List of identifiers of office areas. 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 OfficeAreaModel entities (if orm_entities==True) or a list of OfficeArea (if orm_entities=False). [Total]: record count.

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

Save office area

Parameters:

Name Type Description Default
organization_id uuid

Organization unit identifier

required
obj OfficeArea

Office Area object

required
logger

Logger object instance

None
session SQLAlchemy

SQLAlchemy session

None

Returns:

Name Type Description
OfficeArea OfficeArea

OfficeArea object