Skip to content

SystemConfigurableTreatmentGetRequest24

Bases: OCIRequest

Get all the attributes of a configurable treatment. The response is either a SystemConfigurableTreatmentGetResponse24 or an ErrorResponse.

Attributes:

treatment_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemConfigurableTreatmentGetRequest24(OCIRequest):
    """Get all the attributes of a configurable treatment.
        The response is either a SystemConfigurableTreatmentGetResponse24 or an ErrorResponse.

    Attributes:

        treatment_id (str):

    """

    treatment_id: str = field(metadata={"alias": "treatmentId"})

Responses

Bases: OCIDataResponse

Response to the SystemConfigurableTreatmentGetRequest24. The response contains the treatment configurable information.

The following elements are only used in AS data mode and not returned in XS data mode:
  warnCode
  warnText

The following elements are only used in AS data mode:
  accessSendWarningHeader, value "false" is returned in XS data mode
  networkSendWarningHeader, value "false" is returned in XS data mode

Attributes:

description (Optional[str]):

charge_indicator (str):

access_sip_status_code (Optional[int]):

access_sip_status_message (Optional[str]):

network_sip_status_code (Optional[int]):

network_sip_status_message (Optional[str]):

q850_cause_value (Optional[int]):

q850_text (Optional[str]):

access_treatment_audio_file (Optional[str]):

access_treatment_video_file (Optional[str]):

network_treatment_audio_file (Optional[str]):

network_treatment_video_file (Optional[str]):

cdr_termination_cause (Optional[str]):

route_advance (bool):

internal_release_cause (Optional[str]):

access_send_reason_header (bool):

network_send_reason_header (bool):

warn_code (Optional[int]):

warn_text (Optional[str]):

access_send_warning_header (bool):

network_send_warning_header (bool):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemConfigurableTreatmentGetResponse24(OCIDataResponse):
    """Response to the SystemConfigurableTreatmentGetRequest24.
        The response contains the treatment configurable information.

        The following elements are only used in AS data mode and not returned in XS data mode:
          warnCode
          warnText

        The following elements are only used in AS data mode:
          accessSendWarningHeader, value \"false\" is returned in XS data mode
          networkSendWarningHeader, value \"false\" is returned in XS data mode

    Attributes:

        description (Optional[str]):

        charge_indicator (str):

        access_sip_status_code (Optional[int]):

        access_sip_status_message (Optional[str]):

        network_sip_status_code (Optional[int]):

        network_sip_status_message (Optional[str]):

        q850_cause_value (Optional[int]):

        q850_text (Optional[str]):

        access_treatment_audio_file (Optional[str]):

        access_treatment_video_file (Optional[str]):

        network_treatment_audio_file (Optional[str]):

        network_treatment_video_file (Optional[str]):

        cdr_termination_cause (Optional[str]):

        route_advance (bool):

        internal_release_cause (Optional[str]):

        access_send_reason_header (bool):

        network_send_reason_header (bool):

        warn_code (Optional[int]):

        warn_text (Optional[str]):

        access_send_warning_header (bool):

        network_send_warning_header (bool):

    """

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

    charge_indicator: str = field(metadata={"alias": "chargeIndicator"})

    access_sip_status_code: Optional[int] = field(
        default=None, metadata={"alias": "accessSIPStatusCode"}
    )

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

    network_sip_status_code: Optional[int] = field(
        default=None, metadata={"alias": "networkSIPStatusCode"}
    )

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

    q850_cause_value: Optional[int] = field(
        default=None, metadata={"alias": "q850CauseValue"}
    )

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

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

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

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

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

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

    route_advance: bool = field(metadata={"alias": "routeAdvance"})

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

    access_send_reason_header: bool = field(
        metadata={"alias": "accessSendReasonHeader"}
    )

    network_send_reason_header: bool = field(
        metadata={"alias": "networkSendReasonHeader"}
    )

    warn_code: Optional[int] = field(default=None, metadata={"alias": "warnCode"})

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

    access_send_warning_header: bool = field(
        metadata={"alias": "accessSendWarningHeader"}
    )

    network_send_warning_header: bool = field(
        metadata={"alias": "networkSendWarningHeader"}
    )

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 SystemConfigurableTreatmentGetRequest24

client = Client()

command = SystemConfigurableTreatmentGetRequest24(
    treatment_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemConfigurableTreatmentGetRequest24",
    treatment_id=...,
)

print(response)