SystemDeviceTypeGetAvailableListRequest22V2

Bases: OCIRequest

Requests a list of non-obsolete Identity/device profile types defined in the system and resellers. It is possible to get either all conference device types or all non-conference types. This command is similar to the SystemSIPDeviceTypeGetListRequest and SystemMGCPDeviceTypeGetListRequest but gets both SIP and MGCP types. If excludeReseller is specified, only system level available device types are returned. If resellerId is specified, all the system level available device types and the device types in the given reseller are returned. If reseller administrator sends the request, resellerId is not specified, the administrator's resellerId is used. If neither excludeReseller nor resellerId is specified, all the system level and reseller level available device types are returned. If excludeLeafDeviceTypes is specified, leaf device types are excluded in the response returned. Leaf device types are device types that have the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". If onlyTreeDeviceTypes is specified, all available tree device types are returned. Tree device types are device types that have the option supportLinks set to "Support Links from Devices".

The following elements are only used in AS data mode and ignored in the XS data mode:
  resellerId
  excludeLeafDeviceTypes
  onlyTreeDeviceTypes

The response is either SystemDeviceTypeGetlAvailableListResponse22V2 or ErrorResponse.

Attributes:

allow_conference (bool):

allow_music_on_hold (bool):

only_conference (bool):

only_video_capable (bool):

only_optional_ip_address (bool):

exclude_reseller (Optional[bool]):

reseller_id (Optional[str]):

exclude_leaf_device_types (Optional[bool]):

only_tree_device_types (Optional[bool]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class SystemDeviceTypeGetAvailableListRequest22V2(OCIRequest):
    """Requests a list of non-obsolete Identity/device profile types defined in the system and resellers. It is possible
        to get either all conference device types or all non-conference types. This command is similar
        to the SystemSIPDeviceTypeGetListRequest and SystemMGCPDeviceTypeGetListRequest
        but gets both SIP and MGCP types.
        If excludeReseller is specified, only system level available device types are returned.
        If resellerId is specified, all the system level available device types and the device types in the given reseller are returned.
        If reseller administrator sends the request, resellerId is not specified, the administrator's resellerId is used.
        If neither excludeReseller nor resellerId is specified, all the system level and reseller level available device types are returned.
        If excludeLeafDeviceTypes is specified, leaf device types are excluded in the response returned.  Leaf
        device types are device types that have the option supportLinks set to \"Support Link to Device\" or \"Support Link to Device and User\".
        If onlyTreeDeviceTypes is specified, all available tree device types are returned.  Tree
        device types are device types that have the option supportLinks set to \"Support Links from Devices\".

        The following elements are only used in AS data mode and ignored in the XS data mode:
          resellerId
          excludeLeafDeviceTypes
          onlyTreeDeviceTypes

        The response is either SystemDeviceTypeGetlAvailableListResponse22V2 or ErrorResponse.

    Attributes:

        allow_conference (bool):

        allow_music_on_hold (bool):

        only_conference (bool):

        only_video_capable (bool):

        only_optional_ip_address (bool):

        exclude_reseller (Optional[bool]):

        reseller_id (Optional[str]):

        exclude_leaf_device_types (Optional[bool]):

        only_tree_device_types (Optional[bool]):

    """

    allow_conference: bool = field(metadata={"alias": "allowConference"})

    allow_music_on_hold: bool = field(metadata={"alias": "allowMusicOnHold"})

    only_conference: bool = field(metadata={"alias": "onlyConference"})

    only_video_capable: bool = field(metadata={"alias": "onlyVideoCapable"})

    only_optional_ip_address: bool = field(metadata={"alias": "onlyOptionalIpAddress"})

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

    reseller_id: Optional[str] = field(default=None, metadata={"alias": "resellerId"})

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

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

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import SystemDeviceTypeGetAvailableListRequest22V2

client = Client()

command = SystemDeviceTypeGetAvailableListRequest22V2(
    allow_conference=...,
    allow_music_on_hold=...,
    only_conference=...,
    only_video_capable=...,
    only_optional_ip_address=...,
    exclude_reseller=...,
    reseller_id=...,
    exclude_leaf_device_types=...,
    only_tree_device_types=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDeviceTypeGetAvailableListRequest22V2",
    allow_conference=...,
    allow_music_on_hold=...,
    only_conference=...,
    only_video_capable=...,
    only_optional_ip_address=...,
    exclude_reseller=...,
    reseller_id=...,
    exclude_leaf_device_types=...,
    only_tree_device_types=...,
)

print(response)