Skip to content

UserPersonalPhoneListGetPagedSortedListRequest

Bases: OCIRequest

Get a user's personal phone list. The response is either a UserPersonalPhoneListGetPagedSortedListResponse or an ErrorResponse. The search can be done using multiple criterion. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterion are included in the results. If no search criteria is specified, all results are returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. The sort can done by the personal phone list number or name. The following elements are only used in AS data mode and ignored in XS data mode: searchCriteriaUserPersonalMultiPartPhoneListName

Attributes:

user_id (str):

response_paging_control (ResponsePagingControl):

sort_by_user_personal_phone_list_number (Optional[SortByUserPersonalPhoneListNumber]):

sort_by_user_personal_phone_list_name (Optional[SortByUserPersonalPhoneListName]):

search_criteria_mode_or (Optional[bool]):

search_criteria_user_personal_phone_list_name (Optional[List[SearchCriteriaUserPersonalPhoneListName]]):

search_criteria_user_personal_phone_list_number (Optional[List[SearchCriteriaUserPersonalPhoneListNumber]]):

search_criteria_user_personal_multi_part_phone_list_name (Optional[List[SearchCriteriaUserPersonalMultiPartPhoneListName]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalPhoneListGetPagedSortedListRequest(OCIRequest):
    """Get a user's personal phone list.
                                The response is either a UserPersonalPhoneListGetPagedSortedListResponse or an
                                ErrorResponse.
                                The search can be done using multiple criterion.
                                If the searchCriteriaModeOr is present, any result matching any one
                                criteria is included in the results.
                                Otherwise, only results matching all the search criterion are included in the
                                results.
                                If no search criteria is specified, all results are returned.
                                Specifying searchCriteriaModeOr without any search criteria results
                                in an ErrorResponse.
                                The sort can done by the personal phone list number or name.
                                The following elements are only used in AS data mode and ignored in XS data
                                mode:
                                searchCriteriaUserPersonalMultiPartPhoneListName

    Attributes:

        user_id (str):

        response_paging_control (ResponsePagingControl):

        sort_by_user_personal_phone_list_number (Optional[SortByUserPersonalPhoneListNumber]):

        sort_by_user_personal_phone_list_name (Optional[SortByUserPersonalPhoneListName]):

        search_criteria_mode_or (Optional[bool]):

        search_criteria_user_personal_phone_list_name (Optional[List[SearchCriteriaUserPersonalPhoneListName]]):

        search_criteria_user_personal_phone_list_number (Optional[List[SearchCriteriaUserPersonalPhoneListNumber]]):

        search_criteria_user_personal_multi_part_phone_list_name (Optional[List[SearchCriteriaUserPersonalMultiPartPhoneListName]]):

    """

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

    response_paging_control: ResponsePagingControl = field(
        metadata={"alias": "responsePagingControl"}
    )

    sort_by_user_personal_phone_list_number: Optional[
        SortByUserPersonalPhoneListNumber
    ] = field(default=None, metadata={"alias": "sortByUserPersonalPhoneListNumber"})

    sort_by_user_personal_phone_list_name: Optional[SortByUserPersonalPhoneListName] = (
        field(default=None, metadata={"alias": "sortByUserPersonalPhoneListName"})
    )

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

    search_criteria_user_personal_phone_list_name: Optional[
        List[SearchCriteriaUserPersonalPhoneListName]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaUserPersonalPhoneListName"}
    )

    search_criteria_user_personal_phone_list_number: Optional[
        List[SearchCriteriaUserPersonalPhoneListNumber]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaUserPersonalPhoneListNumber"}
    )

    search_criteria_user_personal_multi_part_phone_list_name: Optional[
        List[SearchCriteriaUserPersonalMultiPartPhoneListName]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaUserPersonalMultiPartPhoneListName"},
    )

Responses

Bases: OCIDataResponse

Response to the UserPersonalPhoneListGetPagedSortedListRequest. The response contains a user's personal phone list. The response contains a table with column headings: "Name" and "Phone Number".

Attributes:

total_number_of_rows (int):

personal_phone_list_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalPhoneListGetPagedSortedListResponse(OCIDataResponse):
    """Response to the UserPersonalPhoneListGetPagedSortedListRequest.
                                The response contains a user's personal phone list. The response
                                contains a table with column headings: \"Name\" and \"Phone Number\".

    Attributes:

        total_number_of_rows (int):

        personal_phone_list_table (OCITable):

    """

    total_number_of_rows: int = field(metadata={"alias": "totalNumberOfRows"})

    personal_phone_list_table: OCITable = field(
        metadata={"alias": "personalPhoneListTable"}
    )

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

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 UserPersonalPhoneListGetPagedSortedListRequest

client = Client()

command = UserPersonalPhoneListGetPagedSortedListRequest(
    user_id=...,
    response_paging_control=...,
    sort_by_user_personal_phone_list_number=...,
    sort_by_user_personal_phone_list_name=...,
    search_criteria_mode_or=...,
    search_criteria_user_personal_phone_list_name=...,
    search_criteria_user_personal_phone_list_number=...,
    search_criteria_user_personal_multi_part_phone_list_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserPersonalPhoneListGetPagedSortedListRequest",
    user_id=...,
    response_paging_control=...,
    sort_by_user_personal_phone_list_number=...,
    sort_by_user_personal_phone_list_name=...,
    search_criteria_mode_or=...,
    search_criteria_user_personal_phone_list_name=...,
    search_criteria_user_personal_phone_list_number=...,
    search_criteria_user_personal_multi_part_phone_list_name=...,
)

print(response)