SystemAccessDeviceGetPagedSortedListRequest
Bases: OCIRequest
Requests the list of system-level access devices. The response is either SystemAccessDeviceGetPagedSortedListResponse 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:
response_paging_control (Optional[ResponsePagingControl]):
sort_by_device_name (Optional[SortByDeviceName]):
sort_by_device_type (Optional[SortByDeviceType]):
sort_by_device_net_address (Optional[SortByDeviceNetAddress]):
sort_by_device_mac_address (Optional[SortByDeviceMACAddress]):
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
72272 72273 72274 72275 72276 72277 72278 72279 72280 72281 72282 72283 72284 72285 72286 72287 72288 72289 72290 72291 72292 72293 72294 72295 72296 72297 72298 72299 72300 72301 72302 72303 72304 72305 72306 72307 72308 72309 72310 72311 72312 72313 72314 72315 72316 72317 72318 72319 72320 72321 72322 72323 72324 72325 72326 72327 72328 72329 72330 72331 72332 72333 72334 72335 72336 72337 72338 72339 72340 72341 72342 72343 72344 72345 72346 72347 72348 72349 72350 72351 72352 72353 72354 72355 72356 72357 72358 72359 72360 72361 72362 | |
Responses
Bases: OCIDataResponse
Response to SystemAccessDeviceGetPagedSortedListRequest. Contains a table of devices configured at system level. 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:
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 SystemAccessDeviceGetPagedSortedListRequest
client = Client()
command = SystemAccessDeviceGetPagedSortedListRequest(
response_paging_control=...,
sort_by_device_name=...,
sort_by_device_type=...,
sort_by_device_net_address=...,
sort_by_device_mac_address=...,
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("SystemAccessDeviceGetPagedSortedListRequest",
response_paging_control=...,
sort_by_device_name=...,
sort_by_device_type=...,
sort_by_device_net_address=...,
sort_by_device_mac_address=...,
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)