Skip to content

GroupCallPickupGetInstancePagedSortedListRequest

Bases: OCIRequest

Request to get a list of Call Pickup 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 GroupCallPickupGetInstancePagedSortedListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_by_call_pickup_name (Optional[SortByCallPickupName]):

search_criteria_call_pickup_name (Optional[List[SearchCriteriaCallPickupName]]):

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

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_by_call_pickup_name (Optional[SortByCallPickupName]):

        search_criteria_call_pickup_name (Optional[List[SearchCriteriaCallPickupName]]):

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

    search_criteria_call_pickup_name: Optional[List[SearchCriteriaCallPickupName]] = (
        field(default=None, metadata={"alias": "searchCriteriaCallPickupName"})
    )

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

Responses

Bases: OCIDataResponse

Response to the GroupCallPickupGetInstancePagedSortedListRequest.

Attributes:

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

    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 GroupCallPickupGetInstancePagedSortedListRequest

client = Client()

command = GroupCallPickupGetInstancePagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_by_call_pickup_name=...,
    search_criteria_call_pickup_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("GroupCallPickupGetInstancePagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_by_call_pickup_name=...,
    search_criteria_call_pickup_name=...,
    search_criteria_mode_or=...,
)

print(response)