get_page_id: Get id of a single page (i.e., form, or subform) given a form...

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 of a single form. You only need to supply the name of the option list. Returns an integer id for the given form.

Usage

get_page_id(
  server_name,
  profile_id,
  page_name,
  limit = 1000,
  offset = 0,
  access_token
)

Arguments

server_name	String of the iFormBuilder server name
profile_id	The id number of your profile
page_name	The name of the form or subform
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

An integer id for 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 = "spawning_ground_p",
  access_token = access_token)

# Inspect the form_id
form_id

## End(Not run)

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