Skip to content

EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22

Bases: OCIRequest

Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. 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 department in both the search criteria and sort by fields refer to the department of the user. The response is either EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse22 or ErrorResponse.

Attributes:

service_provider_id (str):

include_total_number_of_rows (Optional[bool]):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList]]):

search_criteria_mobile_subscriber_directory_number (Optional[List[SearchCriteriaMobileSubscriberDirectoryNumber]]):

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_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_exact_mobile_network (Optional[List[SearchCriteriaExactMobileNetwork]]):

search_criteria_exact_mobile_dn_availability (Optional[SearchCriteriaExactMobileDnAvailability]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22(
    OCIRequest
):
    """Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise.
        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 department in both the search criteria and sort by fields refer to the department of the user.
        The response is either EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse22 or ErrorResponse.

    Attributes:

        service_provider_id (str):

        include_total_number_of_rows (Optional[bool]):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList]]):

        search_criteria_mobile_subscriber_directory_number (Optional[List[SearchCriteriaMobileSubscriberDirectoryNumber]]):

        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_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_exact_mobile_network (Optional[List[SearchCriteriaExactMobileNetwork]]):

        search_criteria_exact_mobile_dn_availability (Optional[SearchCriteriaExactMobileDnAvailability]):

        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_order: Optional[
        List[
            SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList
        ]
    ] = field(default=None, metadata={"alias": "sortOrder"})

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

    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_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

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

    search_criteria_exact_mobile_dn_availability: Optional[
        SearchCriteriaExactMobileDnAvailability
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactMobileDnAvailability"}
    )

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

Responses

Bases: OCIDataResponse

Response to EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22. 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", "User Id", "Last Name", "First Name", "Phone Number", "Extension", "Group Id", "Department", "Department Type", "Parent Department", "Parent Department Type", "Mobile Network", "Country Code", "National Prefix", "Available", "Mobile Country Code", "Mobile National Prefix". The "Mobile Number" column contains a single DN. The "User Id", "Last Name" and "First Name" columns contains the corresponding attributes of the user possessing the DN(s). The "Phone Number" column contains a single DN. The "Group Id" column contains the Group Id of the user. The "Group Name" column contains the Group Name of the user. The "Department" column contains the department of the user if it is part of a department. The "Parent Department" column contains the parent department of the user if it is part of a department. The "Department Type" and "Parent Department Type" columns will contain the values "Enterprise" or "Group". The "Mobile Network" column contains the Mobile Network the number belongs to. The "Country Code" column indicates the dialing prefix for the phone number. The "National Prefix" column indicates the digit sequence to be dialed before the telephone number. The "Available" column indicates if the Mobile Number is available. 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]):

mobile_subscriber_directory_numbers_assignment_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse22(
    OCIDataResponse
):
    """Response to EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22.
        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\", \"User Id\", \"Last Name\", \"First Name\", \"Phone Number\", \"Extension\",
        \"Group Id\", \"Department\", \"Department Type\", \"Parent Department\", \"Parent Department Type\", \"Mobile Network\", \"Country Code\",
        \"National Prefix\", \"Available\", \"Mobile Country Code\", \"Mobile National Prefix\".
        The \"Mobile Number\" column contains a single DN.
        The \"User Id\", \"Last Name\" and \"First Name\" columns contains the corresponding attributes of the user possessing the DN(s).
        The \"Phone Number\" column contains a single DN.
        The \"Group Id\" column contains the Group Id of the user.
        The \"Group Name\" column contains the Group Name of the user.
        The \"Department\" column contains the department of the user if it is part of a department.
        The \"Parent Department\" column contains the parent department of the user if it is part of a department.
        The \"Department Type\" and \"Parent Department Type\" columns will contain the values \"Enterprise\" or \"Group\".
        The \"Mobile Network\" column contains the Mobile Network the number belongs to.
        The \"Country Code\" column indicates the dialing prefix for the phone number.
        The \"National Prefix\" column indicates the digit sequence to be dialed before the telephone number.
        The \"Available\" column indicates if the Mobile Number is available.
        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]):

        mobile_subscriber_directory_numbers_assignment_table (OCITable):

    """

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

    mobile_subscriber_directory_numbers_assignment_table: OCITable = field(
        metadata={"alias": "mobileSubscriberDirectoryNumbersAssignmentTable"}
    )

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 EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22

client = Client()

command = EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22(
    service_provider_id=...,
    include_total_number_of_rows=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_mobile_subscriber_directory_number=...,
    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_department_name=...,
    search_criteria_exact_mobile_network=...,
    search_criteria_exact_mobile_dn_availability=...,
    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("EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22",
    service_provider_id=...,
    include_total_number_of_rows=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_mobile_subscriber_directory_number=...,
    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_department_name=...,
    search_criteria_exact_mobile_network=...,
    search_criteria_exact_mobile_dn_availability=...,
    search_criteria_mode_or=...,
)

print(response)