Skip to content

UserPersonalPhoneListGetListRequest

Bases: OCIRequest

Get a user's personal phone list. The response is either a UserPersonalPhoneListGetListResponse 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. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned.

Attributes:

user_id (str):

response_size_limit (Optional[int]):

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]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalPhoneListGetListRequest(OCIRequest):
    """Get a user's personal phone list.
        The response is either a UserPersonalPhoneListGetListResponse 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.
        In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an
        ErrorResponse is returned.

    Attributes:

        user_id (str):

        response_size_limit (Optional[int]):

        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]]):

    """

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

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

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

Responses

Bases: OCIDataResponse

Response to the UserPersonalPhoneListGetListRequest. The response contains a user's personal phone list.

Attributes:

entry (Optional[List[PhoneListEntry]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalPhoneListGetListResponse(OCIDataResponse):
    """Response to the UserPersonalPhoneListGetListRequest.
        The response contains a user's personal phone list.

    Attributes:

        entry (Optional[List[PhoneListEntry]]):

    """

    entry: Optional[List[PhoneListEntry]] = field(
        default=None, metadata={"alias": "entry"}
    )

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

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

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 UserPersonalPhoneListGetListRequest

client = Client()

command = UserPersonalPhoneListGetListRequest(
    user_id=...,
    response_size_limit=...,
    search_criteria_mode_or=...,
    search_criteria_user_personal_phone_list_name=...,
    search_criteria_user_personal_phone_list_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPersonalPhoneListGetListRequest",
    user_id=...,
    response_size_limit=...,
    search_criteria_mode_or=...,
    search_criteria_user_personal_phone_list_name=...,
    search_criteria_user_personal_phone_list_number=...,
)

print(response)