GroupCustomContactDirectoryGetRequest17
Bases: OCIRequest
Gets a Custom Contact Directory in a group. The response is either GroupCustomContactDirectoryGetResponse17 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. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned. The Receptionist Note column is only populated in AS mode; and populated only if the user sending the request is a the owner of this Receptionist Note and a Note exists.
Attributes:
service_provider_id (str):
group_id (str):
name (str):
response_size_limit (Optional[int]):
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_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):
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
43948 43949 43950 43951 43952 43953 43954 43955 43956 43957 43958 43959 43960 43961 43962 43963 43964 43965 43966 43967 43968 43969 43970 43971 43972 43973 43974 43975 43976 43977 43978 43979 43980 43981 43982 43983 43984 43985 43986 43987 43988 43989 43990 43991 43992 43993 43994 43995 43996 43997 43998 43999 44000 44001 44002 44003 44004 44005 44006 44007 44008 44009 44010 44011 44012 44013 44014 44015 44016 44017 44018 44019 44020 44021 44022 44023 44024 44025 44026 44027 44028 44029 44030 44031 44032 44033 44034 44035 44036 44037 44038 44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 | |
Responses
Bases: OCIDataResponse
Response to the GroupCustomContactDirectoryGetRequest17. 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 in AS Mode, if the user sending the request is the owner of the Receptionist Note and a Note exists.
Attributes:
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 GroupCustomContactDirectoryGetRequest17
client = Client()
command = GroupCustomContactDirectoryGetRequest17(
service_provider_id=...,
group_id=...,
name=...,
response_size_limit=...,
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_exact_user_department=...,
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("GroupCustomContactDirectoryGetRequest17",
service_provider_id=...,
group_id=...,
name=...,
response_size_limit=...,
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_exact_user_department=...,
search_criteria_imp_id=...,
search_criteria_title=...,
search_criteria_receptionist_note=...,
)
print(response)