Skip to content

EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22

Bases: OCIRequest

Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. The response is either EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse22 or ErrorResponse.

Attributes:

service_provider_id (str):

include_total_number_of_rows (Optional[bool]):

response_paging_control (Optional[ResponsePagingControl]):

sort_by_mobile_directory_number (Optional[SortByMobileDirectoryNumber]):

search_criteria_mobile_subscriber_directory_number (Optional[List[SearchCriteriaMobileSubscriberDirectoryNumber]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22(
    OCIRequest
):
    """Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user.
        If the responsePagingControl element is not provided, the paging startIndex will be set to 1
        by default, and the responsePageSize will be set to the maximum ResponsePageSize by default.
        If no sortOrder is included the response is sorted by Mobile Number ascending by default.
        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
        Then the search criteria are logically ORed together.
        The response is either EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse22 or ErrorResponse.

    Attributes:

        service_provider_id (str):

        include_total_number_of_rows (Optional[bool]):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_by_mobile_directory_number (Optional[SortByMobileDirectoryNumber]):

        search_criteria_mobile_subscriber_directory_number (Optional[List[SearchCriteriaMobileSubscriberDirectoryNumber]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

    include_total_number_of_rows: Optional[bool] = field(
        default=None, metadata={"alias": "includeTotalNumberOfRows"}
    )

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_by_mobile_directory_number: Optional[SortByMobileDirectoryNumber] = field(
        default=None, metadata={"alias": "sortByMobileDirectoryNumber"}
    )

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

    search_criteria_mode_or: Optional[bool] = field(
        default=None, metadata={"alias": "searchCriteriaModeOr"}
    )

Responses

Bases: OCIDataResponse

Response to EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22. The response contains the number of entries that would be returned if the response was not page size restricted. Contains a table with columns: "Mobile Number", "Mobile Network", "Mobile Country Code", "Mobile National Prefix". The "Mobile Number" column contains a single DN. The "Mobile Network" column contains the Mobile Network the number belongs to. The "Mobile Country Code" column indicates the dialing prefix for the mobile number. The "Mobile National Prefix" column indicates the digit sequence to be dialed before the mobile number.

Attributes:

total_number_of_rows (Optional[int]):

available_mobile_subscriber_directory_number_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse22(
    OCIDataResponse
):
    """Response to EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22.
        The response contains the number of entries that would be returned if the response was not page size restricted.
        Contains a table with columns: \"Mobile Number\", \"Mobile Network\", \"Mobile Country Code\", \"Mobile National Prefix\".
        The \"Mobile Number\" column contains a single DN.
        The \"Mobile Network\" column contains the Mobile Network the number belongs to.
        The \"Mobile Country Code\" column indicates the dialing prefix for the mobile number.
        The \"Mobile National Prefix\" column indicates the digit sequence to be dialed before the mobile number.

    Attributes:

        total_number_of_rows (Optional[int]):

        available_mobile_subscriber_directory_number_table (OCITable):

    """

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

    available_mobile_subscriber_directory_number_table: OCITable = field(
        metadata={"alias": "availableMobileSubscriberDirectoryNumberTable"}
    )

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 EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22

client = Client()

command = EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22(
    service_provider_id=...,
    include_total_number_of_rows=...,
    response_paging_control=...,
    sort_by_mobile_directory_number=...,
    search_criteria_mobile_subscriber_directory_number=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22",
    service_provider_id=...,
    include_total_number_of_rows=...,
    response_paging_control=...,
    sort_by_mobile_directory_number=...,
    search_criteria_mobile_subscriber_directory_number=...,
    search_criteria_mode_or=...,
)

print(response)