ServiceProviderDnGetSummaryListRequest

Bases: OCIRequest

Request a summary table of all DNs in a service provider. Dns assigned to the IMRN pool are not listed in the response. The search can be done using multiple criteria. Only results matching all the search criteria are included in the results. The response is either ServiceProviderDnGetSummaryListResponse or ErrorResponse.

The following elements are only used in XS data mode and ignored in AS data mode:
  searchCriteriaDn, searchCriteriaGroupId

Attributes:

service_provider_id (str):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

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

@dataclass(kw_only=True)
class ServiceProviderDnGetSummaryListRequest(OCIRequest):
    """Request a summary table of all DNs in a service provider.
        Dns assigned to the IMRN pool are not listed in the response.
        The search can be done using multiple criteria. Only results matching all the search criteria are included in the results.
        The response is either ServiceProviderDnGetSummaryListResponse or ErrorResponse.

        The following elements are only used in XS data mode and ignored in AS data mode:
          searchCriteriaDn, searchCriteriaGroupId

    Attributes:

        service_provider_id (str):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

    """

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

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

Responses

Bases: OCIDataResponse

Response to ServiceProviderDnGetSummaryListRequest. The column headings are "Phone Numbers, "Group Id" and "Can Delete"

Attributes:

dn_summary_table (OCITable):

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

@dataclass(kw_only=True)
class ServiceProviderDnGetSummaryListResponse(OCIDataResponse):
    """Response to ServiceProviderDnGetSummaryListRequest.
        The column headings are \"Phone Numbers, \"Group Id\" and \"Can Delete\"

    Attributes:

        dn_summary_table (OCITable):

    """

    dn_summary_table: OCITable = field(metadata={"alias": "dnSummaryTable"})

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 ServiceProviderDnGetSummaryListRequest

client = Client()

command = ServiceProviderDnGetSummaryListRequest(
    service_provider_id=...,
    search_criteria_group_id=...,
    search_criteria_dn=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderDnGetSummaryListRequest",
    service_provider_id=...,
    search_criteria_group_id=...,
    search_criteria_dn=...,
)

print(response)