Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
Working Time Arrangements

Get a Working Time Arrangement by id.

<Warning> **This is a beta feature.** You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. </Warning>

Get a Working Time Arrangement by id

get/schedule/api/working-time-arrangements/{workingTimeArrangementId}

Response

OK

idinteger required

The unique identifier of this Working Time Arrangement.

namestring required

The unique name for this Working Time Arrangement.

descriptionstring nullable required

An optional description.

unit'day' | 'hour' | 'time' required

An event can be set in:

  • Day: "I worked for a half day last Monday".
  • Hour: "I worked for 2 hours last Monday".
  • Time: "I worked between 10:00 AM and 12:00 AM last Monday".
fullTimeEquivalentnumber required

By default, equal to the ratio between the Contract Working Time Duration and the Reference Working Time Duration.

isPartTimeboolean required

True whenever the Full Time Equivalent is below 1 (eg <100%).

isArchivedboolean required

True whenever this Working Time Arrangement should no longer be given to employees.

isScheduleValidboolean required

False if there is not at least one Collective Schedule. In this case, the Working Time Arrangement can't be given to any employee through his Work Contract.

currentAssignmentsCountinteger
authorizedCommandsstring[] required

The actions the current authenticated User can make on this Working Time Arrangement. Depends on his permissions.

Example response

{
  "contractWorkingTimeDuration": {
    "iso": "PT7H30M"
  },
  "referenceWorkingTimeDuration": {
    "iso": "PT7H30M"
  },
  "fullDayAbsence": {
    "duration": {
      "iso": "PT7H30M"
    }
  }
}