Registration

Register worked hours

Changed on
post/public/registrations/v1/register-hours

Request

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

Changes

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to string for status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • breaking

      the request's body type changed from object to no type

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from string to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      response schema application/json enum value removed CANNOT_REGISTER_FOR_MORE_THAN_24_HOURS

    • info

      response schema application/json enum value removed COMPANY_IS_BLACKLISTED_FOR_TIME_WRITING

    • info

      response schema application/json enum value removed DESCRIPTION_TOO_LONG

    • info

      response schema application/json enum value removed DUPLICATE_REGISTRATION

    • info

      response schema application/json enum value removed PLACEMENT_DELETED

    • info

      response schema application/json enum value removed PROJECT_NAME_TOO_LONG

    • info

      response schema application/json enum value removed REGISTERED_DATE_NOT_IN_THE_ALLOWED_RANGE

    • info

      response schema application/json enum value removed REGISTERED_HOURS_CLOSED_FOR_THE_WEEK

    • info

      response schema application/json enum value removed REGISTERED_HOURS_NOT_IN_15_MINUTE_INTERVALS

    • info

      response schema application/json enum value removed WORKER_IS_BLACKLISTED_FOR_TIME_WRITING