Skip to content

GroupCallParkGetInstancePagedSortedListRequest

Bases: OCIRequest

Request to get a list of Call Park group instances within a 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.

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

Attributes:

service_provider_id (str):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_by_call_park_name (Optional[SortByCallParkName]):

search_criteria_call_park_name (Optional[List[SearchCriteriaCallParkName]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallParkGetInstancePagedSortedListRequest(OCIRequest):
    """Request to get a list of Call Park group instances within a 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.

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

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_by_call_park_name (Optional[SortByCallParkName]):

        search_criteria_call_park_name (Optional[List[SearchCriteriaCallParkName]]):

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

    search_criteria_call_park_name: Optional[List[SearchCriteriaCallParkName]] = field(
        default=None, metadata={"alias": "searchCriteriaCallParkName"}
    )

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

Responses

Bases: OCIDataResponse

Response to the GroupCallParkGetInstancePagedSortedListRequest.

Attributes:

name (Optional[List[str]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallParkGetInstancePagedSortedListResponse(OCIDataResponse):
    """Response to the GroupCallParkGetInstancePagedSortedListRequest.

    Attributes:

        name (Optional[List[str]]):

    """

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

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 GroupCallParkGetInstancePagedSortedListRequest

client = Client()

command = GroupCallParkGetInstancePagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_by_call_park_name=...,
    search_criteria_call_park_name=...,
    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("GroupCallParkGetInstancePagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_by_call_park_name=...,
    search_criteria_call_park_name=...,
    search_criteria_mode_or=...,
)

print(response)