get_employee_file: Retrieve An Employee File

In bambooHR: A Wrapper to the 'BambooHR' API

Retrieve An Employee File

Description

‘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(s)

Harry Alexander, [e-mail]

Examples

## Not run: 
response <- get_employee_file(
id = 0,
file_id = "480",
api_version = "v1"
)

## End(Not run)

bambooHR documentation built on Oct. 25, 2023, 5:07 p.m.