GroupDepartmentGetListRequest18

Bases: OCIRequest

Request a list of departments in a group. You may request only the list of departments defined at the group-level, or you may request the list of all departments in the group including all the departments defined within the enterprise the group belongs to. The response is either GroupDepartmentGetListResponse18 or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

include_enterprise_departments (bool):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class GroupDepartmentGetListRequest18(OCIRequest):
    """Request a list of departments in a group. You may request only the
        list of departments defined at the group-level, or you may request
        the list of all departments in the group including all the departments
        defined within the enterprise the group belongs to.
        The response is either GroupDepartmentGetListResponse18 or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        include_enterprise_departments (bool):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    include_enterprise_departments: bool = field(
        metadata={"alias": "includeEnterpriseDepartments"}
    )

Responses

Bases: OCIDataResponse

Response to GroupDepartmentGetListRequest18. Contains a table of department attributes. The column headings are: "Is Enterprise Department", "Department Name", "Full Path Name", "Calling Line Id Name", and "Calling Line Id Phone Number"

Attributes:

department_table (OCITable):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class GroupDepartmentGetListResponse18(OCIDataResponse):
    """Response to GroupDepartmentGetListRequest18.
        Contains a table of department attributes.
        The column headings are: \"Is Enterprise Department\", \"Department Name\", \"Full Path Name\", \"Calling Line Id Name\", and \"Calling Line Id Phone Number\"

    Attributes:

        department_table (OCITable):

    """

    department_table: OCITable = field(metadata={"alias": "departmentTable"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupDepartmentGetListRequest18

client = Client()

command = GroupDepartmentGetListRequest18(
    service_provider_id=...,
    group_id=...,
    include_enterprise_departments=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupDepartmentGetListRequest18",
    service_provider_id=...,
    group_id=...,
    include_enterprise_departments=...,
)

print(response)