GetFormStructure: Get the form structure of a form.

In RColetum: Access your Coletum's Data from API

Get the form structure of a form.

Description

Get the structure of the questions of a specific form in the shape a nested data frame, that contains all the needed information to request the answers of the form.

Usage

GetFormStructure(token, idForm, nameForm = NULL, componentId = NULL)

Arguments

token	A string access token.
idForm	Numeric Id of the required form.
nameForm	String name of the required form. Just is used when an idForm are not supplied. When this parameter is used, are spent extra one access quota.
componentId	Optional filter. That is the field identifier, it's possible use to filter to get a specific field.

Details

To get more details about the fields provided by the result, please visit the API documentation.

Value

A possible nested data frame.

Examples

GetFormStructure("cizio7xeohwgc8k4g4koo008kkoocwg", 5705)
GetFormStructure("cizio7xeohwgc8k4g4koo008kkoocwg", , "RColetum Test - Iris")
GetFormStructure(token = "cizio7xeohwgc8k4g4koo008kkoocwg",
                nameForm = "RColetum Test - Iris")

RColetum documentation built on Oct. 21, 2022, 1:08 a.m.