EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest

Bases: OCIRequest

Request a summary table of all enterprise trunk number prefixes in the enterprise. The response is either EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

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

@dataclass(kw_only=True)
class EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest(OCIRequest):
    """Request a summary table of all enterprise trunk number prefixes in the enterprise.
        The response is either EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest. The response contains a table with columns: "Number Prefix", "Group Id", "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", "Enterprise Trunk"","Is Active", "Extension Range Start" and "Extension Range End". The "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department" and "Email Address" columns contains the corresponding attributes of the user possessing the number range. The "Enterprise Trunk" column contains the enterprise trunk the user possessing the number range belongs to. The "Is Active" column indicates if the number range has been activated. The "Extension Range Start" column indicates the start for an extension range. The "Extension Range End" column indicates the end for an extension range.

Attributes:

prefix_summary_table (OCITable):

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

@dataclass(kw_only=True)
class EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListResponse(
    OCIDataResponse
):
    """Response to EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest.
        The response contains a table with columns: \"Number Prefix\", \"Group Id\", \"User Id\",
        \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\", \"Phone Number\", \"Extension\", \"Department\",
        \"Email Address\", \"Enterprise Trunk\"\",\"Is Active\", \"Extension Range Start\" and \"Extension Range End\".
        The \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\", \"Phone Number\",
        \"Extension\", \"Department\" and \"Email Address\" columns contains the corresponding attributes of the user possessing the number range.
        The \"Enterprise Trunk\" column contains the enterprise trunk the user possessing the number range belongs to.
        The \"Is Active\" column indicates if the number range has been activated.
        The \"Extension Range Start\" column indicates the start for an extension range.
        The \"Extension Range End\" column indicates the end for an extension range.

    Attributes:

        prefix_summary_table (OCITable):

    """

    prefix_summary_table: OCITable = field(metadata={"alias": "prefixSummaryTable"})

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 EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest

client = Client()

command = EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest(
    service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseRouteListEnterpriseTrunkNumberPrefixGetSummaryListRequest",
    service_provider_id=...,
)

print(response)