Skip to content

GroupCollaborateBridgeGetInstancePagedSortedListRequest

Bases: OCIRequest

Get a list of collaborate bridges within a group. The response is either GroupCollaborateBridgeGetInstancePagedSortedListResponse or ErrorResponse.

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.

If no sortOrder is included the response is sorted by Name ascending by default. .

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

Attributes:

service_provider_id (str):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupCollaborateBridgeGetInstancePagedSortedList]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupCollaborateBridgeGetInstancePagedSortedListRequest(OCIRequest):
    """Get a list of collaborate bridges within a group.
        The response is either GroupCollaborateBridgeGetInstancePagedSortedListResponse or ErrorResponse.

        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.

        If no sortOrder is included the response is sorted by Name ascending by default. .

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

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupCollaborateBridgeGetInstancePagedSortedList]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):

        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[SortOrderGroupCollaborateBridgeGetInstancePagedSortedList]
    ] = field(default=None, metadata={"alias": "sortOrder"})

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

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

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

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

Responses

Bases: OCIDataResponse

Response to the GroupCollaborateBridgeGetInstancePagedSortedListRequest. Contains a table with column headings: "Service User Id", "Name", "Phone Number", "Is Phone Number Activated", "Country Code","National Prefix", "Extension", "Department", "Department Type", "Parent Department", "Parent Department Type", "Participants", "Is Default", "Max Room Participants", "Is Support Outdial". The column values for "Is default", "Is Support Outdial" can either be true, or false.

Attributes:

collaborate_bridge_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupCollaborateBridgeGetInstancePagedSortedListResponse(OCIDataResponse):
    """Response to the GroupCollaborateBridgeGetInstancePagedSortedListRequest.
        Contains a table with column headings: \"Service User Id\", \"Name\", \"Phone Number\", \"Is Phone Number Activated\",
        \"Country Code\",\"National Prefix\", \"Extension\", \"Department\", \"Department Type\",
        \"Parent Department\", \"Parent Department Type\", \"Participants\", \"Is Default\", \"Max Room Participants\",
        \"Is Support Outdial\".
        The column values for \"Is default\", \"Is Support Outdial\" can either be true, or false.

    Attributes:

        collaborate_bridge_table (OCITable):

    """

    collaborate_bridge_table: OCITable = field(
        metadata={"alias": "collaborateBridgeTable"}
    )

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupCollaborateBridgeGetInstancePagedSortedListRequest

client = Client()

command = GroupCollaborateBridgeGetInstancePagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_last_name=...,
    search_criteria_department_name=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupCollaborateBridgeGetInstancePagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_last_name=...,
    search_criteria_department_name=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_mode_or=...,
)

print(response)