scto_get_form_definitions {rsurveycto}

Fetch form definitions from a SurveyCTO server

Description

This function fetches spreadsheet form definitions corresponding to the xlsx files downloadable in the Design tab of the SurveyCTO console.

Usage

scto_get_form_definitions(auth, form_ids = NULL, simplify = TRUE)

Arguments

auth

scto_auth() object.

form_ids

Character vector indicating IDs of the forms. NULL indicates all forms.

simplify

Logical indicating whether to return the definition for one form as a simple list instead of a named, nested list.

Value

If simplify is TRUE and getting one form definition, a list. Otherwise a named list of lists containing the definition for each form.

See Also

scto_auth(), scto_meta(), scto_read(), scto_get_attachments(), scto_write()

Examples

## Not run: 
auth = scto_auth('scto_auth.txt')
scto_def = scto_get_form_definitions(auth, 'my_form')
scto_defs = scto_get_form_definitions(auth)

## End(Not run)