Skip to content

UserGroupCommonPhoneListGetPagedSortedListRequest

Bases: OCIRequest

Get a user's group's common phone list. The response is either a UserGroupCommonPhoneListGetPagedSortedListResponse 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: searchCriteriaGroupCommonMultiPartPhoneListName

Attributes:

user_id (str):

response_paging_control (ResponsePagingControl):

sort_by_group_common_phone_list_number (Optional[SortByGroupCommonPhoneListNumber]):

sort_by_group_common_phone_list_name (Optional[SortByGroupCommonPhoneListName]):

search_criteria_mode_or (Optional[bool]):

search_criteria_group_common_phone_list_name (Optional[List[SearchCriteriaGroupCommonPhoneListName]]):

search_criteria_group_common_phone_list_number (Optional[List[SearchCriteriaGroupCommonPhoneListNumber]]):

search_criteria_group_common_multi_part_phone_list_name (Optional[List[SearchCriteriaGroupCommonMultiPartPhoneListName]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserGroupCommonPhoneListGetPagedSortedListRequest(OCIRequest):
    """Get a user's group's common phone list.
                                The response is either a UserGroupCommonPhoneListGetPagedSortedListResponse 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:
                                searchCriteriaGroupCommonMultiPartPhoneListName

    Attributes:

        user_id (str):

        response_paging_control (ResponsePagingControl):

        sort_by_group_common_phone_list_number (Optional[SortByGroupCommonPhoneListNumber]):

        sort_by_group_common_phone_list_name (Optional[SortByGroupCommonPhoneListName]):

        search_criteria_mode_or (Optional[bool]):

        search_criteria_group_common_phone_list_name (Optional[List[SearchCriteriaGroupCommonPhoneListName]]):

        search_criteria_group_common_phone_list_number (Optional[List[SearchCriteriaGroupCommonPhoneListNumber]]):

        search_criteria_group_common_multi_part_phone_list_name (Optional[List[SearchCriteriaGroupCommonMultiPartPhoneListName]]):

    """

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

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

    sort_by_group_common_phone_list_number: Optional[
        SortByGroupCommonPhoneListNumber
    ] = field(default=None, metadata={"alias": "sortByGroupCommonPhoneListNumber"})

    sort_by_group_common_phone_list_name: Optional[SortByGroupCommonPhoneListName] = (
        field(default=None, metadata={"alias": "sortByGroupCommonPhoneListName"})
    )

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

    search_criteria_group_common_phone_list_name: Optional[
        List[SearchCriteriaGroupCommonPhoneListName]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaGroupCommonPhoneListName"}
    )

    search_criteria_group_common_phone_list_number: Optional[
        List[SearchCriteriaGroupCommonPhoneListNumber]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaGroupCommonPhoneListNumber"}
    )

    search_criteria_group_common_multi_part_phone_list_name: Optional[
        List[SearchCriteriaGroupCommonMultiPartPhoneListName]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaGroupCommonMultiPartPhoneListName"},
    )

Responses

Bases: OCIDataResponse

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

Attributes:

total_number_of_rows (int):

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

    Attributes:

        total_number_of_rows (int):

        group_common_phone_list_table (OCITable):

    """

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

    group_common_phone_list_table: OCITable = field(
        metadata={"alias": "groupCommonPhoneListTable"}
    )

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 UserGroupCommonPhoneListGetPagedSortedListRequest

client = Client()

command = UserGroupCommonPhoneListGetPagedSortedListRequest(
    user_id=...,
    response_paging_control=...,
    sort_by_group_common_phone_list_number=...,
    sort_by_group_common_phone_list_name=...,
    search_criteria_mode_or=...,
    search_criteria_group_common_phone_list_name=...,
    search_criteria_group_common_phone_list_number=...,
    search_criteria_group_common_multi_part_phone_list_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserGroupCommonPhoneListGetPagedSortedListRequest",
    user_id=...,
    response_paging_control=...,
    sort_by_group_common_phone_list_number=...,
    sort_by_group_common_phone_list_name=...,
    search_criteria_mode_or=...,
    search_criteria_group_common_phone_list_name=...,
    search_criteria_group_common_phone_list_number=...,
    search_criteria_group_common_multi_part_phone_list_name=...,
)

print(response)