Skip to content

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_fast/commands/commands.py
@dataclass(kw_only=True)
class EnterprisePhoneDirectoryGetPagedSortedListRequest(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]):

    """

    enterprise_id: str = field(metadata={"alias": "enterpriseId"})

    is_extended_info_requested: bool = field(
        metadata={"alias": "isExtendedInfoRequested"}
    )

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_order: Optional[List[SortOrderEnterprisePhoneDirectoryGetPagedSortedList]] = (
        field(default=None, metadata={"alias": "sortOrder"})
    )

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_group_location_code: Optional[
        List[SearchCriteriaGroupLocationCode]
    ] = field(default=None, metadata={"alias": "searchCriteriaGroupLocationCode"})

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

    search_criteria_mobile_phone_number: Optional[
        List[SearchCriteriaMobilePhoneNumber]
    ] = field(default=None, metadata={"alias": "searchCriteriaMobilePhoneNumber"})

    search_criteria_email_address: Optional[List[SearchCriteriaEmailAddress]] = field(
        default=None, metadata={"alias": "searchCriteriaEmailAddress"}
    )

    search_criteria_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

    search_criteria_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

    search_criteria_exact_user_group: Optional[SearchCriteriaExactUserGroup] = field(
        default=None, metadata={"alias": "searchCriteriaExactUserGroup"}
    )

    search_criteria_group_name: Optional[List[SearchCriteriaGroupName]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupName"}
    )

    search_criteria_yahoo_id: Optional[List[SearchCriteriaYahooId]] = field(
        default=None, metadata={"alias": "searchCriteriaYahooId"}
    )

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_imp_id: Optional[List[SearchCriteriaImpId]] = field(
        default=None, metadata={"alias": "searchCriteriaImpId"}
    )

    search_criteria_mode_or: Optional[bool] = field(
        default=None, metadata={"alias": "searchCriteriaModeOr"}
    )

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

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_fast/commands/commands.py
@dataclass(kw_only=True)
class EnterprisePhoneDirectoryGetPagedSortedListResponse(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):

    """

    total_number_of_rows: int = field(metadata={"alias": "totalNumberOfRows"})

    directory_table: OCITable = field(metadata={"alias": "directoryTable"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.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_fast.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)