GetAnswers: Get all the answers of a form.

In geo-sapiens/RColetum: Access your Coletum's Data from API

Get all the answers of a form.

Description

Get all the currents answers of a specific form. This function makes a call to GetFormStructure and spent 2 quotas.

Usage

GetAnswers(token, idForm, nameForm = NULL, singleDataFrame = FALSE,
  source = NULL, createdAfter = NULL, createdBefore = NULL,
  createdDeviceAfter = NULL, createdDeviceBefore = NULL,
  updatedAfter = NULL, updatedBefore = NULL)

Arguments

token	String access token.
idForm	Numeric Id of the required form.
nameForm	String name of the required form. Just is used when an idForm is not supplied. When this parameter is used, are spent extra one access quota.
singleDataFrame	Boolean flag. Indicates the preference to create a single data frame with all the answers. In this case, is possible to have repeated values, according to the multiplicity of relationships.
source	Optional filter. Is the the source of the answer and can use "web_public", "web_private" or "mobile".
createdAfter	Optional filter. This parameter filters the answers that were answered after this date. Is acceptable in the ISO8601 format ("YYYY-MM-DD" or "YYYY-MM-DDThh:mm:ssTZD").
createdBefore	Optional filter. This parameter filters the answers that were answered before this date. Is acceptable in the ISO8601 format ("YYYY-MM-DD" or "YYYY-MM-DDThh:mm:ssTZD").
createdDeviceAfter	Optional filter. This parameter filters the answers that were answered after this date on device time. Is acceptable in the ISO8601 format ("YYYY-MM-DD" or "YYYY-MM-DDThh:mm:ssTZD").
createdDeviceBefore	Optional filter. This parameter filters the answers that were answered before this date on device time. Is acceptable in the ISO8601 format ("YYYY-MM-DD" or "YYYY-MM-DDThh:mm:ssTZD").
updatedAfter	Optional filter. This parameter filters the answers that were updated after this date. Is acceptable in the ISO8601 format ("YYYY-MM-DD" or "YYYY-MM-DDThh:mm:ssTZD").
updatedBefore	Optional filter. This parameter filters the answers that were updated before this date. Is acceptable in the ISO8601 format ("YYYY-MM-DD" or "YYYY-MM-DDThh:mm:ssTZD").

Details

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

Value

A list, with one or more data frames.

Examples

GetAnswers("cizio7xeohwgc8k4g4koo008kkoocwg", 5705)
GetAnswers("cizio7xeohwgc8k4g4koo008kkoocwg", ,"RColetum Test - Iris", TRUE)
GetAnswers(token = "cizio7xeohwgc8k4g4koo008kkoocwg",
             nameForm = "RColetum Test - Iris")
GetAnswers(token = "cizio7xeohwgc8k4g4koo008kkoocwg",
             idForm = 5705,
             source = NULL,
             createdAfter = "2012-12-20",
             createdBefore = "2018-12-20"
             )
GetAnswers(token = "cizio7xeohwgc8k4g4koo008kkoocwg",
             idForm = 5705,
             source = NULL,
             createdAfter = "2012-12-20",
             createdBefore = "2018-12-20T19:20:30+01:00"
             )
GetAnswers(token = "cizio7xeohwgc8k4g4koo008kkoocwg",
             idForm = 5705,
             source = NULL,
             createdAfter = "2012-12-20T19:20:30Z",
             createdBefore = "2018-12-20T19:20:30+01:00"
             )
GetAnswers(token = "cizio7xeohwgc8k4g4koo008kkoocwg",
             idForm = 5705,
             source = "web_public",
             createdAfter = "2012-12-20T19:20:30+01:00",
             createdBefore = "2018-12-20T19:20:30+01:00"
             )
GetAnswers(token = "cizio7xeohwgc8k4g4koo008kkoocwg",
             idForm = 5705,
             singleDataFrame = TRUE,
             source = "web_private",
             createdAfter = "2012-12-20T19:20:30Z",
             createdBefore = "2018-12-20T19:20:30Z"
             )
GetAnswers(token = "cizio7xeohwgc8k4g4koo008kkoocwg",
             idForm = 5705,
             singleDataFrame = TRUE,
             source = "web_private",
             createdAfter = "2012-12-20T19:20:30Z",
             createdBefore = "2018-12-20T19:20:30Z",
             createdDeviceAfter = "2012-12-20T19:20:30Z",
             createdDeviceBefore = "2018-12-20T19:20:30Z",
             updatedAfter = "2018-05-20T19:20:30Z",
             updatedBefore = "2018-06-20T19:20:30Z"
             )

geo-sapiens/RColetum documentation built on April 14, 2024, 6:23 p.m.