get_option_list_id: Get the id of a single option list given an option list name

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

Description

Sends a request to the iFormBuilder API to get the id number for a single option list. You only need to supply the name of the option list.

Usage

get_option_list_id(
  server_name,
  profile_id,
  option_list_name,
  limit = 1000,
  offset = 0,
  access_token
)

Arguments

server_name	String of the iFormBuilder server name
profile_id	Integer of the iFormBuilder profile ID
option_list_name	The name of the option list
limit	The maximum number of option lists 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 listing of all option lists in the given profile

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 id of a single option list given the name
streams_option_list_id <- get_option_list_id(
  server_name = "your_server_name",
  profile_id = 123456,
  option_list_name = "SGS-Streams",
  access_token = access_token)

## End(Not run)

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