GroupUserHotelingGuestSettingsGetListRequest
Bases: OCIRequest
Get a list of users and their Hoteling Guest service status (active or not active). The response is either GroupUserHotelingGuestSettingsGetListResponse or ErrorResponse. By default, virtual users and non-virtual users that match the selected search criteria are included in the response when "includeVirtualUsers" is present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users are returned. The search can be performed using multiple criteria. If search criteria is specified, only the users matching all of the specified search criteria are included in the response. If no search criteria is specified, all results are returned.
Attributes:
service_provider_id (str):
group_id (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_dn (Optional[SortByDn]):
sort_by_extension (Optional[SortByExtension]):
sort_by_service_status (Optional[SortByServiceStatus]):
include_virtual_users (Optional[bool]):
search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):
search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):
search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):
search_criteria_dn (Optional[List[SearchCriteriaDn]]):
search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):
search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):
search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):
Source code in src/mercury_ocip/commands/commands.py
58990 58991 58992 58993 58994 58995 58996 58997 58998 58999 59000 59001 59002 59003 59004 59005 59006 59007 59008 59009 59010 59011 59012 59013 59014 59015 59016 59017 59018 59019 59020 59021 59022 59023 59024 59025 59026 59027 59028 59029 59030 59031 59032 59033 59034 59035 59036 59037 59038 59039 59040 59041 59042 59043 59044 59045 59046 59047 59048 59049 59050 59051 59052 59053 59054 59055 59056 59057 59058 59059 59060 59061 59062 59063 59064 59065 59066 59067 59068 59069 59070 59071 59072 59073 59074 59075 59076 59077 59078 59079 59080 59081 59082 59083 59084 59085 59086 59087 59088 59089 59090 59091 59092 59093 59094 59095 59096 59097 59098 59099 59100 59101 | |
Responses
Bases: OCIDataResponse
Response to the GroupUserHotelingGuestSettingsGetListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name", "Phone Number", "Extension", "Department", "In Trunk Group", "Email Address", "Is Active". "Is Active" is "true" or "false". "Phone Number" is presented in the E164 format.
Attributes:
user_hoteling_guest_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
Example Usage
from mercury_ocip.client import Client
from mercury_ocip.commands import GroupUserHotelingGuestSettingsGetListRequest
client = Client()
command = GroupUserHotelingGuestSettingsGetListRequest(
service_provider_id=...,
group_id=...,
response_paging_control=...,
sort_by_user_last_name=...,
sort_by_user_first_name=...,
sort_by_user_department=...,
sort_by_dn=...,
sort_by_extension=...,
sort_by_service_status=...,
include_virtual_users=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_user_id=...,
search_criteria_dn=...,
search_criteria_extension=...,
search_criteria_email_address=...,
search_criteria_exact_user_department=...,
search_criteria_exact_user_in_trunk_group=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip.client import Client
client = Client()
response = client.raw_command("GroupUserHotelingGuestSettingsGetListRequest",
service_provider_id=...,
group_id=...,
response_paging_control=...,
sort_by_user_last_name=...,
sort_by_user_first_name=...,
sort_by_user_department=...,
sort_by_dn=...,
sort_by_extension=...,
sort_by_service_status=...,
include_virtual_users=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_user_id=...,
search_criteria_dn=...,
search_criteria_extension=...,
search_criteria_email_address=...,
search_criteria_exact_user_department=...,
search_criteria_exact_user_in_trunk_group=...,
)
print(response)