get_pages_list: Get list of the first 100 pages (i.e., forms, or subforms) in...

Description Usage Arguments Value Examples

View source: R/page_records.R

Description

Sends a request to the iFormBuilder API to get a listing of forms and subforms in the current profile. Returns a dataframe with form id and form name. Limited to 100 records per API call.

Usage

1
get_pages_list(server_name, profile_id, limit = 1000, offset = 0, access_token)

Arguments

server_name

String of the iFormBuilder server name

profile_id

The id number of your profile

limit

The maximum number of form ids to return

offset

Skips the offset number of ids before beginning to return

access_token

Access token produced by get_iform_access_token

Value

A dataframe of all forms (pages) 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 forms in profile
forms_list <- get_pages_list(
  server_name = "your_server_name",
  profile_id = 123456,
  access_token = access_token)

# Inspect
forms_list

## End(Not run)

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