curl --request POST \
--url https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "reminder-pauses",
"attributes": {
"starts_on": "2023-12-25",
"ends_on": "2023-12-25"
},
"relationships": {
"user": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses"
payload = { "data": {
"type": "reminder-pauses",
"attributes": {
"starts_on": "2023-12-25",
"ends_on": "2023-12-25"
},
"relationships": { "user": { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
} } }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'reminder-pauses',
attributes: {starts_on: '2023-12-25', ends_on: '2023-12-25'},
relationships: {user: {data: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', type: 'users'}}}
}
})
};
fetch('https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses', 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.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses",
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([
'data' => [
'type' => 'reminder-pauses',
'attributes' => [
'starts_on' => '2023-12-25',
'ends_on' => '2023-12-25'
],
'relationships' => [
'user' => [
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'users'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$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.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"reminder-pauses\",\n \"attributes\": {\n \"starts_on\": \"2023-12-25\",\n \"ends_on\": \"2023-12-25\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"users\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+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.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"reminder-pauses\",\n \"attributes\": {\n \"starts_on\": \"2023-12-25\",\n \"ends_on\": \"2023-12-25\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"users\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"reminder-pauses\",\n \"attributes\": {\n \"starts_on\": \"2023-12-25\",\n \"ends_on\": \"2023-12-25\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"users\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "reminder-pauses",
"attributes": {
"starts_on": "2023-12-25",
"ends_on": "2023-12-25"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
},
"user": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
},
"created_by": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
}
},
"meta": {
"created_at": "2023-11-07T05:31:56Z"
}
},
"jsonapi": {
"version": "1.0"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"errors": [
{
"id": "d26cc34a-ceb2-45fb-aba2-c61782f9ec39",
"status": "422",
"title": "submitting organisation has no scheme share with the form's owning organisation",
"detail": "The request was understood but names something the server cannot act on.",
"code": "CH.001.054"
}
]
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Pause a person's form reminders
Stop every form reminder in the organisation from falling due for one person, from starts_on to ends_on inclusive, for leave or an absence. A paused date produces nothing, so it never shows as missed. The person’s open occurrences already on its dates are removed with it, while met and late ones stay. The pause’s own audit event is the record of that removal: the removed occurrences have none of their own. A pause runs for at most 366 days, must not have ended already, and must not overlap another pause for the same person (409).
A member may pause their own reminders from today on. A pause that starts before today, for an unexpected absence, needs forms:create across the organisation. The days it pauses that have already passed cannot be unpaused: removing the pause later keeps them, and a pause that has ended cannot be removed at all. Check the person and dates of a backdated pause before saving it. Pausing someone else’s requires forms:create across the organisation, or reminder-pauses:manage reaching that person, and the person must be a member of the organisation.
curl --request POST \
--url https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "reminder-pauses",
"attributes": {
"starts_on": "2023-12-25",
"ends_on": "2023-12-25"
},
"relationships": {
"user": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses"
payload = { "data": {
"type": "reminder-pauses",
"attributes": {
"starts_on": "2023-12-25",
"ends_on": "2023-12-25"
},
"relationships": { "user": { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
} } }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'reminder-pauses',
attributes: {starts_on: '2023-12-25', ends_on: '2023-12-25'},
relationships: {user: {data: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', type: 'users'}}}
}
})
};
fetch('https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses', 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.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses",
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([
'data' => [
'type' => 'reminder-pauses',
'attributes' => [
'starts_on' => '2023-12-25',
'ends_on' => '2023-12-25'
],
'relationships' => [
'user' => [
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'users'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$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.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"reminder-pauses\",\n \"attributes\": {\n \"starts_on\": \"2023-12-25\",\n \"ends_on\": \"2023-12-25\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"users\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+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.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"reminder-pauses\",\n \"attributes\": {\n \"starts_on\": \"2023-12-25\",\n \"ends_on\": \"2023-12-25\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"users\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-pauses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"reminder-pauses\",\n \"attributes\": {\n \"starts_on\": \"2023-12-25\",\n \"ends_on\": \"2023-12-25\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"users\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "reminder-pauses",
"attributes": {
"starts_on": "2023-12-25",
"ends_on": "2023-12-25"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
},
"user": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
},
"created_by": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
}
},
"meta": {
"created_at": "2023-11-07T05:31:56Z"
}
},
"jsonapi": {
"version": "1.0"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"errors": [
{
"id": "d26cc34a-ceb2-45fb-aba2-c61782f9ec39",
"status": "422",
"title": "submitting organisation has no scheme share with the form's owning organisation",
"detail": "The request was understood but names something the server cannot act on.",
"code": "CH.001.054"
}
]
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Authorizations
Body
The pause to set, for a member of the organisation in the path.