UserCommunicationBarringUserControlGetRequest

Bases: OCIRequest

Lists the Communication Barring profiles available to a user and indicates which profile if any is currently active for the user.. The response is either UserCommunicationBarringUserControlGetResponse or ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserCommunicationBarringUserControlGetRequest(OCIRequest):
    """Lists the Communication Barring profiles available to a user and
        indicates which profile if any is currently active for the user..
        The response is either UserCommunicationBarringUserControlGetResponse or ErrorResponse.

    Attributes:

        user_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

Responses

Bases: OCIDataResponse

Response to the UserCommunicationBarringUserControlGetRequest. Identifies the profiles available to the user and which one if any is active as well as the lockout status. Contains a table with column headings: "Name", "Code", "Activated" and "Primary".

Attributes:

lockout_status (bool):

profile_table (OCITable):

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

@dataclass(kw_only=True)
class UserCommunicationBarringUserControlGetResponse(OCIDataResponse):
    """Response to the UserCommunicationBarringUserControlGetRequest.
        Identifies the profiles available to the user and which one if any
        is active as well as the lockout status.
        Contains a table with column headings: \"Name\", \"Code\", \"Activated\" and \"Primary\".

    Attributes:

        lockout_status (bool):

        profile_table (OCITable):

    """

    lockout_status: bool = field(metadata={"alias": "lockoutStatus"})

    profile_table: OCITable = field(metadata={"alias": "profileTable"})

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 UserCommunicationBarringUserControlGetRequest

client = Client()

command = UserCommunicationBarringUserControlGetRequest(
    user_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("UserCommunicationBarringUserControlGetRequest",
    user_id=...,
)

print(response)