Skip to content

GroupScheduleAddEventRequest

Bases: OCIRequest

Add an event to group schedule. The response is either a SuccessResponse or an ErrorResponse. The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. The endDate element is set to the sum of the adjusted starDate element value and the event duration.

Attributes:

service_provider_id (str):

group_id (str):

schedule_key (ScheduleKey):

event_name (str):

start_date (int):

all_day_event (Optional[bool]):

start_time (Optional[HourMinute]):

end_time (Optional[HourMinute]):

end_date (int):

recurrence (Optional[Recurrence]):
Source code in src/mercury_ocip/commands/commands.py 
55490
55491
55492
55493
55494
55495
55496
55497
55498
55499
55500
55501
55502
55503
55504
55505
55506
55507
55508
55509
55510
55511
55512
55513
55514
55515
55516
55517
55518
55519
55520
55521
55522
55523
55524
55525
55526
55527
55528
55529
55530
55531
55532
55533
55534
55535
55536
55537
55538
55539
55540
55541
55542
55543
55544
55545
@dataclass(kw_only=True)
class GroupScheduleAddEventRequest(OCIRequest):
    """Add an event to group schedule.
        The response is either a SuccessResponse or an ErrorResponse.
        The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate.
        The endDate element is set to the sum of the adjusted starDate element value and the event duration.

    Attributes:

        service_provider_id (str):

        group_id (str):

        schedule_key (ScheduleKey):

        event_name (str):

        start_date (int):

        all_day_event (Optional[bool]):

        start_time (Optional[HourMinute]):

        end_time (Optional[HourMinute]):

        end_date (int):

        recurrence (Optional[Recurrence]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    schedule_key: ScheduleKey = field(metadata={"alias": "scheduleKey"})

    event_name: str = field(metadata={"alias": "eventName"})

    start_date: int = field(metadata={"alias": "startDate"})

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

    start_time: Optional[HourMinute] = field(
        default=None, metadata={"alias": "startTime"}
    )

    end_time: Optional[HourMinute] = field(default=None, metadata={"alias": "endTime"})

    end_date: int = field(metadata={"alias": "endDate"})

    recurrence: Optional[Recurrence] = field(
        default=None, metadata={"alias": "recurrence"}
    )

Responses

Bases: OCIResponse

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

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py 
115
116
117
118
119
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 GroupScheduleAddEventRequest

client = Client()

command = GroupScheduleAddEventRequest(
    service_provider_id=...,
    group_id=...,
    schedule_key=...,
    event_name=...,
    start_date=...,
    all_day_event=...,
    start_time=...,
    end_time=...,
    end_date=...,
    recurrence=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupScheduleAddEventRequest",
    service_provider_id=...,
    group_id=...,
    schedule_key=...,
    event_name=...,
    start_date=...,
    all_day_event=...,
    start_time=...,
    end_time=...,
    end_date=...,
    recurrence=...,
)

print(response)