Skip to content

GroupCallCenterGetInstancePagedSortedListRequest

Bases: OCIRequest

Get a list of Call Center instances within a group. The response is either GroupCallCenterGetInstancePagedSortedListResponse or ErrorResponse. It is possible to get the instances within a specified department.

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 searchCriteriaExactHuntPolicy or searchCriteriaExactCallCenterType have multiple entries and searchCriteriaModeOr is not include.

Attributes:

service_provider_id (str):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupCallCenterGetInstancePagedSortedList]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_call_center_name (Optional[List[SearchCriteriaCallCenterName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_service_status (Optional[SearchCriteriaServiceStatus]):

search_criteria_exact_hunt_policy (Optional[List[SearchCriteriaExactHuntPolicy]]):

search_criteria_exact_call_center_type (Optional[List[SearchCriteriaExactCallCenterType]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterGetInstancePagedSortedListRequest(OCIRequest):
    """Get a list of Call Center instances within a group.
        The response is either GroupCallCenterGetInstancePagedSortedListResponse or ErrorResponse.
        It is possible to get the instances within a specified department.

        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 searchCriteriaExactHuntPolicy or searchCriteriaExactCallCenterType have multiple entries and searchCriteriaModeOr is not include.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupCallCenterGetInstancePagedSortedList]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_call_center_name (Optional[List[SearchCriteriaCallCenterName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_service_status (Optional[SearchCriteriaServiceStatus]):

        search_criteria_exact_hunt_policy (Optional[List[SearchCriteriaExactHuntPolicy]]):

        search_criteria_exact_call_center_type (Optional[List[SearchCriteriaExactCallCenterType]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

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

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

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

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

    search_criteria_call_center_name: Optional[List[SearchCriteriaCallCenterName]] = (
        field(default=None, metadata={"alias": "searchCriteriaCallCenterName"})
    )

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

    search_criteria_exact_hunt_policy: Optional[List[SearchCriteriaExactHuntPolicy]] = (
        field(default=None, metadata={"alias": "searchCriteriaExactHuntPolicy"})
    )

    search_criteria_exact_call_center_type: Optional[
        List[SearchCriteriaExactCallCenterType]
    ] = field(default=None, metadata={"alias": "searchCriteriaExactCallCenterType"})

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

Responses

Bases: OCIDataResponse

Response to the GroupCallCenterGetInstancePagedSortedListRequest. Contains a table with column headings: "Service User Id", "Name", "Video", "Phone Number", "Extension", "Department", "Is Active", "Policy", "Type". The column values for "Video" and "Is Active" can either be true, or false. The column values for "Type" can be "Basic", "Standard" or "Premium". NOTE: prior to release 14, the policy column did not match the HuntPolicy enumerated type.

Attributes:

call_center_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterGetInstancePagedSortedListResponse(OCIDataResponse):
    """Response to the GroupCallCenterGetInstancePagedSortedListRequest.
        Contains a table with column headings:
        \"Service User Id\", \"Name\", \"Video\", \"Phone Number\", \"Extension\", \"Department\", \"Is Active\", \"Policy\", \"Type\".
        The column values for \"Video\" and \"Is Active\" can either be true, or false.
        The column values for \"Type\" can be \"Basic\", \"Standard\" or \"Premium\".
        NOTE: prior to release 14, the policy column did not match the HuntPolicy enumerated type.

    Attributes:

        call_center_table (OCITable):

    """

    call_center_table: OCITable = field(metadata={"alias": "callCenterTable"})

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

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 GroupCallCenterGetInstancePagedSortedListRequest

client = Client()

command = GroupCallCenterGetInstancePagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_id=...,
    search_criteria_call_center_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_department_name=...,
    search_criteria_service_status=...,
    search_criteria_exact_hunt_policy=...,
    search_criteria_exact_call_center_type=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterGetInstancePagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_id=...,
    search_criteria_call_center_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_department_name=...,
    search_criteria_service_status=...,
    search_criteria_exact_hunt_policy=...,
    search_criteria_exact_call_center_type=...,
    search_criteria_mode_or=...,
)

print(response)