Delete

[POST] .../v1/workschedule/delete

Deletes work schedule (soft-delete). Soft-delete a work schedule that must no longer be assigned or used for attendance. The method validates id, checks work schedule delete permission 692, rejects deletion of the account default schedule, marks the schedule deleted and inactive and returns row_affected with changed ids. The request body is required and id must be positive. Missing body, invalid id, denied permission, missing schedule, default schedule deletion and storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Schedule ID.

Request Example

{
  "id": 14
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": [
      14
    ]
  }
}