List
curl --request POST \
--url https://api.example.com/api/schedule/schedules.list \
--header 'Content-Type: application/json' \
--data '
{
"date_range": "2019-11-11/2019-12-12",
"ids": [
"872815618512410358"
],
"resource_ids": [
"872815618512410358"
]
}
'import requests
url = "https://api.example.com/api/schedule/schedules.list"
payload = {
"date_range": "2019-11-11/2019-12-12",
"ids": ["872815618512410358"],
"resource_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',
ids: ['872815618512410358'],
resource_ids: ['872815618512410358']
})
};
fetch('https://api.example.com/api/schedule/schedules.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/schedules.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',
'ids' => [
'872815618512410358'
],
'resource_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/schedules.list"
payload := strings.NewReader("{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"ids\": [\n \"872815618512410358\"\n ],\n \"resource_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/schedules.list")
.header("Content-Type", "application/json")
.body("{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/schedules.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 \"ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "872815618512410358",
"resource_id": "872815618512410358",
"team_id": "872815618512410358",
"time_ranges": [
{
"time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59",
"auto_correct": {
"before_start": "PT1H30M20S",
"after_start": "PT1H30M20S",
"before_end": "PT1H30M20S",
"after_end": "PT1H30M20S"
},
"paid_break": {
"max_duration": "PT1H30M20S",
"time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59"
}
}
],
"schedule_template": {
"id": "872815618512410358",
"name": "<string>",
"description": "<string>",
"color": "<string>"
},
"remark": "<string>",
"modified": true,
"adjustment": {
"value": "PT1H30M20S",
"time": "2019-11-11T12:34:56"
},
"break_time": {
"min_duration": "PT1H30M20S",
"time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59"
},
"options": {
"employee_resident_ratio": true,
"text_color": "<string>",
"special_time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59"
}
}
]Schedules
List
Retrieves all schedules (or the ones corresponding to the provided ids) within a date range.
POST
/
api
/
schedule
/
schedules.list
List
curl --request POST \
--url https://api.example.com/api/schedule/schedules.list \
--header 'Content-Type: application/json' \
--data '
{
"date_range": "2019-11-11/2019-12-12",
"ids": [
"872815618512410358"
],
"resource_ids": [
"872815618512410358"
]
}
'import requests
url = "https://api.example.com/api/schedule/schedules.list"
payload = {
"date_range": "2019-11-11/2019-12-12",
"ids": ["872815618512410358"],
"resource_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',
ids: ['872815618512410358'],
resource_ids: ['872815618512410358']
})
};
fetch('https://api.example.com/api/schedule/schedules.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/schedules.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',
'ids' => [
'872815618512410358'
],
'resource_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/schedules.list"
payload := strings.NewReader("{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"ids\": [\n \"872815618512410358\"\n ],\n \"resource_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/schedules.list")
.header("Content-Type", "application/json")
.body("{\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/schedules.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 \"ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "872815618512410358",
"resource_id": "872815618512410358",
"team_id": "872815618512410358",
"time_ranges": [
{
"time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59",
"auto_correct": {
"before_start": "PT1H30M20S",
"after_start": "PT1H30M20S",
"before_end": "PT1H30M20S",
"after_end": "PT1H30M20S"
},
"paid_break": {
"max_duration": "PT1H30M20S",
"time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59"
}
}
],
"schedule_template": {
"id": "872815618512410358",
"name": "<string>",
"description": "<string>",
"color": "<string>"
},
"remark": "<string>",
"modified": true,
"adjustment": {
"value": "PT1H30M20S",
"time": "2019-11-11T12:34:56"
},
"break_time": {
"min_duration": "PT1H30M20S",
"time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59"
},
"options": {
"employee_resident_ratio": true,
"text_color": "<string>",
"special_time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59"
}
}
]Body
application/json
Response
200 - application/json
Example:
"872815618512410358"
Example:
"872815618512410358"
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
Show child attributes
Show child attributes
⌘I