WufooR (version 1.0.1)

fields_info: Return details about form's fields

Description

The Fields API describes a hierarchy of your data. At the heart of this API is the listing of FieldId values. Each FieldId corresponds to a value in the Entries API.

Usage

fields_info(
  wufoo_name = auth_name(NULL),
  formIdentifier = NULL,
  showRequestURL = FALSE,
  debugConnection = 0L,
  domain = "wufoo.com"
)

Arguments

wufoo_name

- User's Name. Default: auth_name

formIdentifier

- this will give you information about just one form. A request without the formIdentifier will return all forms.

showRequestURL

- use only for DEBUG purposes

debugConnection

- samilar as above. Either "0L" (false; default) or "1L"

domain

- for whatever reason domain's ccTLD may change. With this parameter you can change default wufoo.com to another one such as wufoo.eu

Value

Title - The title is the friendly name you gave the field when creating your form. For example, if you were building a table with the API, the Title would be a column header.

Type - The Type represents a Wufoo field type. A listing of the these types can be found in the Field Type section of this documentation.

ID - This is the unique reference ID for your field. There will be one corresponding ID for each Entry in return value of the the Entries API.

IsRequired - This value can be one or zero, representing whether or not the field has been marked required in the Form Builder.

OtherField - This value is true or false and is only set if the field has choices. Only Multiple-Choice fields have the option of an Other field. When a Multiple-Choice field is marked as HasOtherField, the last choice is the Other field.

Examples

# NOT RUN {
fields_info(formIdentifier = "z5kqx7h1gtvg4g", showRequestURL = TRUE)
fields_info(formIdentifier = "z5kqx7h1gtvg4g", debugConnection = 1L)
# }
# NOT RUN {
# }