Skip to content

GroupAccessDeviceGetPagedSortedListRequest22

Bases: OCIRequest

Requests the list of access devices in a group. The response is either GroupAccessDeviceGetPagedSortedListResponse or ErrorResponse. If no sortOrder is included, the response is sorted by Device Name ascending by default. 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. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly element is not set, all devices are returned with Visual Device Management API flag set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, only SIP devices supporting Visual Device Management API are returned. If the getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are returned with their current Visual Device Management API flag value.

Attributes:

service_provider_id (str):

group_id (str):

include_total_number_of_rows (Optional[bool]):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupAccessDeviceGetPagedSortedList]]):

search_criteria_device_name (Optional[List[SearchCriteriaDeviceName]]):

search_criteria_device_mac_address (Optional[List[SearchCriteriaDeviceMACAddress]]):

search_criteria_device_net_address (Optional[List[SearchCriteriaDeviceNetAddress]]):

search_criteria_exact_device_type (Optional[List[SearchCriteriaExactDeviceType]]):

search_criteria_access_device_version (Optional[List[SearchCriteriaAccessDeviceVersion]]):

search_criteria_mode_or (Optional[bool]):

get_visual_device_management_api_devices_only (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAccessDeviceGetPagedSortedListRequest22(OCIRequest):
    """Requests the list of access devices in a group.
        The response is either GroupAccessDeviceGetPagedSortedListResponse or ErrorResponse.
        If no sortOrder is included, the response is sorted by Device Name ascending
        by default.  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.
        Multiple search criteria are logically ANDed together unless the
        searchCriteriaModeOr option is included. Then the search criteria are logically
        ORed together.
        The getVisualDeviceManagementAPIDevicesOnly element can only be set when CloudPBX is licenced.
        If the getVisualDeviceManagementAPIDevicesOnly element is not set, all devices are returned with Visual Device Management API flag set to empty.
        If the getVisualDeviceManagementAPIDevicesOnly element is set to true, only SIP devices supporting Visual Device Management API are returned.
        If the getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are returned with their current Visual Device Management API flag value.

    Attributes:

        service_provider_id (str):

        group_id (str):

        include_total_number_of_rows (Optional[bool]):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupAccessDeviceGetPagedSortedList]]):

        search_criteria_device_name (Optional[List[SearchCriteriaDeviceName]]):

        search_criteria_device_mac_address (Optional[List[SearchCriteriaDeviceMACAddress]]):

        search_criteria_device_net_address (Optional[List[SearchCriteriaDeviceNetAddress]]):

        search_criteria_exact_device_type (Optional[List[SearchCriteriaExactDeviceType]]):

        search_criteria_access_device_version (Optional[List[SearchCriteriaAccessDeviceVersion]]):

        search_criteria_mode_or (Optional[bool]):

        get_visual_device_management_api_devices_only (Optional[bool]):

    """

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

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

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

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

    sort_order: Optional[List[SortOrderGroupAccessDeviceGetPagedSortedList]] = field(
        default=None, metadata={"alias": "sortOrder"}
    )

    search_criteria_device_name: Optional[List[SearchCriteriaDeviceName]] = field(
        default=None, metadata={"alias": "searchCriteriaDeviceName"}
    )

    search_criteria_device_mac_address: Optional[
        List[SearchCriteriaDeviceMACAddress]
    ] = field(default=None, metadata={"alias": "searchCriteriaDeviceMACAddress"})

    search_criteria_device_net_address: Optional[
        List[SearchCriteriaDeviceNetAddress]
    ] = field(default=None, metadata={"alias": "searchCriteriaDeviceNetAddress"})

    search_criteria_exact_device_type: Optional[List[SearchCriteriaExactDeviceType]] = (
        field(default=None, metadata={"alias": "searchCriteriaExactDeviceType"})
    )

    search_criteria_access_device_version: Optional[
        List[SearchCriteriaAccessDeviceVersion]
    ] = field(default=None, metadata={"alias": "searchCriteriaAccessDeviceVersion"})

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

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

Responses

Bases: OCIDataResponse

Response to GroupAccessDeviceGetPagedSortedListRequest22. Contains a table of devices configured in the group. The column headings are: "Device Name", "Device Type", "Available Ports", "Net Address", "MAC Address", "Status", "Version", and "Support Visual Device Management API". When CloudPBX is not licensed, the column "Support Visual Device Management API" values are not returned.

Attributes:

total_number_of_rows (Optional[int]):

access_device_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAccessDeviceGetPagedSortedListResponse22(OCIDataResponse):
    """Response to GroupAccessDeviceGetPagedSortedListRequest22.
        Contains a table of devices configured in the group.
        The column headings are: \"Device Name\", \"Device Type\", \"Available Ports\", \"Net Address\", \"MAC Address\", \"Status\", \"Version\", and \"Support Visual Device Management API\".
        When CloudPBX is not licensed, the column \"Support Visual Device Management API\" values are not returned.

    Attributes:

        total_number_of_rows (Optional[int]):

        access_device_table (OCITable):

    """

    total_number_of_rows: Optional[int] = field(
        default=None, metadata={"alias": "totalNumberOfRows"}
    )

    access_device_table: OCITable = field(metadata={"alias": "accessDeviceTable"})

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 GroupAccessDeviceGetPagedSortedListRequest22

client = Client()

command = GroupAccessDeviceGetPagedSortedListRequest22(
    service_provider_id=...,
    group_id=...,
    include_total_number_of_rows=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_device_name=...,
    search_criteria_device_mac_address=...,
    search_criteria_device_net_address=...,
    search_criteria_exact_device_type=...,
    search_criteria_access_device_version=...,
    search_criteria_mode_or=...,
    get_visual_device_management_api_devices_only=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceGetPagedSortedListRequest22",
    service_provider_id=...,
    group_id=...,
    include_total_number_of_rows=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_device_name=...,
    search_criteria_device_mac_address=...,
    search_criteria_device_net_address=...,
    search_criteria_exact_device_type=...,
    search_criteria_access_device_version=...,
    search_criteria_mode_or=...,
    get_visual_device_management_api_devices_only=...,
)

print(response)