get_core_option_list_elements: Get core elements in an option list

In arestrom/iformr: A set of tools to leverage the iFormBuilder API

Description

Sends a request to the iFormBuilder API to return the core option list elements. Function will return the id, sort_order, label, key_value, and condition_value.

Usage

get_core_option_list_elements(
  server_name,
  profile_id,
  optionlist_id,
  limit = 1000,
  offset = 0,
  access_token
)

Arguments

server_name	String of the iFormBuilder server name
profile_id	Integer of the iFormBuilder profile ID
optionlist_id	The id number for the option list
limit	The maximum number of option list items to return
offset	Skips the offset number of options before beginning to return
access_token	Access token produced by get_iform_access_token

Value

A dataframe of the core option list elements

Examples

## Not run: 
# Get access_token
access_token <- get_iform_access_token(
  server_name = "your_server_name",
  client_key_name = "your_client_key_name",
  client_secret_name = "your_client_secret_name")

# Get the core elements in an option list
core_elements <- get_core_option_list_elements(
  server_name = "your_server_name",
  profile_id = 123456,
  optionlist_id = your_option_list_id,
  access_token = access_token)

# Inspect the first five core elements
head(core_elements, 5)

## End(Not run)

arestrom/iformr documentation built on Nov. 25, 2021, 11:21 p.m.