SystemSIPDeviceTypeGetListRequest
Bases: OCIRequest
Request to get the list of sip device types in the system. If includeSystemLevel is specified, all system level device types and the reseller device types matching search criteria are returned even when searchCriteriaResellerId is specified. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All system level device types and the device types in the administrator's reseller meeting the search criteria are returned. See Also: SystemDeviceTypeGetAvailableListRequest22 in AS data mode, SystemDeviceTypeGetAvailableListRequest19 in XS data mode. The response is either SystemSIPDeviceTypeGetListResponse or ErrorResponse.
The following data elements are only used in AS data mode and ignored in XS data mode:
searchCriteriaExactDeviceTypeConfigurationOptionType
Attributes:
response_size_limit (Optional[int]):
search_criteria_device_type (Optional[List[SearchCriteriaDeviceType]]):
search_criteria_exact_signaling_address_type (Optional[SearchCriteriaExactSignalingAddressType]):
search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):
search_criteria_device_configuration_options (Optional[List[SearchCriteriaExactDeviceTypeConfigurationOptionType]]):
include_system_level (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
94581 94582 94583 94584 94585 94586 94587 94588 94589 94590 94591 94592 94593 94594 94595 94596 94597 94598 94599 94600 94601 94602 94603 94604 94605 94606 94607 94608 94609 94610 94611 94612 94613 94614 94615 94616 94617 94618 94619 94620 94621 94622 94623 94624 94625 94626 94627 94628 94629 94630 94631 94632 94633 94634 94635 94636 | |
Responses
Bases: OCIDataResponse
Response to SystemSIPDeviceTypeGetListRequest. Contains a table of identity/ device profile types configured in the system. The column headings are: "Device Type", "Profile", "Is Obsolete" and "Reseller Id".
The following columns are only returned in AS data mode:
"Reseller Id"
Attributes:
device_type_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
Example Usage
from mercury_ocip.client import Client
from mercury_ocip.commands import SystemSIPDeviceTypeGetListRequest
client = Client()
command = SystemSIPDeviceTypeGetListRequest(
response_size_limit=...,
search_criteria_device_type=...,
search_criteria_exact_signaling_address_type=...,
search_criteria_reseller_id=...,
search_criteria_device_configuration_options=...,
include_system_level=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip.client import Client
client = Client()
response = client.raw_command("SystemSIPDeviceTypeGetListRequest",
response_size_limit=...,
search_criteria_device_type=...,
search_criteria_exact_signaling_address_type=...,
search_criteria_reseller_id=...,
search_criteria_device_configuration_options=...,
include_system_level=...,
)
print(response)