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
31714 31715 31716 31717 31718 31719 31720 31721 31722 31723 31724 31725 31726 31727 31728 31729 31730 31731 31732 31733 31734 31735 31736 31737 31738 31739 31740 31741 31742 31743 31744 31745 31746 31747 31748 31749 31750 31751 31752 31753 31754 31755 31756 31757 31758 31759 31760 31761 31762 31763 31764 31765 31766 31767 31768 31769 31770 31771 31772 31773 31774 31775 31776 31777 31778 31779 31780 31781 31782 31783 31784 31785 31786 31787 31788 31789 31790 31791 31792 31793 31794 31795 31796 31797 31798 31799 31800 | |
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
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)