UserGetListInSystemRequest
Bases: OCIRequest
Request the list of users in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the users in the administrator's reseller meeting the search criteria are returned.
The response is either a UserGetListInSystemResponse or an ErrorResponse.
The following data elements are only used in AS data mode:
searchCriteriaResellerId
Attributes:
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_group_id (Optional[List[SearchCriteriaGroupId]]):
search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):
search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):
search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):
search_criteria_exact_user_network_class_of_service (Optional[SearchCriteriaExactUserNetworkClassOfService]):
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]]):
search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):
Source code in src/mercury_ocip_fast/commands/commands.py
108551 108552 108553 108554 108555 108556 108557 108558 108559 108560 108561 108562 108563 108564 108565 108566 108567 108568 108569 108570 108571 108572 108573 108574 108575 108576 108577 108578 108579 108580 108581 108582 108583 108584 108585 108586 108587 108588 108589 108590 108591 108592 108593 108594 108595 108596 108597 108598 108599 108600 108601 108602 108603 108604 108605 108606 108607 108608 108609 108610 108611 108612 108613 108614 108615 108616 108617 108618 108619 108620 108621 108622 108623 108624 108625 108626 108627 108628 108629 108630 108631 108632 108633 108634 108635 108636 108637 108638 108639 108640 108641 108642 108643 108644 108645 108646 108647 108648 108649 108650 108651 108652 108653 108654 108655 108656 108657 108658 | |
Responses
Bases: OCIDataResponse
Response to UserGetListInSystemRequest. Contains a table with column headings : "User Id", "Group Id", "Service Provider Id", "Last Name", "First Name", "Department", "Phone Number", "Phone Number Activated", "Email Address", "Hiragana Last Name", "Hiragana First Name", "In Trunk Group", "Extension", "Reseller Id", "User External Id" in a row for each user.
The following columns are only returned in AS data mode:
"Reseller Id"
"User External Id"
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 UserGetListInSystemRequest
client = Client()
command = UserGetListInSystemRequest(
response_size_limit=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_email_address=...,
search_criteria_group_id=...,
search_criteria_exact_service_provider=...,
search_criteria_service_provider_id=...,
search_criteria_exact_user_in_trunk_group=...,
search_criteria_exact_user_network_class_of_service=...,
search_criteria_user_id=...,
search_criteria_user_external_id=...,
search_criteria_exact_user_person_id=...,
search_criteria_extension=...,
search_criteria_reseller_id=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip_fast.client import Client
client = Client()
response = client.raw_command("UserGetListInSystemRequest",
response_size_limit=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_email_address=...,
search_criteria_group_id=...,
search_criteria_exact_service_provider=...,
search_criteria_service_provider_id=...,
search_criteria_exact_user_in_trunk_group=...,
search_criteria_exact_user_network_class_of_service=...,
search_criteria_user_id=...,
search_criteria_user_external_id=...,
search_criteria_exact_user_person_id=...,
search_criteria_extension=...,
search_criteria_reseller_id=...,
)
print(response)