_setSkipWeekends

Toggles whether Weekend days are skipped in a Recurring Job or not (e.g a Job which repeats every 3 days, except if it's on the weekend)

Parameters

id

The ID of the Recurring Job

val

An integer parameter which toggles if Weekend days are skipped in the Recurrence settings: 0 => False 1 => True

skip-run

An optional parameter which if set, skips the process of creating new jobs to adapt to changes in the Recurrence settings, which can be time-consuming.

Example

FM_api('AppointmentRecurrence_setSkipWeekends',[
  'id'=>'429027',
  'val'=>'0',
  'skip-run'=>'1'
  ]
);

Results

On Success

{"ok":1}

On Failure

If the "id" parameter is not set or has a value less than 1:

{"error":"missing or invalid parameter: id"}

If the "val" parameter is not set:

{"error":"missing or invalid parameter: val"}