List
curl --request POST \
--url https://api.example.com/api/schedule/special-days.list \
--header 'Content-Type: application/json' \
--data '
{
"date_range": "2019-11-11/2019-12-12",
"team_ids": [
"872815618512410358"
],
"type_ids": [
"872815618512410358"
]
}
'import requests
url = "https://api.example.com/api/schedule/special-days.list"
payload = {
"date_range": "2019-11-11/2019-12-12",
"team_ids": ["872815618512410358"],
"type_ids": ["872815618512410358"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
date_range: '2019-11-11/2019-12-12',
team_ids: ['872815618512410358'],
type_ids: ['872815618512410358']
})
};
fetch('https://api.example.com/api/schedule/special-days.list', 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://api.example.com/api/schedule/special-days.list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'date_range' => '2019-11-11/2019-12-12',
'team_ids' => [
'872815618512410358'
],
'type_ids' => [
'872815618512410358'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/schedule/special-days.list"
payload := strings.NewReader("{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/schedule/special-days.list")
.header("Content-Type", "application/json")
.body("{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/special-days.list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "872815618512410358",
"date": "2019-11-11",
"name": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"validity_date_range": "2019-11-11/2019-12-12",
"type_id": "872815618512410358",
"team_ids": [
"872815618512410358"
],
"skipped": true
}
]Special days
List
List the occurrences of special days (bank holidays and other days marked in the schedule) over a period.
POST
/
api
/
schedule
/
special-days.list
List
curl --request POST \
--url https://api.example.com/api/schedule/special-days.list \
--header 'Content-Type: application/json' \
--data '
{
"date_range": "2019-11-11/2019-12-12",
"team_ids": [
"872815618512410358"
],
"type_ids": [
"872815618512410358"
]
}
'import requests
url = "https://api.example.com/api/schedule/special-days.list"
payload = {
"date_range": "2019-11-11/2019-12-12",
"team_ids": ["872815618512410358"],
"type_ids": ["872815618512410358"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
date_range: '2019-11-11/2019-12-12',
team_ids: ['872815618512410358'],
type_ids: ['872815618512410358']
})
};
fetch('https://api.example.com/api/schedule/special-days.list', 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://api.example.com/api/schedule/special-days.list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'date_range' => '2019-11-11/2019-12-12',
'team_ids' => [
'872815618512410358'
],
'type_ids' => [
'872815618512410358'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/schedule/special-days.list"
payload := strings.NewReader("{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/schedule/special-days.list")
.header("Content-Type", "application/json")
.body("{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/special-days.list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "872815618512410358",
"date": "2019-11-11",
"name": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"validity_date_range": "2019-11-11/2019-12-12",
"type_id": "872815618512410358",
"team_ids": [
"872815618512410358"
],
"skipped": true
}
]This endpoint is in preview: it may change without notice until it becomes part of a stable version.
Body
application/json
When the range spans more than 10 years and part of it extends outside the planning period (2005 to 10 years after the current year), the part in question is left out.
Example:
"2019-11-11/2019-12-12"
Also returns the special days defined on the ancestors of these teams, as they apply to them.
Response
200 - application/json
Example:
"872815618512410358"
Example:
"2019-11-11"
Show child attributes
Show child attributes
Example:
{
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
}
Example:
"2019-11-11/2019-12-12"
Example:
"872815618512410358"
Every team the special day is defined on. A day defined on the whole instance carries the instance team.
An official bank holiday that is only observed in some years and does not apply in this one.