Skip to content

ServiceProviderAccessDeviceFileGetRequest20

Bases: OCIRequest

Request to get a service provider device profile file. The response is either ServiceProviderAccessDeviceFileGetResponse20 or ErrorResponse.

Attributes:

service_provider_id (str):

device_name (str):

file_format (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderAccessDeviceFileGetRequest20(OCIRequest):
    """Request to get a service provider device profile file.
        The response is either ServiceProviderAccessDeviceFileGetResponse20 or ErrorResponse.

    Attributes:

        service_provider_id (str):

        device_name (str):

        file_format (str):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    device_name: str = field(metadata={"alias": "deviceName"})

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

Responses

Bases: OCIDataResponse

Response to ServiceProviderAccessDeviceFileGetRequest21.

Attributes:

file_source (str):

configuration_file_name (Optional[str]):

access_url (str):

repository_url (Optional[str]):

template_url (Optional[str]):

extended_capture_enabled (Optional[bool]):

extended_capture_url (Optional[str]):

allow_upload_from_device (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderAccessDeviceFileGetResponse20(OCIDataResponse):
    """Response to ServiceProviderAccessDeviceFileGetRequest21.

    Attributes:

        file_source (str):

        configuration_file_name (Optional[str]):

        access_url (str):

        repository_url (Optional[str]):

        template_url (Optional[str]):

        extended_capture_enabled (Optional[bool]):

        extended_capture_url (Optional[str]):

        allow_upload_from_device (Optional[bool]):

    """

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

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

    access_url: str = field(metadata={"alias": "accessUrl"})

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

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

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

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

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

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 ServiceProviderAccessDeviceFileGetRequest20

client = Client()

command = ServiceProviderAccessDeviceFileGetRequest20(
    service_provider_id=...,
    device_name=...,
    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("ServiceProviderAccessDeviceFileGetRequest20",
    service_provider_id=...,
    device_name=...,
    file_format=...,
)

print(response)