List
curl --request POST \
--url https://api.example.com/api/schedule/schedule-templates.list \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"872815618512410358"
],
"team_ids": [
"872815618512410358"
],
"date_range": "2019-11-11/2019-12-12",
"is_on_call": true,
"type_ids": [
"872815618512410358"
]
}
'import requests
url = "https://api.example.com/api/schedule/schedule-templates.list"
payload = {
"ids": ["872815618512410358"],
"team_ids": ["872815618512410358"],
"date_range": "2019-11-11/2019-12-12",
"is_on_call": True,
"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({
ids: ['872815618512410358'],
team_ids: ['872815618512410358'],
date_range: '2019-11-11/2019-12-12',
is_on_call: true,
type_ids: ['872815618512410358']
})
};
fetch('https://api.example.com/api/schedule/schedule-templates.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/schedule-templates.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([
'ids' => [
'872815618512410358'
],
'team_ids' => [
'872815618512410358'
],
'date_range' => '2019-11-11/2019-12-12',
'is_on_call' => true,
'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/schedule-templates.list"
payload := strings.NewReader("{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"is_on_call\": true,\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/schedule-templates.list")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"is_on_call\": true,\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/schedule-templates.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 \"ids\": [\n \"872815618512410358\"\n ],\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"is_on_call\": true,\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "872815618512410358",
"name": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"description": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"team_id": "872815618512410358",
"type": {
"id": "872815618512410358",
"name": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"machine_name": "<string>",
"display_mode": "normal",
"is_on_call": true
},
"color": "<string>",
"hour_ranges": [
{
"hour_range": "12:34:56/PT2H",
"auto_correct": {
"before_start": "PT1H30M20S",
"after_start": "PT1H30M20S",
"before_end": "PT1H30M20S",
"after_end": "PT1H30M20S"
},
"paid_break": {
"max_duration": "PT1H30M20S",
"hour_range": "12:34:56/PT2H"
}
}
],
"adjustment": {
"value": "PT1H30M20S",
"time": "12:34:56"
},
"tag_ids": [
"872815618512410358"
],
"break_time": {
"min_duration": "PT1H30M20S",
"hour_range": "12:34:56/PT2H"
},
"validity": "2019-11-11/2019-12-12",
"options": {
"counts_in_balances": true,
"timecheck_counted": true,
"employee_resident_ratio": true,
"auto_completable": true
}
}
]Schedule templates
List
Retrieves all schedule templates (or the ones corresponding to the provided ids).
POST
/
api
/
schedule
/
schedule-templates.list
List
curl --request POST \
--url https://api.example.com/api/schedule/schedule-templates.list \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"872815618512410358"
],
"team_ids": [
"872815618512410358"
],
"date_range": "2019-11-11/2019-12-12",
"is_on_call": true,
"type_ids": [
"872815618512410358"
]
}
'import requests
url = "https://api.example.com/api/schedule/schedule-templates.list"
payload = {
"ids": ["872815618512410358"],
"team_ids": ["872815618512410358"],
"date_range": "2019-11-11/2019-12-12",
"is_on_call": True,
"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({
ids: ['872815618512410358'],
team_ids: ['872815618512410358'],
date_range: '2019-11-11/2019-12-12',
is_on_call: true,
type_ids: ['872815618512410358']
})
};
fetch('https://api.example.com/api/schedule/schedule-templates.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/schedule-templates.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([
'ids' => [
'872815618512410358'
],
'team_ids' => [
'872815618512410358'
],
'date_range' => '2019-11-11/2019-12-12',
'is_on_call' => true,
'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/schedule-templates.list"
payload := strings.NewReader("{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"is_on_call\": true,\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/schedule-templates.list")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"872815618512410358\"\n ],\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"is_on_call\": true,\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/schedule-templates.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 \"ids\": [\n \"872815618512410358\"\n ],\n \"team_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"is_on_call\": true,\n \"type_ids\": [\n \"872815618512410358\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "872815618512410358",
"name": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"description": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"team_id": "872815618512410358",
"type": {
"id": "872815618512410358",
"name": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"machine_name": "<string>",
"display_mode": "normal",
"is_on_call": true
},
"color": "<string>",
"hour_ranges": [
{
"hour_range": "12:34:56/PT2H",
"auto_correct": {
"before_start": "PT1H30M20S",
"after_start": "PT1H30M20S",
"before_end": "PT1H30M20S",
"after_end": "PT1H30M20S"
},
"paid_break": {
"max_duration": "PT1H30M20S",
"hour_range": "12:34:56/PT2H"
}
}
],
"adjustment": {
"value": "PT1H30M20S",
"time": "12:34:56"
},
"tag_ids": [
"872815618512410358"
],
"break_time": {
"min_duration": "PT1H30M20S",
"hour_range": "12:34:56/PT2H"
},
"validity": "2019-11-11/2019-12-12",
"options": {
"counts_in_balances": true,
"timecheck_counted": true,
"employee_resident_ratio": true,
"auto_completable": true
}
}
]Body
application/json
If used, it will limit the returned schedule template list to those that are associated with the given team ids (ignoring provided ids that are not).
Example:
"2019-11-11/2019-12-12"
If used, it will limit the returned schedule template list to those that match one of the given schedule template type ids.
Response
200 - application/json
Example:
"872815618512410358"
Show child attributes
Show child attributes
Example:
{
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
}
Show child attributes
Show child attributes
Example:
{
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
}
Example:
"872815618512410358"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"2019-11-11/2019-12-12"
Show child attributes
Show child attributes
⌘I