GET
/
timmi-settings
/
api
/
working-time-arrangements
/
{workingTimeArrangementId}
curl --request GET \
  --url https://{host}/timmi-settings/api/working-time-arrangements/{workingTimeArrangementId} \
  --header 'Authorization: <authorization>'
{
  "id": 1,
  "name": "<string>",
  "description": "<string>",
  "unit": "day",
  "referencePeriod": {
    "frequencyType": "week",
    "firstDayOfWeek": "monday"
  },
  "contractWorkingTimeDuration": {
    "value": 1,
    "iso": "<string>",
    "unit": "days"
  },
  "referenceWorkingTimeDuration": {
    "value": 1,
    "iso": "<string>",
    "unit": "days"
  },
  "fullTimeEquivalent": 0.5,
  "fullDayAbsenceDurationInHours": 1,
  "publicHolidaysCalendar": {
    "id": 1,
    "name": "<string>"
  },
  "isPartTime": true,
  "isArchived": true,
  "isScheduleValid": true,
  "currentAssignmentsCount": 123,
  "timesheetRegulation": {
    "id": 1,
    "name": "<string>"
  },
  "currentSchedulePatternSummary": {
    "shape": "singleWeek",
    "days": [
      {
        "dayOffType": "off",
        "workPosition": "firstHalf",
        "workDuration": 1
      }
    ]
  },
  "authorizedCommands": [
    "create"
  ]
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Path Parameters

​
workingTimeArrangementId
integer
required

The unique identifier of the Working Time Arrangement.

Required range: x >= 0

Response

200
application/json

OK

A working time arrangement is an object aimed at drawing employees populations regarding time management rules.

It is attached to employees through their work contract and essentially dictates:

  • their contractual working time, ie how many hours / days they are paid for each week / year.
  • a full time equivalent based on the the ratio between this contractual work duration and a "full time work duration".
  • a succession of Collective Schedules that describe their usual working hours.
  • the applicable regulation in Timmi Timesheet.