GroupDnGetSummaryListRequest

Bases: OCIRequest

Get the list of assigned and unassigned DN ranges in a group. Dns assigned to the IMRN pool are not listed in the response. The response is either a GroupDnGetSummaryListResponse 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 GroupDnGetSummaryListRequest(OCIRequest):
    """Get the list of assigned and unassigned DN ranges in a group.
        Dns assigned to the IMRN pool are not listed in the response.
        The response is either a GroupDnGetSummaryListResponse 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 GroupDnGetSummaryListRequest. The response contains a table with columns: "Phone Numbers", "Assigned". The "Phone Numbers" column contains either a single DN or a range of DNs. The "Assigned" column contains a boolean flag indicating if the DN(s) are currently assigned to a user or service instance. The "Activated" column indicates if the DN or DN range has been activated. Only has a value if the DN(s) is assigned to a user or if either “User Enable Activation mode “ or "Group and User Enable Activation Mode" is enabled.

Attributes:

dn_table (OCITable):

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

@dataclass(kw_only=True)
class GroupDnGetSummaryListResponse(OCIDataResponse):
    """Response to the GroupDnGetSummaryListRequest.
        The response contains a table with columns: \"Phone Numbers\", \"Assigned\".
        The \"Phone Numbers\" column contains either a single DN or a range of DNs.
        The \"Assigned\" column contains a boolean flag indicating if the DN(s) are
        currently assigned to a user or service instance.
        The \"Activated\" column indicates if the DN or DN range has been activated.
        Only has a value if the DN(s) is assigned to a user or if either “User Enable Activation mode “
        or \"Group and User 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 GroupDnGetSummaryListRequest

client = Client()

command = GroupDnGetSummaryListRequest(
    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("GroupDnGetSummaryListRequest",
    service_provider_id=...,
    group_id=...,
)

print(response)