get_pto: Bamboo API get request wrapper

In propellerpdx/bambooR: Helper functions for interaction with the Bamboo HR REST API

Bamboo API get request wrapper

Description

Submits a get request to retrieve the all employees time off by date

Usage

get_pto(user = NULL, password = NULL, startDate = NULL,
  endDate = NULL, verbose = FALSE)

Arguments

user	Bamboo api user id, register in Bamboo "API Keys"
password	Bamboo login password
startDate	date; start date of the range for which PTO records are desired; *required*; defaults to NULL
endDate	date; end date of the range for which PTO records are desired; *required*; defaults to NULL
verbose	logical; indicates if detailed output from httr calls should be provided; default FALSE
year	int; year for which PTO records are desired; defaults to current year

Value

tbl_df

Author(s)

Mark Druffel, [e-mail]

References

https://www.bamboohr.com/api/documentation/, https://github.com/r-lib/httr

Examples

## Not run: 
user <- 'your_api_user'
password <- 'your_password'
startDate = lubridate::ymd("20190101")
endDate = lubridate::ymd("20191231")
employees <- get_pto(user = user, password = password, startDate = startDate, endDate = endDate)

## End(Not run)

propellerpdx/bambooR documentation built on July 8, 2023, 4:43 a.m.