|
Http Verb |
POST |
|---|---|
|
Url |
/workforce/timesheets/clockings |
|
Permissions required |
Resource Clocking: Edit (fsm.core.resource.clocking.edit) |
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
|
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
|
Business Logic
This API creates a new clocking entry for a given resource. This API handles single-resource clocking only, team clocking (foreman + assistants batch insert) is out of scope and will be handled separately.
Path Parameters
None.
Query String Parameters
None.
Header Parameters
Default.
Request Body
|
Field |
Mandatory |
Note |
|---|---|---|
|
resourceId |
Yes |
The identifier of the resource that is clocking in. |
|
clockingDate |
Yes |
The date and time of the clocking. |
|
typeId |
Yes |
The identifier of the type of the clocking. |
|
note |
No |
The note associated with the clocking. |
|
reason |
No |
The reason for the clocking. |
|
registrationDate |
No |
The date and time of the registration. Defaults to now if not sent. |
|
teamLeader |
No |
The identifier of the team leader. Defaults to the team-shift leader or to the resource itself if not sent.
|
Response documentation
|
Field |
Note |
|---|---|
|
id |
The identifier of the created clocking. |
Response error codes
WORK_SHIFT_NOT_FOUND, WORK_SHIFT_AFTER_TOMORROW, INVALID_ACTION_FOR_DATE_BEFORE_YESTERDAY, FOLLOWING_CLOCKING_EXISTS, CLOCKING_TYPE_NOT_COMPATIBLE_WITH_PREVIOUS, CLOCKING_DATE_PRIOR_TO_LAST_RECORDED