Skip to content

SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest

Bases: OCIRequest

Request a summary table of all Mobile Subscriber Directory Numbers in a system. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the mobile subscriber directory numbers in the administrator's reseller meeting the search criteria are returned. The response is either SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse or ErrorResponse.

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

Attributes:

response_size_limit (Optional[int]):

search_criteria_mobile_subscriber_directory_number (Optional[List[SearchCriteriaMobileSubscriberDirectoryNumber]]):

search_criteria_exact_mobile_network (Optional[SearchCriteriaExactMobileNetwork]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest(
    OCIRequest
):
    """Request a summary table of all Mobile Subscriber Directory Numbers in a system.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the mobile subscriber
        directory numbers in the administrator's reseller meeting the search criteria are returned.
        The response is either SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse or ErrorResponse.

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

    Attributes:

        response_size_limit (Optional[int]):

        search_criteria_mobile_subscriber_directory_number (Optional[List[SearchCriteriaMobileSubscriberDirectoryNumber]]):

        search_criteria_exact_mobile_network (Optional[SearchCriteriaExactMobileNetwork]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_mobile_subscriber_directory_number: Optional[
        List[SearchCriteriaMobileSubscriberDirectoryNumber]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaMobileSubscriberDirectoryNumber"},
    )

    search_criteria_exact_mobile_network: Optional[SearchCriteriaExactMobileNetwork] = (
        field(default=None, metadata={"alias": "searchCriteriaExactMobileNetwork"})
    )

    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"})

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

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

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

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

Responses

Bases: OCIDataResponse

Response to SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest. The response contains a table with columns: "Mobile Number", "Mobile Network", "Service Provider Id", "Is Enterprise", "Group Id", "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension" and "Reseller Id".

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

Attributes:

mobile_subscriber_directory_numbers_summary_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse(
    OCIDataResponse
):
    """Response to SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest.
        The response contains a table with columns: \"Mobile Number\", \"Mobile Network\", \"Service Provider Id\",
        \"Is Enterprise\", \"Group Id\", \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\",
        \"Hiragana First Name\", \"Phone Number\", \"Extension\" and \"Reseller Id\".

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

    Attributes:

        mobile_subscriber_directory_numbers_summary_table (OCITable):

    """

    mobile_subscriber_directory_numbers_summary_table: OCITable = field(
        metadata={"alias": "mobileSubscriberDirectoryNumbersSummaryTable"}
    )

Bases: OCIResponse

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

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest

client = Client()

command = SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest(
    response_size_limit=...,
    search_criteria_mobile_subscriber_directory_number=...,
    search_criteria_exact_mobile_network=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_organization_type=...,
    search_criteria_group_id=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest",
    response_size_limit=...,
    search_criteria_mobile_subscriber_directory_number=...,
    search_criteria_exact_mobile_network=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_organization_type=...,
    search_criteria_group_id=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_reseller_id=...,
)

print(response)