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
108936 108937 108938 108939 108940 108941 108942 108943 108944 108945 108946 108947 108948 108949 108950 108951 108952 108953 108954 108955 108956 108957 108958 108959 108960 108961 108962 108963 108964 108965 108966 108967 108968 108969 108970 108971 108972 108973 108974 108975 108976 108977 108978 108979 108980 108981 108982 108983 108984 108985 108986 108987 108988 108989 108990 108991 108992 108993 108994 108995 108996 108997 108998 108999 109000 109001 109002 109003 109004 109005 109006 109007 109008 109009 109010 109011 109012 109013 109014 109015 109016 109017 109018 109019 109020 109021 109022 109023 109024 109025 109026 109027 109028 109029 109030 109031 109032 109033 109034 109035 109036 109037 109038 109039 109040 109041 109042 109043 109044 109045 109046 109047 109048 109049 109050 109051 109052 109053 109054 109055 109056 109057 109058 109059 109060 | |
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
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)