Skip to content

UserCallCenterGetAvailableCallCenterPagedSortedListRequest

Bases: OCIRequest

This request gets a list of all call centers which the user can be assigned to as an agent. Some of the call centers may already have the user as an agent. It is the clients responsibility to discard the call centers that the user is already an agent of.

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.

Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
Then the search criteria are logically ORed together.

The response is either a UserCallCenterGetAvailableCallCenterPagedSortedListResponse or an ErrorResponse.

Attributes:

user_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_by_user_id (Optional[SortByUserId]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterGetAvailableCallCenterPagedSortedListRequest(OCIRequest):
    """This request gets a list of all call centers which the user can be assigned to as an agent.
        Some of the call centers may already have the user as an agent.  It is the clients
        responsibility to discard the call centers that the user is already an agent of.

        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.

        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
        Then the search criteria are logically ORed together.

        The response is either a UserCallCenterGetAvailableCallCenterPagedSortedListResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_by_user_id (Optional[SortByUserId]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

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

    sort_by_user_id: Optional[SortByUserId] = field(
        default=None, metadata={"alias": "sortByUserId"}
    )

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

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

Responses

Bases: OCIDataResponse

Response to the UserCallCenterGetAvailableCallCenterPagedSortedListRequest. Contains a table with column heading: "Service User Id".

Attributes:

call_center_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserCallCenterGetAvailableCallCenterPagedSortedListResponse(OCIDataResponse):
    """Response to the UserCallCenterGetAvailableCallCenterPagedSortedListRequest.
        Contains a table with column heading: \"Service User Id\".

    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

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserCallCenterGetAvailableCallCenterPagedSortedListRequest

client = Client()

command = UserCallCenterGetAvailableCallCenterPagedSortedListRequest(
    user_id=...,
    response_paging_control=...,
    sort_by_user_id=...,
    search_criteria_user_id=...,
    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("UserCallCenterGetAvailableCallCenterPagedSortedListRequest",
    user_id=...,
    response_paging_control=...,
    sort_by_user_id=...,
    search_criteria_user_id=...,
    search_criteria_mode_or=...,
)

print(response)