Skip to content

GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest

Bases: OCIRequest

Get a list of users with the Collaborate – Audio service assigned that can be assigned to a collaborate bridge. For an Enterprise Group this will include all users in the group’s enterprise. The searchCriteriaGroupId parameter is only applicable for enterprise groups. If no sortOrder is included the response is sorted by Last Name ascending by default.

A limitation to the search by DN activation exists when the Number Activation mode is set to
Off. In this case DNs not assigned to users are never returned by queries with the
"dnActivationSearchCriteria" included.
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 GroupCollaborateBridgeGetAvailableUserPagedSortedListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupCollaborateBridgeGetAvailableUserPagedSortedList]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

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 GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest(OCIRequest):
    """Get a list of users with the Collaborate – Audio service assigned that can be assigned to a collaborate bridge.  For an Enterprise Group this will include all users in the group’s enterprise.
        The searchCriteriaGroupId parameter is only applicable for enterprise groups.
        If no sortOrder is included the response is sorted by Last Name ascending by default.

        A limitation to the search by DN activation exists when the Number Activation mode is set to
        Off. In this case DNs not assigned to users are never returned by queries with the
        \"dnActivationSearchCriteria\" included.
        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 GroupCollaborateBridgeGetAvailableUserPagedSortedListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupCollaborateBridgeGetAvailableUserPagedSortedList]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

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

    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_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

    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 GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Is Phone Number Activated", "Country Code","National Prefix", "Extension", "Department", "Department Type", "Parent Department", "Parent Department Type", "Email Address", "IMP Id", "Mobile Number", "Group Id", "Group Name".

Attributes:

user_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupCollaborateBridgeGetAvailableUserPagedSortedListResponse(OCIDataResponse):
    """Response to the GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest.
        Contains a table with column headings: \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
        \"Phone Number\", \"Is Phone Number Activated\", \"Country Code\",\"National Prefix\", \"Extension\", \"Department\", \"Department Type\",
        \"Parent Department\", \"Parent Department Type\", \"Email Address\", \"IMP Id\", \"Mobile Number\", \"Group Id\", \"Group Name\".

    Attributes:

        user_table (OCITable):

    """

    user_table: OCITable = field(metadata={"alias": "userTable"})

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 GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest

client = Client()

command = GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_department_name=...,
    search_criteria_group_id=...,
    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("GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_department_name=...,
    search_criteria_group_id=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_mode_or=...,
)

print(response)