Skip to content

SystemSIPDeviceTypeFileGetRequest22V2

Bases: OCIRequest

Request to get a sip device type file. The response is either SystemSIPDeviceTypeFileGetResponse22V2 or ErrorResponse.

Attributes:

device_type (str):

file_format (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemSIPDeviceTypeFileGetRequest22V2(OCIRequest):
    """Request to get a sip device type file.
          The response is either SystemSIPDeviceTypeFileGetResponse22V2 or ErrorResponse.

    Attributes:

        device_type (str):

        file_format (str):

    """

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

    file_format: str = field(metadata={"alias": "fileFormat"})

Responses

Bases: OCIDataResponse

Response to SystemSIPDeviceTypeFileGetRequest22V2. Take note:

  1. accessUrl may have undefined content.
  When it is the case, undefined content is put between [].
  It may also be set to "Error Access FQDN Not Provisioned" when the access FQDN is not set,
  or "Error Access Context Name Not Provisioned" when the context name is not set.

  2. repositoryUrl may be set to "DEVICE_CONFIGURATION_FILE_REPOSITORY_MISSING", if there is no file repository defined.

Attributes:

remote_file_format (str):

file_category (str):

file_customization (str):

file_source (str):

configuration_file_name (Optional[str]):

use_http_digest_authentication (bool):

mac_based_file_authentication (bool):

user_name_password_file_authentication (bool):

bearer_file_authentication (bool):

mac_in_cert (bool):

mac_in_non_request_uri (bool):

mac_format_in_non_request_uri (Optional[str]):

access_url (Optional[str]):

repository_url (Optional[str]):

template_url (Optional[str]):

allow_http (bool):

allow_https (bool):

allow_tftp (bool):

enable_caching (bool):

allow_upload_from_device (bool):

default_extended_file_capture_mode (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemSIPDeviceTypeFileGetResponse22V2(OCIDataResponse):
    """Response to SystemSIPDeviceTypeFileGetRequest22V2.
          Take note:

          1. accessUrl may have undefined content.
          When it is the case, undefined content is put between [].
          It may also be set to \"Error Access FQDN Not Provisioned\" when the access FQDN is not set,
          or \"Error Access Context Name Not Provisioned\" when the context name is not set.

          2. repositoryUrl may be set to \"DEVICE_CONFIGURATION_FILE_REPOSITORY_MISSING\", if there is no file repository defined.

    Attributes:

        remote_file_format (str):

        file_category (str):

        file_customization (str):

        file_source (str):

        configuration_file_name (Optional[str]):

        use_http_digest_authentication (bool):

        mac_based_file_authentication (bool):

        user_name_password_file_authentication (bool):

        bearer_file_authentication (bool):

        mac_in_cert (bool):

        mac_in_non_request_uri (bool):

        mac_format_in_non_request_uri (Optional[str]):

        access_url (Optional[str]):

        repository_url (Optional[str]):

        template_url (Optional[str]):

        allow_http (bool):

        allow_https (bool):

        allow_tftp (bool):

        enable_caching (bool):

        allow_upload_from_device (bool):

        default_extended_file_capture_mode (Optional[bool]):

    """

    remote_file_format: str = field(metadata={"alias": "remoteFileFormat"})

    file_category: str = field(metadata={"alias": "fileCategory"})

    file_customization: str = field(metadata={"alias": "fileCustomization"})

    file_source: str = field(metadata={"alias": "fileSource"})

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

    use_http_digest_authentication: bool = field(
        metadata={"alias": "useHttpDigestAuthentication"}
    )

    mac_based_file_authentication: bool = field(
        metadata={"alias": "macBasedFileAuthentication"}
    )

    user_name_password_file_authentication: bool = field(
        metadata={"alias": "userNamePasswordFileAuthentication"}
    )

    bearer_file_authentication: bool = field(
        metadata={"alias": "bearerFileAuthentication"}
    )

    mac_in_cert: bool = field(metadata={"alias": "macInCert"})

    mac_in_non_request_uri: bool = field(metadata={"alias": "macInNonRequestURI"})

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

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

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

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

    allow_http: bool = field(metadata={"alias": "allowHttp"})

    allow_https: bool = field(metadata={"alias": "allowHttps"})

    allow_tftp: bool = field(metadata={"alias": "allowTftp"})

    enable_caching: bool = field(metadata={"alias": "enableCaching"})

    allow_upload_from_device: bool = field(metadata={"alias": "allowUploadFromDevice"})

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

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 SystemSIPDeviceTypeFileGetRequest22V2

client = Client()

command = SystemSIPDeviceTypeFileGetRequest22V2(
    device_type=...,
    file_format=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemSIPDeviceTypeFileGetRequest22V2",
    device_type=...,
    file_format=...,
)

print(response)