Skip to content

UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest

Bases: OCIRequest

Get the list of all the BroadWorks Anywhere phone numbers for the user. If no sortOrder is included the response is sorted by Phone Number ascending by default. The response is either a UserBroadWorksAnywhereGetPhoneNumberPagedSortedListResponse or an ErrorResponse.

Attributes:

user_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_by_location (Optional[SortByLocation]):

sort_by_enabled (Optional[SortByEnabled]):

search_criteria_location (Optional[List[SearchCriteriaLocation]]):

search_criteria_exact_location_enabled (Optional[SearchCriteriaExactLocationEnabled]):
Source code in src/mercury_ocip/commands/commands.py 
100961
100962
100963
100964
100965
100966
100967
100968
100969
100970
100971
100972
100973
100974
100975
100976
100977
100978
100979
100980
100981
100982
100983
100984
100985
100986
100987
100988
100989
100990
100991
100992
100993
100994
100995
100996
100997
100998
100999
101000
101001
101002
101003
@dataclass(kw_only=True)
class UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest(OCIRequest):
    """Get the list of all the BroadWorks Anywhere phone numbers for the user.
        If no sortOrder is included the response is sorted by Phone Number ascending by default.
        The response is either a UserBroadWorksAnywhereGetPhoneNumberPagedSortedListResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_by_location (Optional[SortByLocation]):

        sort_by_enabled (Optional[SortByEnabled]):

        search_criteria_location (Optional[List[SearchCriteriaLocation]]):

        search_criteria_exact_location_enabled (Optional[SearchCriteriaExactLocationEnabled]):

    """

    user_id: str = field(metadata={"alias": "userId"})

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

    sort_by_location: Optional[SortByLocation] = field(
        default=None, metadata={"alias": "sortByLocation"}
    )

    sort_by_enabled: Optional[SortByEnabled] = field(
        default=None, metadata={"alias": "sortByEnabled"}
    )

    search_criteria_location: Optional[List[SearchCriteriaLocation]] = field(
        default=None, metadata={"alias": "searchCriteriaLocation"}
    )

    search_criteria_exact_location_enabled: Optional[
        SearchCriteriaExactLocationEnabled
    ] = field(default=None, metadata={"alias": "searchCriteriaExactLocationEnabled"})

Responses

Bases: OCIDataResponse

Response to the UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest. The phoneNumberTable contains columns: "Phone Number", "Description", "Activated"

Attributes:

phone_number_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py 
151183
151184
151185
151186
151187
151188
151189
151190
151191
151192
151193
151194
@dataclass(kw_only=True)
class UserBroadWorksAnywhereGetPhoneNumberPagedSortedListResponse(OCIDataResponse):
    """Response to the UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest.
        The phoneNumberTable contains columns: \"Phone Number\", \"Description\", \"Activated\"

    Attributes:

        phone_number_table (OCITable):

    """

    phone_number_table: OCITable = field(metadata={"alias": "phoneNumberTable"})

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py 
115
116
117
118
119
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 UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest

client = Client()

command = UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest(
    user_id=...,
    response_paging_control=...,
    sort_by_location=...,
    sort_by_enabled=...,
    search_criteria_location=...,
    search_criteria_exact_location_enabled=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest",
    user_id=...,
    response_paging_control=...,
    sort_by_location=...,
    sort_by_enabled=...,
    search_criteria_location=...,
    search_criteria_exact_location_enabled=...,
)

print(response)