SystemDnGetSummaryListRequest

Bases: OCIRequest

Request a summary table of all DNs in the system. If resellerId is specified, the DNs assigned to the enterprises/service providers within the reseller are returned. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used. The search can be done using multiple criteria. Only results matching all the search criteria are included in the results.

The response is either SystemDnGetSummaryListResponse or ErrorResponse.

The following data elements are only used in AS data mode:
  resellerId

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

Attributes:

reseller_id (Optional[str]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

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

@dataclass(kw_only=True)
class SystemDnGetSummaryListRequest(OCIRequest):
    """Request a summary table of all DNs in the system. If resellerId is specified,
        the DNs assigned to the enterprises/service providers within the reseller are returned.
        If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.
        The search can be done using multiple criteria. Only results matching all the search criteria are included in the results.

        The response is either SystemDnGetSummaryListResponse or ErrorResponse.

        The following data elements are only used in AS data mode:
          resellerId

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

    Attributes:

        reseller_id (Optional[str]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

    """

    reseller_id: Optional[str] = field(default=None, metadata={"alias": "resellerId"})

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

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

    search_criteria_exact_organization_type: Optional[
        SearchCriteriaExactOrganizationType
    ] = field(default=None, metadata={"alias": "searchCriteriaExactOrganizationType"})

Responses

Bases: OCIDataResponse

Response to SystemDnGetSummaryListRequest. The column headings are "Phone Numbers, "Service Provider Id", "Is Enterprise" and "Reseller Id".

The following columns are only returned in AS data mode:
  "Reseller Id"

Attributes:

dn_summary_table (OCITable):

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

@dataclass(kw_only=True)
class SystemDnGetSummaryListResponse(OCIDataResponse):
    """Response to SystemDnGetSummaryListRequest.
        The column headings are \"Phone Numbers, \"Service Provider Id\", \"Is Enterprise\" and \"Reseller Id\".

        The following columns are only returned in AS data mode:
          \"Reseller Id\"

    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 SystemDnGetSummaryListRequest

client = Client()

command = SystemDnGetSummaryListRequest(
    reseller_id=...,
    search_criteria_dn=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_organization_type=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDnGetSummaryListRequest",
    reseller_id=...,
    search_criteria_dn=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_organization_type=...,
)

print(response)