Skip to content

SystemCommunicationBarringUserControlGetRequest

Bases: OCIRequest

Gets the Communication Barring system level settings. The response is either SystemCommunicationBarringUserControlGetResponse or ErrorResponse.

Attributes:

Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemCommunicationBarringUserControlGetRequest(OCIRequest):
    """Gets the Communication Barring system level settings.
        The response is either SystemCommunicationBarringUserControlGetResponse or ErrorResponse.

    Attributes:

    """

Responses

Bases: OCIDataResponse

Response to the SystemCommunicationBarringUserControlGetRequest. Contains the settings to whole system for Communication Barring User-Control

Attributes:

enable_lockout (bool):

max_number_of_failed_attempts (int):

lockout_minutes (int):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemCommunicationBarringUserControlGetResponse(OCIDataResponse):
    """Response to the SystemCommunicationBarringUserControlGetRequest.
        Contains the settings to whole system for Communication Barring User-Control

    Attributes:

        enable_lockout (bool):

        max_number_of_failed_attempts (int):

        lockout_minutes (int):

    """

    enable_lockout: bool = field(metadata={"alias": "enableLockout"})

    max_number_of_failed_attempts: int = field(
        metadata={"alias": "maxNumberOfFailedAttempts"}
    )

    lockout_minutes: int = field(metadata={"alias": "lockoutMinutes"})

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 SystemCommunicationBarringUserControlGetRequest

client = Client()

command = SystemCommunicationBarringUserControlGetRequest()

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemCommunicationBarringUserControlGetRequest")

print(response)