Skip to content

UserPhoneDirectoryGetPagedListRequest

Bases: OCIRequest

Request a table containing the phone directory for a user. Setting isEnterpriseRequested to true will return enterprise directory members in the response if the user is in an enterprise. Otherwise, just the group directory members for a user are returned in the response. The response is either UserPhoneDirectoryGetPagedListResponse or ErrorResponse. The search can be done using multiple criteria. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criteria are included in the results. If no search criteria is specified, all results are returned. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. The boolean sortByFirstName is optional. If it is not specified, the response is sorted by Last Name. The Receptionist Note column is only populated, if the user sending the request is the owner of the Receptionist Note and a Note exists.

Attributes:

user_id (str):

is_enterprise_info_requested (bool):

response_paging_control (ResponsePagingControl):

search_criteria_mode_or (Optional[bool]):

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_yahoo_id (Optional[List[SearchCriteriaYahooId]]):

search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):

sort_by_first_name (Optional[bool]):

search_criteria_title (Optional[List[SearchCriteriaTitle]]):

search_criteria_receptionist_note (Optional[List[SearchCriteriaReceptionistNote]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserPhoneDirectoryGetPagedListRequest(OCIRequest):
    """Request a table containing the phone directory for a user.
        Setting isEnterpriseRequested to true will return enterprise directory
        members in the response if the user is in an enterprise. Otherwise,
        just the group directory members for a user are returned in the response.
        The response is either UserPhoneDirectoryGetPagedListResponse or
        ErrorResponse.
        The search can be done using multiple criteria.
        If the searchCriteriaModeOr is present, any result matching any one criteria is included in
        the results. Otherwise, only results matching all the search criteria are included in the results.
        If no search criteria is specified, all results are returned.
        In all cases, if a responseSizeLimit is specified and the number of matching results is more than
        this limit, then an ErrorResponse is returned.
        Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse.
        The boolean sortByFirstName is optional. If it is not specified, the response is
        sorted by Last Name.  The Receptionist Note column is only populated, if the user sending
        the request is the owner of the Receptionist Note and a Note exists.

    Attributes:

        user_id (str):

        is_enterprise_info_requested (bool):

        response_paging_control (ResponsePagingControl):

        search_criteria_mode_or (Optional[bool]):

        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_yahoo_id (Optional[List[SearchCriteriaYahooId]]):

        search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):

        sort_by_first_name (Optional[bool]):

        search_criteria_title (Optional[List[SearchCriteriaTitle]]):

        search_criteria_receptionist_note (Optional[List[SearchCriteriaReceptionistNote]]):

    """

    user_id: str = field(metadata={"alias": "userId"})

    is_enterprise_info_requested: bool = field(
        metadata={"alias": "isEnterpriseInfoRequested"}
    )

    response_paging_control: ResponsePagingControl = field(
        metadata={"alias": "responsePagingControl"}
    )

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

    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_yahoo_id: Optional[List[SearchCriteriaYahooId]] = field(
        default=None, metadata={"alias": "searchCriteriaYahooId"}
    )

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

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

    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"}
    )

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

    search_criteria_title: Optional[List[SearchCriteriaTitle]] = field(
        default=None, metadata={"alias": "searchCriteriaTitle"}
    )

    search_criteria_receptionist_note: Optional[
        List[SearchCriteriaReceptionistNote]
    ] = field(default=None, metadata={"alias": "searchCriteriaReceptionistNote"})

Responses

Bases: OCIDataResponse

Response to UserPhoneDirectoryGetPagedListRequest. Returns the number of entries that would be returned if the response Was not page size restricted. The "My Room Room Id" and "My Room Bridge Id" are only populated for users assigned the "Collaborate-Audio" service. Contains a table with a row for each user and column headings: "User Id", "First Name", "Last Name", "First Name Unicode", "Last Name Unicode", "Hiragana First Name", "Hiragana Last Name", "Title", "Phone Number", "Extension", "Mobile", "Pager", "Email Address", "Yahoo Id", "Department", "Group Id", "Location", "Address Line 1", "Address Line 2", "City", "State", "Zip", "Country", "IMP Id", "Location Code", "My Room Room Id", "My Room Bridge Id", "Service Name", and "Receptionist Note". 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 response entries are sorted by "Last Name Unicode" first and "First Name unicode" secondarily.

The following columns are only returned in AS data mode:
"Location Code", "My Room Room Id", "My Room Bridge Id", "Service Name", "Receptionist Note"
The Receptionist Note column is only populated, if the user sending
the request is the owner of the Receptionist Note and a Note exists.

Attributes:

total_number_of_rows (int):

directory_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserPhoneDirectoryGetPagedListResponse(OCIDataResponse):
    """Response to UserPhoneDirectoryGetPagedListRequest.
        Returns the number of entries that would be returned if the response
        Was not page size restricted.
        The \"My Room Room Id\" and \"My Room Bridge Id\" are only populated for
              users assigned the \"Collaborate-Audio\" service.
        Contains a table with a row for each user and column headings:
        \"User Id\", \"First Name\", \"Last Name\", \"First Name Unicode\",
        \"Last Name Unicode\", \"Hiragana First Name\", \"Hiragana Last Name\",
        \"Title\", \"Phone Number\", \"Extension\", \"Mobile\", \"Pager\",
        \"Email Address\", \"Yahoo Id\", \"Department\", \"Group Id\", \"Location\",
        \"Address Line 1\", \"Address Line 2\", \"City\", \"State\", \"Zip\", \"Country\",
        \"IMP Id\", \"Location Code\", \"My Room Room Id\", \"My Room Bridge Id\", \"Service Name\",
        and \"Receptionist Note\".
        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 response entries are sorted by \"Last Name Unicode\" first and
        \"First Name unicode\" secondarily.

        The following columns are only returned in AS data mode:
        \"Location Code\", \"My Room Room Id\", \"My Room Bridge Id\", \"Service Name\", \"Receptionist Note\"
        The Receptionist Note column is only populated, if the user sending
        the request is the owner of the Receptionist Note and a Note exists.

    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

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: 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 UserPhoneDirectoryGetPagedListRequest

client = Client()

command = UserPhoneDirectoryGetPagedListRequest(
    user_id=...,
    is_enterprise_info_requested=...,
    response_paging_control=...,
    search_criteria_mode_or=...,
    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_yahoo_id=...,
    search_criteria_exact_user_group=...,
    search_criteria_exact_user_department=...,
    search_criteria_user_id=...,
    search_criteria_imp_id=...,
    sort_by_first_name=...,
    search_criteria_title=...,
    search_criteria_receptionist_note=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserPhoneDirectoryGetPagedListRequest",
    user_id=...,
    is_enterprise_info_requested=...,
    response_paging_control=...,
    search_criteria_mode_or=...,
    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_yahoo_id=...,
    search_criteria_exact_user_group=...,
    search_criteria_exact_user_department=...,
    search_criteria_user_id=...,
    search_criteria_imp_id=...,
    sort_by_first_name=...,
    search_criteria_title=...,
    search_criteria_receptionist_note=...,
)

print(response)