get_option_lists: Get a listing of the first 100 option lists in a given...

Description Usage Arguments Value Examples

View source: R/option_lists.R

Description

Sends a request to the iFormBuilder API to get a listing of the first 100 option lists currently posted in the given profile. The API call limit is currently set at 100 records.

Usage

1
2
3
4
5
6
7
get_option_lists(
  server_name,
  profile_id,
  limit = 100,
  offset = 0,
  access_token
)

Arguments

server_name

String of the iFormBuilder server name

profile_id

Integer of the iFormBuilder profile ID

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## 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 and name of all option lists in profile
option_lists <- get_option_lists(
  server_name = "your_server_name",
  profile_id = 123456,
  access_token = access_token)

# Inspect
option_lists

## End(Not run)

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