EnterprisePhoneDirectoryGetPagedSortedListRequest
Bases: OCIRequest
Request a table containing the phone directory for an enterprise. The directory includes all users in the enterprise and all entries in the enterprise common phone list.
If the responsePagingControl element is not provided, the paging startIndex will be set to 1
by default, and the responsePageSize will be set to the maximum ResponsePageSize by default.
It is possible to search by various criteria to restrict the number of rows returned.
If no sortOrder is included the response is sorted by User Id ascending with a secondary
sort by User Last Name ascending by default.
Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
Then the search criteria are logically ORed together.
ErrorResponse is returned if searchCriteriaExactUserGroup or searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is not included
The following elements are only used in AS data mode and ignored in XS data mode:
"sortByImpId"
"searchCriteriaImpId"
The response is either EnterprisePhoneDirectoryGetPagedSortedListResponse or ErrorResponse.
Attributes:
enterprise_id (str):
is_extended_info_requested (bool):
response_paging_control (Optional[ResponsePagingControl]):
sort_order (Optional[List[SortOrderEnterprisePhoneDirectoryGetPagedSortedList]]):
search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):
search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):
search_criteria_dn (Optional[List[SearchCriteriaDn]]):
search_criteria_group_location_code (Optional[List[SearchCriteriaGroupLocationCode]]):
search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
search_criteria_mobile_phone_number (Optional[List[SearchCriteriaMobilePhoneNumber]]):
search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):
search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):
search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):
search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):
search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):
search_criteria_yahoo_id (Optional[List[SearchCriteriaYahooId]]):
search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):
search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):
search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
29505 29506 29507 29508 29509 29510 29511 29512 29513 29514 29515 29516 29517 29518 29519 29520 29521 29522 29523 29524 29525 29526 29527 29528 29529 29530 29531 29532 29533 29534 29535 29536 29537 29538 29539 29540 29541 29542 29543 29544 29545 29546 29547 29548 29549 29550 29551 29552 29553 29554 29555 29556 29557 29558 29559 29560 29561 29562 29563 29564 29565 29566 29567 29568 29569 29570 29571 29572 29573 29574 29575 29576 29577 29578 29579 29580 29581 29582 29583 29584 29585 29586 29587 29588 29589 29590 29591 29592 29593 29594 29595 29596 29597 29598 29599 29600 29601 29602 29603 29604 29605 29606 29607 29608 29609 29610 29611 29612 29613 29614 29615 29616 29617 29618 29619 29620 29621 29622 29623 29624 29625 29626 29627 29628 29629 29630 29631 29632 29633 29634 29635 29636 29637 29638 29639 29640 29641 29642 | |
Responses
Bases: OCIDataResponse
Response to EnterprisePhoneDirectoryGetPagedSortedListRequest. Contains a table with a row for each phone number and column headings : "Name", "Number", "Extension", "Mobile", "Email Address", "Department", "Hiragana Name", "Group Id", "Yahoo Id", "User Id", "IMP Id", "Is Virtual On-Net User". If extended directory information is requested, the following columns are also included: "First Name", "Last Name", "Pager", "Title", "Time Zone", "Location", "Address Line 1", "Address Line 2", "City", "State", "Zip", "Country", "Service Name". The Service Name represents the localized service name for service instances. The localized values are taken from the BroadworksLabel.properties file. Service Name is currently supporting: AutoAttendant, AutoAttendantStandard, AutoAttendantVideo, CallCenter, CallCenterStandard, CallCenterPremium HuntGroup, InstantGroupCall, VoiceMessagingGroup, RoutePoint, BroadWorksAnywhere, GroupPaging, FindmeFollowme, VoiceXML, FlexibleSeatingGuest, CollaborateAudio, MeetMeConferencing. For a Regular User or a Virtual On Network Enterprise Extensions, the Service Name is empty.
The following columns are populated in AS data mode only:
"IMP Id"
Attributes:
total_number_of_rows (int):
directory_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
Example Usage
from mercury_ocip.client import Client
from mercury_ocip.commands import EnterprisePhoneDirectoryGetPagedSortedListRequest
client = Client()
command = EnterprisePhoneDirectoryGetPagedSortedListRequest(
enterprise_id=...,
is_extended_info_requested=...,
response_paging_control=...,
sort_order=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_group_location_code=...,
search_criteria_extension=...,
search_criteria_mobile_phone_number=...,
search_criteria_email_address=...,
search_criteria_exact_user_department=...,
search_criteria_department_name=...,
search_criteria_exact_user_group=...,
search_criteria_group_name=...,
search_criteria_yahoo_id=...,
search_criteria_user_id=...,
search_criteria_imp_id=...,
search_criteria_mode_or=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip.client import Client
client = Client()
response = client.raw_command("EnterprisePhoneDirectoryGetPagedSortedListRequest",
enterprise_id=...,
is_extended_info_requested=...,
response_paging_control=...,
sort_order=...,
search_criteria_user_last_name=...,
search_criteria_user_first_name=...,
search_criteria_dn=...,
search_criteria_group_location_code=...,
search_criteria_extension=...,
search_criteria_mobile_phone_number=...,
search_criteria_email_address=...,
search_criteria_exact_user_department=...,
search_criteria_department_name=...,
search_criteria_exact_user_group=...,
search_criteria_group_name=...,
search_criteria_yahoo_id=...,
search_criteria_user_id=...,
search_criteria_imp_id=...,
search_criteria_mode_or=...,
)
print(response)