Skip to content

UserEnterpriseCommonPhoneListGetPagedSortedListRequest

Bases: OCIRequest

Get an enterprise's common phone list for a user. The response is either a UserEnterpriseCommonPhoneListGetPagedSortedListResponse 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 be done on the name or the number in the common phone list. The following elements are only used in AS data mode and ignored in XS data mode: searchCriteriaEnterpriseCommonMultiPartPhoneListName

Attributes:

user_id (str):

response_paging_control (ResponsePagingControl):

sort_by_enterprise_common_phone_list_number (Optional[SortByEnterpriseCommonPhoneListNumber]):

sort_by_enterprise_common_phone_list_name (Optional[SortByEnterpriseCommonPhoneListName]):

search_criteria_mode_or (Optional[bool]):

search_criteria_enterprise_common_phone_list_name (Optional[List[SearchCriteriaEnterpriseCommonPhoneListName]]):

search_criteria_enterprise_common_phone_list_number (Optional[List[SearchCriteriaEnterpriseCommonPhoneListNumber]]):

search_criteria_enterprise_common_multi_part_phone_list_name (Optional[List[SearchCriteriaEnterpriseCommonMultiPartPhoneListName]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserEnterpriseCommonPhoneListGetPagedSortedListRequest(OCIRequest):
    """Get an enterprise's common phone list for a user.
                                The response is either a UserEnterpriseCommonPhoneListGetPagedSortedListResponse
                                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 be done on the name or the number in the common phone list.
                                The following elements are only used in AS data mode and ignored in XS data
                                mode:
                                        searchCriteriaEnterpriseCommonMultiPartPhoneListName

    Attributes:

        user_id (str):

        response_paging_control (ResponsePagingControl):

        sort_by_enterprise_common_phone_list_number (Optional[SortByEnterpriseCommonPhoneListNumber]):

        sort_by_enterprise_common_phone_list_name (Optional[SortByEnterpriseCommonPhoneListName]):

        search_criteria_mode_or (Optional[bool]):

        search_criteria_enterprise_common_phone_list_name (Optional[List[SearchCriteriaEnterpriseCommonPhoneListName]]):

        search_criteria_enterprise_common_phone_list_number (Optional[List[SearchCriteriaEnterpriseCommonPhoneListNumber]]):

        search_criteria_enterprise_common_multi_part_phone_list_name (Optional[List[SearchCriteriaEnterpriseCommonMultiPartPhoneListName]]):

    """

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

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

    sort_by_enterprise_common_phone_list_number: Optional[
        SortByEnterpriseCommonPhoneListNumber
    ] = field(default=None, metadata={"alias": "sortByEnterpriseCommonPhoneListNumber"})

    sort_by_enterprise_common_phone_list_name: Optional[
        SortByEnterpriseCommonPhoneListName
    ] = field(default=None, metadata={"alias": "sortByEnterpriseCommonPhoneListName"})

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

    search_criteria_enterprise_common_phone_list_name: Optional[
        List[SearchCriteriaEnterpriseCommonPhoneListName]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaEnterpriseCommonPhoneListName"}
    )

    search_criteria_enterprise_common_phone_list_number: Optional[
        List[SearchCriteriaEnterpriseCommonPhoneListNumber]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaEnterpriseCommonPhoneListNumber"},
    )

    search_criteria_enterprise_common_multi_part_phone_list_name: Optional[
        List[SearchCriteriaEnterpriseCommonMultiPartPhoneListName]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaEnterpriseCommonMultiPartPhoneListName"},
    )

Responses

Bases: OCIDataResponse

Response to the UserEnterpriseCommonPhoneListGetPagedSortedListRequest. The response contains the enterprise's common phone list. The response contains a table with column headings: "Name" and "Phone Number".

Attributes:

total_number_of_rows (int):

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

    Attributes:

        total_number_of_rows (int):

        enterprise_common_phone_list_table (OCITable):

    """

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

    enterprise_common_phone_list_table: OCITable = field(
        metadata={"alias": "enterpriseCommonPhoneListTable"}
    )

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 UserEnterpriseCommonPhoneListGetPagedSortedListRequest

client = Client()

command = UserEnterpriseCommonPhoneListGetPagedSortedListRequest(
    user_id=...,
    response_paging_control=...,
    sort_by_enterprise_common_phone_list_number=...,
    sort_by_enterprise_common_phone_list_name=...,
    search_criteria_mode_or=...,
    search_criteria_enterprise_common_phone_list_name=...,
    search_criteria_enterprise_common_phone_list_number=...,
    search_criteria_enterprise_common_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("UserEnterpriseCommonPhoneListGetPagedSortedListRequest",
    user_id=...,
    response_paging_control=...,
    sort_by_enterprise_common_phone_list_number=...,
    sort_by_enterprise_common_phone_list_name=...,
    search_criteria_mode_or=...,
    search_criteria_enterprise_common_phone_list_name=...,
    search_criteria_enterprise_common_phone_list_number=...,
    search_criteria_enterprise_common_multi_part_phone_list_name=...,
)

print(response)