UserGetListInGroupRequest
Bases: OCIRequest
Request the list of users in a group. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The response is either a UserGetListInGroupResponse or an ErrorResponse.
Attributes:
service_provider_id (str):
group_id (str):
response_size_limit (Optional[int]):
search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):
search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):
search_criteria_dn (Optional[List[SearchCriteriaDn]]):
search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):
search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):
search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):
search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):
search_criteria_user_external_id (Optional[List[SearchCriteriaUserExternalId]]):
search_criteria_exact_user_person_id (Optional[SearchCriteriaExactUserPersonId]):
search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
Source code in src/mercury_ocip_fast/commands/commands.py
108371 108372 108373 108374 108375 108376 108377 108378 108379 108380 108381 108382 108383 108384 108385 108386 108387 108388 108389 108390 108391 108392 108393 108394 108395 108396 108397 108398 108399 108400 108401 108402 108403 108404 108405 108406 108407 108408 108409 108410 108411 108412 108413 108414 108415 108416 108417 108418 108419 108420 108421 108422 108423 108424 108425 108426 108427 108428 108429 108430 108431 108432 108433 108434 108435 108436 108437 108438 108439 108440 108441 108442 108443 108444 108445 108446 108447 108448 108449 108450 108451 108452 108453 108454 | |
Responses
Bases: OCIDataResponse
Response to UserGetListInGroupRequest. Contains a table with column headings : "User Id", "Last Name", "First Name", "Department", "Phone Number", "Phone Number Activated", "Email Address", "Hiragana Last Name", "Hiragana First Name", "In Trunk Group", "Extension", "Country Code", "National Prefix" in a row for each user.
The following columns are only returned in AS data mode:
"Country Code", "National Prefix
Attributes:
user_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
Example Usage
from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserGetListInGroupRequest
client = Client()
command = UserGetListInGroupRequest(
service_provider_id=...,
group_id=...,
response_size_limit=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_email_address=...,
search_criteria_exact_user_department=...,
search_criteria_exact_user_in_trunk_group=...,
search_criteria_user_id=...,
search_criteria_user_external_id=...,
search_criteria_exact_user_person_id=...,
search_criteria_extension=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip_fast.client import Client
client = Client()
response = client.raw_command("UserGetListInGroupRequest",
service_provider_id=...,
group_id=...,
response_size_limit=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_email_address=...,
search_criteria_exact_user_department=...,
search_criteria_exact_user_in_trunk_group=...,
search_criteria_user_id=...,
search_criteria_user_external_id=...,
search_criteria_exact_user_person_id=...,
search_criteria_extension=...,
)
print(response)