Skip to main content

system.kanoa.schedule.adjustExistingEvents

Description

Takes a list of scheduleTimes to be scheduled and a list of scheduleBlocks to be modified, and depending on the scheduleOption, will either have its start or end time modified, or deleted. If recurring scheduleBlock is affected, then an exception will be created.

Syntax

adjustExistingEvents(scheduleTimes, scheduleBlockList, scheduleOption, userId)

Parameters:
  • scheduleTimes (list[dict]): List of dictionaries defining scheduled times.
  • scheduleBlockList (list[dict]): List of scheduleBlockInfo dictionaries.
  • scheduleOption (string): 'fixed' or 'override'.
  • userId (int): ID of the user performing the adjustment.

  • Returns:
  • None
  • Dictionary

    ParameterTypeRequiredNotes
    startDatedatetimeStart of the schedule time block
    endDatedatetimeEnd of the schedule time block