Skip to content

GroupCallParkGetInstancePagedSortedRequest

Bases: OCIRequest

Gets a Call Park group.

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.

The sort order is based on the user order provided when creating or modifying the call park instance.

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 GroupCallParkGetInstancePagedSortedResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

name (str):

response_paging_control (Optional[ResponsePagingControl]):

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_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallParkGetInstancePagedSortedRequest(OCIRequest):
    """Gets a Call Park group.

        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.

        The sort order is based on the user order provided when creating or modifying the call park instance.

        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 GroupCallParkGetInstancePagedSortedResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        name (str):

        response_paging_control (Optional[ResponsePagingControl]):

        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_mode_or (Optional[bool]):

    """

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

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

    name: str = field(metadata={"alias": "name"})

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

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

Responses

Bases: OCIDataResponse

Response to the GroupCallParkGetInstancePagedSortedRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". The users are in the table are in the order they will try to be parked on.

Attributes:

recall_alternate_user_id (Optional[str]):

recall_to (str):

user_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallParkGetInstancePagedSortedResponse(OCIDataResponse):
    """Response to the GroupCallParkGetInstancePagedSortedRequest.
        Contains a table with column headings: \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\",
        \"Hiragana First Name\", \"Phone Number\", \"Extension\", \"Department\", \"Email Address\".
        The users are in the table are in the order they will try to be parked on.

    Attributes:

        recall_alternate_user_id (Optional[str]):

        recall_to (str):

        user_table (OCITable):

    """

    recall_alternate_user_id: Optional[str] = field(
        default=None, metadata={"alias": "recallAlternateUserId"}
    )

    recall_to: str = field(metadata={"alias": "recallTo"})

    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 GroupCallParkGetInstancePagedSortedRequest

client = Client()

command = GroupCallParkGetInstancePagedSortedRequest(
    service_provider_id=...,
    group_id=...,
    name=...,
    response_paging_control=...,
    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_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("GroupCallParkGetInstancePagedSortedRequest",
    service_provider_id=...,
    group_id=...,
    name=...,
    response_paging_control=...,
    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_mode_or=...,
)

print(response)