UserSimultaneousRingFamilyGetCriteriaRequest

Bases: OCIRequest

Get a criteria for the user's simultaneous ring family service. The response is either a UserSimultaneousRingFamilyGetCriteriaResponse or an ErrorResponse.

Attributes:

user_id (str):

criteria_name (str):

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

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

    Attributes:

        user_id (str):

        criteria_name (str):

    """

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

    criteria_name: str = field(metadata={"alias": "criteriaName"})

Responses

Bases: OCIDataResponse

Response to the UserSimultaneousRingFamilyGetCriteriaRequest.

Attributes:

time_schedule (Optional[TimeSchedule]):

holiday_schedule (Optional[HolidaySchedule]):

blacklisted (bool):

from_dn_criteria (CriteriaFromDn):

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

@dataclass(kw_only=True)
class UserSimultaneousRingFamilyGetCriteriaResponse(OCIDataResponse):
    """Response to the UserSimultaneousRingFamilyGetCriteriaRequest.

    Attributes:

        time_schedule (Optional[TimeSchedule]):

        holiday_schedule (Optional[HolidaySchedule]):

        blacklisted (bool):

        from_dn_criteria (CriteriaFromDn):

    """

    time_schedule: Optional[TimeSchedule] = field(
        default=None, metadata={"alias": "timeSchedule"}
    )

    holiday_schedule: Optional[HolidaySchedule] = field(
        default=None, metadata={"alias": "holidaySchedule"}
    )

    blacklisted: bool = field(metadata={"alias": "blacklisted"})

    from_dn_criteria: CriteriaFromDn = field(metadata={"alias": "fromDnCriteria"})

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 UserSimultaneousRingFamilyGetCriteriaRequest

client = Client()

command = UserSimultaneousRingFamilyGetCriteriaRequest(
    user_id=...,
    criteria_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserSimultaneousRingFamilyGetCriteriaRequest",
    user_id=...,
    criteria_name=...,
)

print(response)