Skip to content

SystemDeviceTypeGetRequest22V7

Bases: OCIRequest

Requests the information about the specified device type without regard to whether the type is SIP or MGCP. The response is either SystemDeviceTypeGetResponse22V7 or ErrorResponse. Note: The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device types only. Therefore, only present in the response when the device type is SIP.

Attributes:

device_type (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemDeviceTypeGetRequest22V7(OCIRequest):
    """Requests the information about the specified device type without regard to whether the
        type is SIP or MGCP.
        The response is either SystemDeviceTypeGetResponse22V7 or ErrorResponse.
    Note: The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device types only. Therefore, only present in the response when the device type is SIP.

    Attributes:

        device_type (str):

    """

    device_type: str = field(metadata={"alias": "deviceType"})

Responses

Bases: OCIDataResponse

Response to SystemDeviceTypeGetRequest22V7.

The following elements are only used in AS data mode:
  resellerId

Attributes:

is_obsolete (bool):

profile (str):

web_based_config_url (Optional[str]):

static_registration_capable (bool):

cpe_device_options (Optional[CPEDeviceOptionsRead22V6]):

protocol_choice (List[str]):

is_ip_address_optional (bool):

use_domain (bool):

is_mobility_manager_device (bool):

device_type_configuration_option (Optional[str]):

static_line_ordering (Optional[bool]):

reseller_id (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemDeviceTypeGetResponse22V7(OCIDataResponse):
    """Response to SystemDeviceTypeGetRequest22V7.

        The following elements are only used in AS data mode:
          resellerId

    Attributes:

        is_obsolete (bool):

        profile (str):

        web_based_config_url (Optional[str]):

        static_registration_capable (bool):

        cpe_device_options (Optional[CPEDeviceOptionsRead22V6]):

        protocol_choice (List[str]):

        is_ip_address_optional (bool):

        use_domain (bool):

        is_mobility_manager_device (bool):

        device_type_configuration_option (Optional[str]):

        static_line_ordering (Optional[bool]):

        reseller_id (Optional[str]):

    """

    is_obsolete: bool = field(metadata={"alias": "isObsolete"})

    profile: str = field(metadata={"alias": "profile"})

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

    static_registration_capable: bool = field(
        metadata={"alias": "staticRegistrationCapable"}
    )

    cpe_device_options: Optional[CPEDeviceOptionsRead22V6] = field(
        default=None, metadata={"alias": "cpeDeviceOptions"}
    )

    protocol_choice: List[str] = field(metadata={"alias": "protocolChoice"})

    is_ip_address_optional: bool = field(metadata={"alias": "isIpAddressOptional"})

    use_domain: bool = field(metadata={"alias": "useDomain"})

    is_mobility_manager_device: bool = field(
        metadata={"alias": "isMobilityManagerDevice"}
    )

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

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

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

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 SystemDeviceTypeGetRequest22V7

client = Client()

command = SystemDeviceTypeGetRequest22V7(
    device_type=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDeviceTypeGetRequest22V7",
    device_type=...,
)

print(response)