Skip to content

UserCallCenterGetSupervisedAgentListRequest

Bases: OCIRequest

Get a list of agents supervised by a supervisor on a given call center. The response is either a UserCallCenterGetSupervisedAgentListResponse or an ErrorResponse. The search can be done using multiple criterias. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterias 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.

Attributes:

supervisor_user_id (str):

service_user_id (str):

response_size_limit (Optional[int]):

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_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterGetSupervisedAgentListRequest(OCIRequest):
    """Get a list of agents supervised by a supervisor on a given call
        center.
        The response is either a UserCallCenterGetSupervisedAgentListResponse
       or an ErrorResponse.
       The search can be done using multiple criterias.
       If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only
       results matching all the search criterias 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.

    Attributes:

        supervisor_user_id (str):

        service_user_id (str):

        response_size_limit (Optional[int]):

        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_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_imp_id (Optional[List[SearchCriteriaImpId]]):

    """

    supervisor_user_id: str = field(metadata={"alias": "supervisorUserId"})

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

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

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

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

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

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

Responses

Bases: OCIDataResponse

Response to the UserCallCenterGetSupervisedAgentListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", "IMP Id", "Location Code".

Attributes:

agent_user_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterGetSupervisedAgentListResponse(OCIDataResponse):
    """Response to the UserCallCenterGetSupervisedAgentListRequest.
        Contains a table with column headings: \"User Id\", \"Last Name\",
        \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\", \"Phone Number\", \"Extension\",
        \"Department\", \"Email Address\", \"IMP Id\", \"Location Code\".

    Attributes:

        agent_user_table (OCITable):

    """

    agent_user_table: OCITable = field(metadata={"alias": "agentUserTable"})

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 UserCallCenterGetSupervisedAgentListRequest

client = Client()

command = UserCallCenterGetSupervisedAgentListRequest(
    supervisor_user_id=...,
    service_user_id=...,
    response_size_limit=...,
    search_criteria_mode_or=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_user_id=...,
    search_criteria_exact_user_department=...,
    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("UserCallCenterGetSupervisedAgentListRequest",
    supervisor_user_id=...,
    service_user_id=...,
    response_size_limit=...,
    search_criteria_mode_or=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_user_id=...,
    search_criteria_exact_user_department=...,
    search_criteria_imp_id=...,
)

print(response)