List Collective Schedules from a Working Time Arrangement
curl --request GET \
--url https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules \
--header 'Authorization: <authorization>'import requests
url = "https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1,
"workingTimeArrangementId": 1,
"pattern": {
"monday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"tuesday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"wednesday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"thursday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"friday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"saturday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"sunday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
}
},
"splitsHalfDays": true,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25"
}
]
}{
"type": "<string>",
"title": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"detail": "<string>"
}Working-time-arrangement
List Collective Schedules from a Working Time Arrangement
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 the list of Collective Schedules from a Working Time Arrangement by id
GET
/
schedule
/
api
/
working-time-arrangements
/
{workingTimeArrangementId}
/
collective-schedules
List Collective Schedules from a Working Time Arrangement
curl --request GET \
--url https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules \
--header 'Authorization: <authorization>'import requests
url = "https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1,
"workingTimeArrangementId": 1,
"pattern": {
"monday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"tuesday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"wednesday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"thursday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"friday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"saturday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
},
"sunday": {
"id": 1,
"shifts": [
{
"duration": {
"value": 1,
"iso": "<string>"
},
"startsAt": "<string>"
}
],
"workDuration": {
"value": 1,
"iso": "<string>"
}
}
},
"splitsHalfDays": true,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25"
}
]
}{
"type": "<string>",
"title": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"detail": "<string>"
}Headers
API key. Value must be formatted like so: lucca application={api_key}.
Path Parameters
The unique identifier of the Working Time Arrangement.
Required range:
x >= 0Query Parameters
Number of items per page
Required range:
0 <= x <= 100Next page token
Examples:
"next_token&fields.root=next"
"2"
Include collection properties.
Available options:
count Sort items by a property.
Available options:
-startsOn Response
OK
Show child attributes
Show child attributes
Was this page helpful?
The collective-schedule resource
Previous
Get a Collective Schedule from a Working Time Arrangement by id.
Next
⌘I