Organization Structure API
- Axis-sections
- Departments
- Legal-Units
- Establishments
Core HR API
- Employees Directory
- Guides
Cleemy Expenses API
- Expense-temp-items
- Expense-claims
- Expense-claim-items
Timmi Absences API
- Leaves
- Leave-requests
- Sick-leaves
- Imports
- Guides
Timmi Office API
- User-locations
- Work-locations
Timmi Project API
- Clients
- Projects
- Project services
- Organizations
- Financials
Timmi Settings API
- UserDates
- Workcycle-exceptions
- Working-time-arrangement
Timmi Timesheet API
- Time-entries
- Timesheets
- Reports
- Guides
Pagga Mealvouchers API
- Statutory
- Computation
Pagga Remuneration API
- Fixed-natures
- Fixed-items
- Variable-natures
- Variable-items
Poplee Training API
- Training-demands
- Realized-trainings
Get a Collective Schedule from a Working Time Arrangement by id.
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.
Get a Collective Schedule of a Working Time Arrangement by id
curl --request GET \
--url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-settings/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId}{
"id": 1,
"workingTimeArrangementId": 1,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25",
"pattern": {
"shape": "singleWeek",
"monday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"tuesday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"wednesday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"thursday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"friday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"saturday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"sunday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
},
"splitsHalfDays": true
}Path Parameters
The unique identifier of the Working Time Arrangement.
x > 0The unique identifier of the Collective Schedule for this Working Time Arrangement.
Response
A Collective Schedule describes the employees' expected working hours over a week.
It comes in two shapes:
- "Single Week": Working hours are identical every week.
- "Odd / Even Weeks": Working hours depend on the oddness of the week.
The unique identifier of this Collective Schedule.
x > 0The unique identifier of the Working Time Arrangement this Collective Schedule belongs to.
x > 0The Pattern this Collective Schedule implements. Depends on the Shape.
singleWeek, oddEvenWeeks x > 0Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest x > 0Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest x > 0Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest x > 0Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest x > 0Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest x > 0Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest x > 0Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
Gives the reason why this day should not be worked, as it largely impacts the leave management system:
- 'partTime': this is the day off of a part-time employee.
- 'weeklyRest': often used to mark Sundays.
- 'off': often used to mark Saturdays.
off, partTime, weeklyRest Should half-days be discriminated? In other words, should shifts belong to half days rather than just the day itself?
The date (included) from which this Collective Schedule is applicable. Must be left null for the very first Collective Schedule of a Working Time Arrangement.
The date (included) from which this Collective Schedule is no longer applicable. Is null for the last Collective Schedule of a Working Time Arrangement. Can not be modified as its equal to the day before the next applicable Collective Schedule for this Working Time Arrangement.
Was this page helpful?
curl --request GET \
--url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-settings/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId}{
"id": 1,
"workingTimeArrangementId": 1,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25",
"pattern": {
"shape": "singleWeek",
"monday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"tuesday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"wednesday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"thursday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"friday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"saturday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"sunday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
},
"splitsHalfDays": true
}