Skip to content

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_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemSIPDeviceTypeGetListRequest(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]):

    """

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

    search_criteria_device_type: Optional[List[SearchCriteriaDeviceType]] = field(
        default=None, metadata={"alias": "searchCriteriaDeviceType"}
    )

    search_criteria_exact_signaling_address_type: Optional[
        SearchCriteriaExactSignalingAddressType
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactSignalingAddressType"}
    )

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

    search_criteria_device_configuration_options: Optional[
        List[SearchCriteriaExactDeviceTypeConfigurationOptionType]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaDeviceConfigurationOptions"}
    )

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

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_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemSIPDeviceTypeGetListResponse(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):

    """

    device_type_table: OCITable = field(metadata={"alias": "deviceTypeTable"})

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 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_fast.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)