UserSimultaneousRingFamilyGetRequest17

Bases: OCIRequest

Get the user's simultaneous ring family service setting. The response is either a UserSimultaneousRingFamilyGetResponse17 or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserSimultaneousRingFamilyGetRequest17(OCIRequest):
    """Get the user's simultaneous ring family service setting.
        The response is either a UserSimultaneousRingFamilyGetResponse17 or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserSimultaneousRingFamilyGetRequest17. Contains a criteria table wich column heading: "Is Active", "Criteria Name", "Time Schedule", "Holiday Schedule", "Calls From" and "Blacklisted".

Attributes:

is_active (bool):

do_not_ring_if_on_call (bool):

simultaneous_ring_number (Optional[List[SimultaneousRingNumber]]):

criteria_table (OCITable):

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

@dataclass(kw_only=True)
class UserSimultaneousRingFamilyGetResponse17(OCIDataResponse):
    """Response to the UserSimultaneousRingFamilyGetRequest17.
        Contains a criteria table wich column heading: \"Is Active\", \"Criteria Name\", \"Time Schedule\", \"Holiday Schedule\", \"Calls From\" and \"Blacklisted\".

    Attributes:

        is_active (bool):

        do_not_ring_if_on_call (bool):

        simultaneous_ring_number (Optional[List[SimultaneousRingNumber]]):

        criteria_table (OCITable):

    """

    is_active: bool = field(metadata={"alias": "isActive"})

    do_not_ring_if_on_call: bool = field(metadata={"alias": "doNotRingIfOnCall"})

    simultaneous_ring_number: Optional[List[SimultaneousRingNumber]] = field(
        default=None, metadata={"alias": "simultaneousRingNumber"}
    )

    criteria_table: OCITable = field(metadata={"alias": "criteriaTable"})

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 UserSimultaneousRingFamilyGetRequest17

client = Client()

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

print(response)