getTimeOffPolicy
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getTimeOffPolicy \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getTimeOffPolicy",
"timeOffPolicyId": "E3DC43BB-262C-4CB1-A210-5530615A2921"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getTimeOffPolicy"
payload = {
"method": "getTimeOffPolicy",
"timeOffPolicyId": "E3DC43BB-262C-4CB1-A210-5530615A2921"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getTimeOffPolicy',
timeOffPolicyId: 'E3DC43BB-262C-4CB1-A210-5530615A2921'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getTimeOffPolicy', 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://sandbox.rollfi.xyz/reports/getTimeOffPolicy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getTimeOffPolicy',
'timeOffPolicyId' => 'E3DC43BB-262C-4CB1-A210-5530615A2921'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://sandbox.rollfi.xyz/reports/getTimeOffPolicy"
payload := strings.NewReader("{\n \"method\": \"getTimeOffPolicy\",\n \"timeOffPolicyId\": \"E3DC43BB-262C-4CB1-A210-5530615A2921\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.get("https://sandbox.rollfi.xyz/reports/getTimeOffPolicy")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getTimeOffPolicy\",\n \"timeOffPolicyId\": \"E3DC43BB-262C-4CB1-A210-5530615A2921\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getTimeOffPolicy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getTimeOffPolicy\",\n \"timeOffPolicyId\": \"E3DC43BB-262C-4CB1-A210-5530615A2921\"\n}"
response = http.request(request)
puts response.read_body{
"timeOffPolicy": {
"timeOffPolicyId": "E3DC43BB-262C-4CB1-A210-5530615A2921",
"timeOffPolicyName": "Standard Vacation",
"lumpSumHoursEarned": 80,
"accrualRatePerHour": 1.5,
"canCarryoverHours": true,
"carryoverLimitHours": 40,
"maxAccumulatedHours": 160,
"waitingPeriodQuantity": 0,
"isProratedByStartDate": true,
"payoutOnTerminations": true,
"maxPayoutHours": 40,
"timeOffPolicyType": "Vacation",
"earningMethod": "Lump Sum (All at once)",
"waitingPeriodUnit": "Days",
"timeOffRecievedWhen": "On Hire Date"
}
}{
"error": {
"code": 400,
"message": "timeOffPolicyId is Mandatory."
}
}PTO
getTimeOffPolicy
The getTimeOffPolicy API returns a single timeOffPolicy using timeOffPolicyId
Use:
- Look up current time off policy fields before updating using the
updateTimeOffPolicyAPI
Notes:
- To find all active timeOffPolicies for a company use the
getTimeOffPoliciesAPI
GET
/
reports
/
getTimeOffPolicy
getTimeOffPolicy
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getTimeOffPolicy \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getTimeOffPolicy",
"timeOffPolicyId": "E3DC43BB-262C-4CB1-A210-5530615A2921"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getTimeOffPolicy"
payload = {
"method": "getTimeOffPolicy",
"timeOffPolicyId": "E3DC43BB-262C-4CB1-A210-5530615A2921"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getTimeOffPolicy',
timeOffPolicyId: 'E3DC43BB-262C-4CB1-A210-5530615A2921'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getTimeOffPolicy', 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://sandbox.rollfi.xyz/reports/getTimeOffPolicy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getTimeOffPolicy',
'timeOffPolicyId' => 'E3DC43BB-262C-4CB1-A210-5530615A2921'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://sandbox.rollfi.xyz/reports/getTimeOffPolicy"
payload := strings.NewReader("{\n \"method\": \"getTimeOffPolicy\",\n \"timeOffPolicyId\": \"E3DC43BB-262C-4CB1-A210-5530615A2921\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.get("https://sandbox.rollfi.xyz/reports/getTimeOffPolicy")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getTimeOffPolicy\",\n \"timeOffPolicyId\": \"E3DC43BB-262C-4CB1-A210-5530615A2921\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getTimeOffPolicy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getTimeOffPolicy\",\n \"timeOffPolicyId\": \"E3DC43BB-262C-4CB1-A210-5530615A2921\"\n}"
response = http.request(request)
puts response.read_body{
"timeOffPolicy": {
"timeOffPolicyId": "E3DC43BB-262C-4CB1-A210-5530615A2921",
"timeOffPolicyName": "Standard Vacation",
"lumpSumHoursEarned": 80,
"accrualRatePerHour": 1.5,
"canCarryoverHours": true,
"carryoverLimitHours": 40,
"maxAccumulatedHours": 160,
"waitingPeriodQuantity": 0,
"isProratedByStartDate": true,
"payoutOnTerminations": true,
"maxPayoutHours": 40,
"timeOffPolicyType": "Vacation",
"earningMethod": "Lump Sum (All at once)",
"waitingPeriodUnit": "Days",
"timeOffRecievedWhen": "On Hire Date"
}
}{
"error": {
"code": 400,
"message": "timeOffPolicyId is Mandatory."
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
Show child attributes
Show child attributes
⌘I
