CheckIn

[POST] .../v1/workattendance/checkin

Opens a work session for the current user Use this method when the current employee starts a work session for the active shift. The method checks permission 696, resolves the effective work schedule, verifies the check-in time window, optionally validates the request IP against the schedule, creates a WorkSession, writes an action log entry, fires the check-in webhook and returns new_id. The request body is required even when only the optional comment is omitted; comment is stored as the check-in comment when supplied. Missing body, denied permission, already active session, missing schedule, out-of-shift check-in, disallowed IP and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
comment String Optional Check-in comment. Stored in a database field with a 500 character limit.

Request Example

{
  "comment": "Started shift from the front desk"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 88
  }
}