Skip to content

GroupDnGetDetailedAvailableListRequest

Bases: OCIRequest

Get the list of DNs that are assigned to a group and still available for assignment to users within the group with the department name, if the DN is assigned to the department. Dns assigned to the IMRN pool are not listed in the response. The response is either a GroupDnGetDetailedAvailableListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupDnGetDetailedAvailableListRequest(OCIRequest):
    """Get the list of DNs that are assigned to a group and still available for
        assignment to users within the group with the department name, if the DN
        is assigned to the department.
        Dns assigned to the IMRN pool are not listed in the response.
        The response is either a GroupDnGetDetailedAvailableListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

    """

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

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

Responses

Bases: OCIDataResponse

Response to the GroupDnGetDetailedAvailableListRequest. The response contains a table with columns: "Phone Number", "Department". The "Phone Numbers" column contains a single DN. The "Department" column contains the department of the DN if the DN is part of the department. The "Activated" column indicates if the DN has been activated. Only has a value if the DN(s) is assigned to a user or if "Group Enable Activation Mode" is enabled.

Attributes:

dn_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupDnGetDetailedAvailableListResponse(OCIDataResponse):
    """Response to the GroupDnGetDetailedAvailableListRequest.
        The response contains a table with columns: \"Phone Number\", \"Department\".
        The \"Phone Numbers\" column contains a single DN.
        The \"Department\" column contains the department of the DN if the DN is part of the department.
        The \"Activated\" column indicates if the DN has been activated.
        Only has a value if the DN(s) is assigned to a user or if \"Group
        Enable Activation Mode\" is enabled.

    Attributes:

        dn_table (OCITable):

    """

    dn_table: OCITable = field(metadata={"alias": "dnTable"})

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import GroupDnGetDetailedAvailableListRequest

client = Client()

command = GroupDnGetDetailedAvailableListRequest(
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupDnGetDetailedAvailableListRequest",
    service_provider_id=...,
    group_id=...,
)

print(response)