Skip to content

GroupCallCenterGetAvailableAgentPagedSortedListRequest

Bases: OCIRequest

Get a list of users that can be assigned as agents to a given type of Call Center. Searching for users by group only makes sense when the call center is part of an Enterprise.

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 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 has multiple entries and searchCriteriaModeOr is not included.

The response is either GroupCallCenterGetAvailableAgentPagedSortedListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

call_center_type (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupCallCenterGetAvailableAgentPagedSortedList]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

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_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

search_criteria_exact_user_group (Optional[List[SearchCriteriaExactUserGroup]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterGetAvailableAgentPagedSortedListRequest(OCIRequest):
    """Get a list of users that can be assigned as agents to a given type of Call Center.
        Searching for users by group only makes sense when the call center is part of an Enterprise.

        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 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 has multiple entries and searchCriteriaModeOr is not included.

        The response is either GroupCallCenterGetAvailableAgentPagedSortedListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        call_center_type (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupCallCenterGetAvailableAgentPagedSortedList]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        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_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

        search_criteria_exact_user_group (Optional[List[SearchCriteriaExactUserGroup]]):

        search_criteria_mode_or (Optional[bool]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    call_center_type: str = field(metadata={"alias": "callCenterType"})

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

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

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

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

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

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

    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 the GroupCallCenterGetAvailableAgentPagedSortedListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".

Attributes:

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

    Attributes:

        user_table (OCITable):

    """

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

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 GroupCallCenterGetAvailableAgentPagedSortedListRequest

client = Client()

command = GroupCallCenterGetAvailableAgentPagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    call_center_type=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_department_name=...,
    search_criteria_email_address=...,
    search_criteria_exact_user_group=...,
    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("GroupCallCenterGetAvailableAgentPagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    call_center_type=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_department_name=...,
    search_criteria_email_address=...,
    search_criteria_exact_user_group=...,
    search_criteria_mode_or=...,
)

print(response)