ServiceProviderAccessDeviceGetPagedSortedListRequest
Bases: OCIRequest
Requests the list of service provider level access devices. The response is either ServiceProviderAccessDeviceGetPagedSortedListResponse 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):
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
62575 62576 62577 62578 62579 62580 62581 62582 62583 62584 62585 62586 62587 62588 62589 62590 62591 62592 62593 62594 62595 62596 62597 62598 62599 62600 62601 62602 62603 62604 62605 62606 62607 62608 62609 62610 62611 62612 62613 62614 62615 62616 62617 62618 62619 62620 62621 62622 62623 62624 62625 62626 62627 62628 62629 62630 62631 62632 62633 62634 62635 62636 62637 62638 62639 62640 62641 62642 62643 62644 62645 62646 62647 62648 62649 62650 62651 62652 62653 62654 62655 62656 62657 62658 62659 62660 62661 62662 62663 62664 62665 62666 62667 62668 62669 | |
Responses
Bases: OCIDataResponse
Response to ServiceProviderAccessDeviceGetPagedSortedListRequest. Contains a table of devices configured at service provider 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 ServiceProviderAccessDeviceGetPagedSortedListRequest
client = Client()
command = ServiceProviderAccessDeviceGetPagedSortedListRequest(
service_provider_id=...,
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("ServiceProviderAccessDeviceGetPagedSortedListRequest",
service_provider_id=...,
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)