Skip to contents

Retrieve An Employee File

Source: R/get_employee_file.R
get_employee_file.Rd

`get_employee_file` takes 'id' (string), 'file_id', (string), and 'api_version' (string) and then requests and returns data about the corresponding file from the BambooHR API. The file will then be written to the user's working directory if possible.

Usage

get_employee_file(
  id = "0",
  file_id = "view",
  api_version = "v1",
  suppress_view = FALSE
)

Arguments

id

The employee id of the employee.

file_id

The file id of the file to be returned.

api_version

The version of BambooHR API to be used.

suppress_view

prevent display of results when file_id = "view", default is FALSE.

Value

returns a response object.

Author

Harry Alexander, harry.alexander@ascent.io

Examples

if (FALSE) {
response <- get_employee_file(
id = 0,
file_id = "480",
api_version = "v1"
)
}