Skip to content

Office area

delete(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Delete an office area entities.

Parameters:

Name Type Description Default
body EntitiesDeleteRequest

A list of requested entities. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on delete office area

body

exception message

Returns:

Type Description
EntitiesDeleteBaseResponse

EntitiesDeleteBaseResponse

get(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a list of office area

Parameters:

Name Type Description Default
body EntityGetRequest

A list of requested entity. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get office area details

body

exception message

Returns:

Type Description
OfficeAreaListResponse

A Dictionary with

  • "entities" as key , (List[OfficeArea]) as value

  • "total" as key : record count as value

list(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a list of office area

Parameters:

Name Type Description Default
body EntitiesListRequest

A list of requested entities. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get office area list

body

exception message

Returns:

Type Description
OfficeAreaListResponse

A Dictionary with

  • "entities" as key , (List[OrganizationMemberProfile]) as value

  • "total" as key : record count as value

save(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Save or update an office area.

Parameters:

Name Type Description Default
body EntityGetRequest

A list of requested entity. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get office area details

body

exception message

Returns:

Name Type Description
OfficeArea OfficeArea

The new or updated OfficeArea