Documentation
Organization Structure API
Core HR API
Expenses API
Invoices API
Absences API
Office API
Project API
Schedule API
Timesheet API
Mealvouchers API
Compensation API
Training API
curl --request GET \
--url https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId} \
--header 'Authorization: <authorization>'{
"id": 1,
"workingTimeArrangementId": 1,
"pattern": {
"shape": "singleWeek",
"monday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"tuesday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"wednesday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"thursday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"friday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"saturday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"sunday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
},
"splitsHalfDays": true,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25"
}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://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId} \
--header 'Authorization: <authorization>'{
"id": 1,
"workingTimeArrangementId": 1,
"pattern": {
"shape": "singleWeek",
"monday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"tuesday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"wednesday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"thursday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"friday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"saturday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"sunday": {
"id": 1,
"shifts": [
{
"position": "firstHalf",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
},
"startsAt": "<string>"
}
],
"dayOffType": "off",
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
},
"splitsHalfDays": true,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25"
}Headers
API key. Value must be formatted like so: lucca application={api_key}.
Path Parameters
The unique identifier of the Working Time Arrangement.
x >= 0The unique identifier of the Collective Schedule for this Working Time Arrangement.
Response
OK
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.
- Single week SchedulePattern
- Odd-even weeks Schedule Pattern
Show child attributes
Show child attributes
singleWeek, oddEvenWeeks Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay The duration in hours or days (depending on the Unit) of this work Shift.
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 Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay The duration in hours or days (depending on the Unit) of this work Shift.
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 Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay The duration in hours or days (depending on the Unit) of this work Shift.
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 The total duration of work expected on this day.
Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay The duration in hours or days (depending on the Unit) of this work Shift.
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 Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay The duration in hours or days (depending on the Unit) of this work Shift.
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 Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay The duration in hours or days (depending on the Unit) of this work Shift.
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 Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Depends on the Splits Half Days property of the Collective Schedule.
firstHalf, secondHalf, fullDay The duration in hours or days (depending on the Unit) of this work Shift.
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?