get_option_list_element_ids: Get list of option_ids for a given element

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

Description

Sends a request to the iFormBuilder API to get a list of all element ids in an option list for a specific field. For example: key_value. Returns a dataframe with ids and attributes of the specified element.

Usage

get_option_list_element_ids(
  server_name,
  profile_id,
  optionlist_id,
  element,
  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
element	The specific option list element. For example: "key_value".
limit	The maximum number of option element ids 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 with id and attributes for the selected element.

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 element ids
element_ids <- get_option_list_element_ids(
  server_name = "your_server_name",
  profile_id = 123456,
  optionlist_id = your_option_list_id,
  element = "key_value",
  access_token = access_token)

# Inspect the first five element ids
head(element_ids, 5)

## End(Not run)

dannyjwarren/iformr documentation built on Dec. 19, 2021, 8:10 p.m.