UserPrivacyGetAvailableMonitorsUserListRequest

Bases: OCIRequest

Retrieves a list of users in the enterprise or group available for phone status monitoring the user specified in the userId element. The response is either UserPrivacyGetAvailableMonitorsUserListResponse or ErrorResponse.

Attributes:

user_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_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class UserPrivacyGetAvailableMonitorsUserListRequest(OCIRequest):
    """Retrieves a list of users in the enterprise or group available
        for phone status monitoring the user specified in the userId
        element.  The response is either
        UserPrivacyGetAvailableMonitorsUserListResponse or ErrorResponse.

    Attributes:

        user_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_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):

    """

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

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    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_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

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

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

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

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

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

Responses

Bases: OCIDataResponse

Response to the UserPrivacyGetAvailableMonitorsUserListRequest. Returns a 10 column table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", "IMP Id".

Attributes:

available_monitors_table (OCITable):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class UserPrivacyGetAvailableMonitorsUserListResponse(OCIDataResponse):
    """Response to the UserPrivacyGetAvailableMonitorsUserListRequest.
        Returns a 10 column table with column headings:
        \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\",
        \"Hiragana First Name\", \"Phone Number\", \"Extension\", \"Department\", \"Email Address\", \"IMP Id\".

    Attributes:

        available_monitors_table (OCITable):

    """

    available_monitors_table: OCITable = field(
        metadata={"alias": "availableMonitorsTable"}
    )

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 UserPrivacyGetAvailableMonitorsUserListRequest

client = Client()

command = UserPrivacyGetAvailableMonitorsUserListRequest(
    user_id=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_group=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_imp_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("UserPrivacyGetAvailableMonitorsUserListRequest",
    user_id=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_group=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_imp_id=...,
)

print(response)