_setFlag

Toggles a Flag marker on a User Clock-in

Parameters

id

The ID of the Clock-in you want to toggle

flag

An integer value used to flag or unflag a User Clock-in: 0 = No Flag 1 = Flag Icon

Example

FM_api('UserClockin_setFlag',[
  'id'=>'30020',
  'flag'=>'0'
  ]
);

Results

On Success

{"ok":1}

On Failure

If the "id" parameter is not set, or is less than 1:

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

If the "id" value does not match any existing User Clock-in:

{"error":"clockin does not exist"}

If the "flag" parameter is higher than 1 or less than 0:

{"error":"invalid parameter: flag"}

Without a set value given, however, the "flag" parameter defaults to 0, which will instead result in a success.

Last updated