v1

latestOpenAPI 3.0.32026-08-0645108163.2 KB

Registration

Register worked hours

post/public/registrations/v1/register-hours

Request body

placementIdstring uuid required

The UUID of the placement for which hours are being registered.

projectIdstring uuid

The UUID of the project if the hours are registered on a project.

projectNamestring

The name of the project if the hours are registered on a project. When a new project name is received, a project is automatically created. When a known project name is received, the existing project is used.

startTimestring date-time required

The timestamp when the work period started. Format: ISO 8601, must be in UTC. example: '2024-09-25T15:30:00Z'

endTimestring date-time required

The timestamp when the work period ended. Format: ISO 8601 (e.g., 2024-09-25T15:30:00Z). Expected in UTC.

breakDurationstring duration

The optional, combined duration of breaks taken during the work period. Format: ISO 8601 (e.g., PT1H30M).

descriptionstring

An optional description or notes about the work period.

Example request

{
  "breakDuration": "PT1H30M"
}

Response

Successfully registered worked hours.

registrationIdstring uuid required

Unique identifier of a registration. A single registration is associated with 1 or more registration lines, including normal hours, overtime and surcharges