SystemFaxMessagingGetRequest

Bases: OCIRequest

Request the system level data associated with Fax Messaging. The response is either a SystemFaxMessagingGetResponse or an ErrorResponse.

Attributes:

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

@dataclass(kw_only=True)
class SystemFaxMessagingGetRequest(OCIRequest):
    """Request the system level data associated with Fax Messaging.
        The response is either a SystemFaxMessagingGetResponse or an ErrorResponse.

    Attributes:

    """

Responses

Bases: OCIDataResponse

Response to SystemFAXMessagingGetRequest.

The following elements are only used in AS data mode:
   statusDurationHours
   statusAuditIntervalHours

Attributes:

status_duration_hours (int):

status_audit_interval_hours (int):

maximum_concurrent_faxes_per_user (int):

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

@dataclass(kw_only=True)
class SystemFaxMessagingGetResponse(OCIDataResponse):
    """Response to SystemFAXMessagingGetRequest.

        The following elements are only used in AS data mode:
           statusDurationHours
           statusAuditIntervalHours

    Attributes:

        status_duration_hours (int):

        status_audit_interval_hours (int):

        maximum_concurrent_faxes_per_user (int):

    """

    status_duration_hours: int = field(metadata={"alias": "statusDurationHours"})

    status_audit_interval_hours: int = field(
        metadata={"alias": "statusAuditIntervalHours"}
    )

    maximum_concurrent_faxes_per_user: int = field(
        metadata={"alias": "maximumConcurrentFaxesPerUser"}
    )

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 SystemFaxMessagingGetRequest

client = Client()

command = SystemFaxMessagingGetRequest()

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemFaxMessagingGetRequest")

print(response)