_setClockinNotes

Sets the Notes for a Clock-in time within a User Clock-in

Parameters

id

The ID of the User Clock-in which includes the Clock-in time being modified

notes

A JSON array with 3 objects:

  • "content" - A string with the new notes to be saved to the Clock-in time

  • "noteTime" - The time and date when the new notes were saved, as an epoch time format with milliseconds (e.g 1688461858514, being 10:10am on 04-07-2023)

  • "createdBy" - The ID of the User who modified the notes of the Clock-in

Example

FM_api('UserClockin_setClockinNotes',[
  'id'=>'30020',
  'notes'=>'[
              {
              "content":"A few minutes late due to Traffic.",
              "noteTime":1688459159389,
              "createdby":92447
              }
            ]'
      ]
);

Results

On Success

{"ok":1}

On Failure

If the "id" parameter is missing or has a value less than 1

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

If the "id" parameter does not fit with any existing User Clock-in IDs

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

Last updated