Skip to content

UserGroupCustomContactDirectoryGetPagedSortedListRequest

Bases: OCIRequest

Gets a Custom Contact Directory in a group. The response is either UserGroupCustomContactDirectoryGetPagedSortedListResponse or 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 user last name, first name, department, or contact notes. The Receptionist Note column is only populated, if the user sending the request is a the owner of this Receptionist Note and a Note exists.

Attributes:

user_id (str):

name (str):

response_paging_control (ResponsePagingControl):

sort_by_user_last_name (Optional[SortByUserLastName]):

sort_by_user_first_name (Optional[SortByUserFirstName]):

sort_by_user_department (Optional[SortByUserDepartment]):

sort_by_receptionist_note (Optional[SortByReceptionistNote]):

search_criteria_mode_or (Optional[bool]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_mobile_phone_number (Optional[List[SearchCriteriaMobilePhoneNumber]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):

search_criteria_title (Optional[List[SearchCriteriaTitle]]):

search_criteria_receptionist_note (Optional[List[SearchCriteriaReceptionistNote]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserGroupCustomContactDirectoryGetPagedSortedListRequest(OCIRequest):
    """Gets a Custom Contact Directory in a group.
                                The response is either UserGroupCustomContactDirectoryGetPagedSortedListResponse
                                or 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 user last name, first name, department, or
        contact notes.  The Receptionist Note column is only populated, if the
        user sending the request is a the owner of this Receptionist Note and a Note
        exists.

    Attributes:

        user_id (str):

        name (str):

        response_paging_control (ResponsePagingControl):

        sort_by_user_last_name (Optional[SortByUserLastName]):

        sort_by_user_first_name (Optional[SortByUserFirstName]):

        sort_by_user_department (Optional[SortByUserDepartment]):

        sort_by_receptionist_note (Optional[SortByReceptionistNote]):

        search_criteria_mode_or (Optional[bool]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_mobile_phone_number (Optional[List[SearchCriteriaMobilePhoneNumber]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):

        search_criteria_title (Optional[List[SearchCriteriaTitle]]):

        search_criteria_receptionist_note (Optional[List[SearchCriteriaReceptionistNote]]):

    """

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

    name: str = field(metadata={"alias": "name"})

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

    sort_by_user_last_name: Optional[SortByUserLastName] = field(
        default=None, metadata={"alias": "sortByUserLastName"}
    )

    sort_by_user_first_name: Optional[SortByUserFirstName] = field(
        default=None, metadata={"alias": "sortByUserFirstName"}
    )

    sort_by_user_department: Optional[SortByUserDepartment] = field(
        default=None, metadata={"alias": "sortByUserDepartment"}
    )

    sort_by_receptionist_note: Optional[SortByReceptionistNote] = field(
        default=None, metadata={"alias": "sortByReceptionistNote"}
    )

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

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

    search_criteria_mobile_phone_number: Optional[
        List[SearchCriteriaMobilePhoneNumber]
    ] = field(default=None, metadata={"alias": "searchCriteriaMobilePhoneNumber"})

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

    search_criteria_imp_id: Optional[List[SearchCriteriaImpId]] = field(
        default=None, metadata={"alias": "searchCriteriaImpId"}
    )

    search_criteria_title: Optional[List[SearchCriteriaTitle]] = field(
        default=None, metadata={"alias": "searchCriteriaTitle"}
    )

    search_criteria_receptionist_note: Optional[
        List[SearchCriteriaReceptionistNote]
    ] = field(default=None, metadata={"alias": "searchCriteriaReceptionistNote"})

Responses

Bases: OCIDataResponse

Response to the UserGroupCustomContactDirectoryGetPagedSortedListRequest.

                        Returns the number of entries that would be returned if the response
                        Was not page size restricted.

                        The response contains all the contacts in the group's given custom
                        contact directory. Contains a table with column headings: "User Id",
                        "Last Name", "First Name", "Hiragana Last Name",
                        "Hiragana First Name", "Virtual On-Net Phone Number", "Group Id",
                        "Is Virtual On-Net User", "Department", "Phone Number", "Extension",
                        "Mobile", "Email Address", "Yahoo Id", "Title", "IMP Id", "Receptionist Note".
                        If the entry represents a Virtual On-Net user then "User Id" is blank,
                        the "Virtual On-Net Phone Number" contains the phone Number of the
                        Virtual On-Net user, the "Group Id" contains the Virtual On-Net
                        user's
                        group and the "Is Virtual On-Net User" contains true.
                        If the entry represents a BroadWorks user then the "User Id" contains
                        his BroadWorks userId, the "Virtual On-Net Phone Number" and
                        "Group Id" fields are field is blank and the "Is Virtual On-Net User"
                        contains false.  The Receptionist Note column is only populated, if the
user sending the request is the owner of this Receptionist Note and a
Note exists.

Attributes:

total_number_of_rows (int):

user_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserGroupCustomContactDirectoryGetPagedSortedListResponse(OCIDataResponse):
    """Response to the UserGroupCustomContactDirectoryGetPagedSortedListRequest.

                                Returns the number of entries that would be returned if the response
                                Was not page size restricted.

                                The response contains all the contacts in the group's given custom
                                contact directory. Contains a table with column headings: \"User Id\",
                                \"Last Name\", \"First Name\", \"Hiragana Last Name\",
                                \"Hiragana First Name\", \"Virtual On-Net Phone Number\", \"Group Id\",
                                \"Is Virtual On-Net User\", \"Department\", \"Phone Number\", \"Extension\",
                                \"Mobile\", \"Email Address\", \"Yahoo Id\", \"Title\", \"IMP Id\", \"Receptionist Note\".
                                If the entry represents a Virtual On-Net user then \"User Id\" is blank,
                                the \"Virtual On-Net Phone Number\" contains the phone Number of the
                                Virtual On-Net user, the \"Group Id\" contains the Virtual On-Net
                                user's
                                group and the \"Is Virtual On-Net User\" contains true.
                                If the entry represents a BroadWorks user then the \"User Id\" contains
                                his BroadWorks userId, the \"Virtual On-Net Phone Number\" and
                                \"Group Id\" fields are field is blank and the \"Is Virtual On-Net User\"
                                contains false.  The Receptionist Note column is only populated, if the
        user sending the request is the owner of this Receptionist Note and a
        Note exists.

    Attributes:

        total_number_of_rows (int):

        user_table (OCITable):

    """

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

    user_table: OCITable = field(metadata={"alias": "userTable"})

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 UserGroupCustomContactDirectoryGetPagedSortedListRequest

client = Client()

command = UserGroupCustomContactDirectoryGetPagedSortedListRequest(
    user_id=...,
    name=...,
    response_paging_control=...,
    sort_by_user_last_name=...,
    sort_by_user_first_name=...,
    sort_by_user_department=...,
    sort_by_receptionist_note=...,
    search_criteria_mode_or=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_mobile_phone_number=...,
    search_criteria_user_id=...,
    search_criteria_department_name=...,
    search_criteria_imp_id=...,
    search_criteria_title=...,
    search_criteria_receptionist_note=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserGroupCustomContactDirectoryGetPagedSortedListRequest",
    user_id=...,
    name=...,
    response_paging_control=...,
    sort_by_user_last_name=...,
    sort_by_user_first_name=...,
    sort_by_user_department=...,
    sort_by_receptionist_note=...,
    search_criteria_mode_or=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_mobile_phone_number=...,
    search_criteria_user_id=...,
    search_criteria_department_name=...,
    search_criteria_imp_id=...,
    search_criteria_title=...,
    search_criteria_receptionist_note=...,
)

print(response)