retrieve_element_list: Retrieve a List of Elements

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

Description

Retrieves a list of all the elements contained in a page (form or subform)

Usage

retrieve_element_list(
  server_name,
  profile_id,
  access_token,
  page_id,
  fields = "all"
)

Arguments

server_name	String of the iFormBuilder server name.
profile_id	Integer of the iFormBuilder profile ID.
access_token	Access token produced by get_iform_access_token
page_id	Page ID where the new element will be created.
fields	*Optional* - Defaults to 'all', which returns all fields for each element. Optionally, a character vector of fields to return can be provided.

Value

Dataframe containing a row for each element and a column for each element field.

Author(s)

Bill DeVoe, [e-mail]

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 list of elements in form
elements <- retrieve_element_list(
  server_name = "your_server_name",
  profile_id = "your_profile_id",
  access_token = access_token,
  page_id = "existing_page_id",
  fields = 'all')
  
## End(Not run)

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