UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest

Bases: OCIRequest

Get a list of available users for BroadWorks Receptionist - Enterprise monitoring. The response is either UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse or ErrorResponse. 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):

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]]):

search_criteria_receptionist_note (Optional[List[SearchCriteriaReceptionistNote]]):

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

@dataclass(kw_only=True)
class UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest(OCIRequest):
    """Get a list of available users for BroadWorks Receptionist - Enterprise monitoring.
        The response is either UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse or ErrorResponse.
        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):

        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]]):

        search_criteria_receptionist_note (Optional[List[SearchCriteriaReceptionistNote]]):

    """

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

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

Responses

Bases: OCIDataResponse

Response to the UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest. Returns a 12 column table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id", "Title", "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:

user_table (OCITable):

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

@dataclass(kw_only=True)
class UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse(OCIDataResponse):
    """Response to the UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest.
        Returns a 12 column table with column headings:
          \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
          \"Group Id\", \"Phone Number\", \"Extension\", \"Mobile\", \"Email Address\", \"Department\", \"IMP Id\", \"Title\",
          \"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:

        user_table (OCITable):

    """

    user_table: OCITable = field(metadata={"alias": "userTable"})

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest

client = Client()

command = UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest(
    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=...,
    search_criteria_receptionist_note=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest",
    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=...,
    search_criteria_receptionist_note=...,
)

print(response)