get_page_record_list: Get list of all record ids in a single page (i.e., form, or...

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

Description

Sends a request to the iFormBuilder API to get a list of all record ids in a given form or subform.

Usage

get_page_record_list(
  server_name,
  profile_id,
  page_id,
  limit = 1000,
  offset = 0,
  access_token
)

Arguments

server_name	String of the iFormBuilder server name
profile_id	The id number of your profile
page_id	The id number of the form
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 vector of record ids from the given form

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 form in the profile given the form name
form_id <- get_page_id(
  server_name = "your_server_name",
  profile_id = 123456,
  page_name = "your_form_p",
  access_token = access_token)

# Get a list of all record ids in the specified form
record_ids <- get_page_record_list(
  server_name = "your_server_name",
  profile_id = 123456,
  page_id = form_id,
  access_token = access_token)

# Inspect the top five record_ids
head(record_ids, 5)

## End(Not run)

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