Skip to content

UserSequentialRingModifyRequest

Bases: OCIRequest

Modify the user's sequential ring service setting. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

ring_base_location_first (Optional[bool]):

base_location_number_of_rings (Optional[int]):

continue_if_base_location_is_busy (Optional[bool]):

caller_may_stop_search (Optional[bool]):

location01 (Optional[SequentialRingLocationModify]):

location02 (Optional[SequentialRingLocationModify]):

location03 (Optional[SequentialRingLocationModify]):

location04 (Optional[SequentialRingLocationModify]):

location05 (Optional[SequentialRingLocationModify]):

criteria_activation (Optional[List[CriteriaActivation]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserSequentialRingModifyRequest(OCIRequest):
    """Modify the user's sequential ring service setting.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        ring_base_location_first (Optional[bool]):

        base_location_number_of_rings (Optional[int]):

        continue_if_base_location_is_busy (Optional[bool]):

        caller_may_stop_search (Optional[bool]):

        location01 (Optional[SequentialRingLocationModify]):

        location02 (Optional[SequentialRingLocationModify]):

        location03 (Optional[SequentialRingLocationModify]):

        location04 (Optional[SequentialRingLocationModify]):

        location05 (Optional[SequentialRingLocationModify]):

        criteria_activation (Optional[List[CriteriaActivation]]):

    """

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

    ring_base_location_first: Optional[bool] = field(
        default=None, metadata={"alias": "ringBaseLocationFirst"}
    )

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

    continue_if_base_location_is_busy: Optional[bool] = field(
        default=None, metadata={"alias": "continueIfBaseLocationIsBusy"}
    )

    caller_may_stop_search: Optional[bool] = field(
        default=None, metadata={"alias": "callerMayStopSearch"}
    )

    location01: Optional[SequentialRingLocationModify] = field(
        default=None, metadata={"alias": "Location01"}
    )

    location02: Optional[SequentialRingLocationModify] = field(
        default=None, metadata={"alias": "Location02"}
    )

    location03: Optional[SequentialRingLocationModify] = field(
        default=None, metadata={"alias": "Location03"}
    )

    location04: Optional[SequentialRingLocationModify] = field(
        default=None, metadata={"alias": "Location04"}
    )

    location05: Optional[SequentialRingLocationModify] = field(
        default=None, metadata={"alias": "Location05"}
    )

    criteria_activation: Optional[List[CriteriaActivation]] = field(
        default=None, metadata={"alias": "criteriaActivation"}
    )

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 UserSequentialRingModifyRequest

client = Client()

command = UserSequentialRingModifyRequest(
    user_id=...,
    ring_base_location_first=...,
    base_location_number_of_rings=...,
    continue_if_base_location_is_busy=...,
    caller_may_stop_search=...,
    location01=...,
    location02=...,
    location03=...,
    location04=...,
    location05=...,
    criteria_activation=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserSequentialRingModifyRequest",
    user_id=...,
    ring_base_location_first=...,
    base_location_number_of_rings=...,
    continue_if_base_location_is_busy=...,
    caller_may_stop_search=...,
    location01=...,
    location02=...,
    location03=...,
    location04=...,
    location05=...,
    criteria_activation=...,
)

print(response)