Configure the form entry submissions API in FireForm

On this page:

Overview
Configuration
Expected input parameters
Return values
Example
Get help

Overview

You can submit a FireForm form entry with the Form Entry Submit (Post) API. With this API, all form validations are applied where applicable.

You cannot use this API with forms that accept payments, or with the following field data types:

Attachment
Person Content Display
Res Contract Display
Sale Items

Note:

To request API access for your FireForm tenant, submit a FireForm API Access Request.

Configuration

To configure this API, see /api/v1/forms/submit on the FireForm API page.

Expected input parameters

Parameter	Description	Format	Required (Y/N)
Username	Form submitter's username	Alphanumeric (20 characters max)	Y
UID	Form submitter's University ID number	Alphanumeric (11 characters max)	Y
EmailAddress	Form submitter's email address	Alphanumeric (100 characters max)	Y
UserDefinedEmailAddresses	List of additional user-defined email addresses	Alphanumeric; list of email addresses separated by semicolons (2,000 characters max)	N
Element	Data for each element is grouped.	N/A	N/A
Element: Name	Name of each form element	`Element_XX` (replace `XX` with the Element ID)	Y
Element: Response	Form submitter's element response	Varies based on element data type	Y

Return values

Expected return data

Parameter	Description	Format
FormEntryID	Unique identification number for the form entry	Integer

Other return values

Code	Description
400	Item is null or values are invalid
404	Item not found

Example

Example input

"Username": "jdoe",
"UID": "1234567890",
"EmailAddress": "jdoe@iu.edu",
"UserDefinedEmailAddresses": "",
"Elements": [
  {
   "Name": "Element_1",
   "Response": "Add Round robin Review options"
  },
  {
   "Name": "Element_2",
   "Response": "High"
  },
  {
   "Name": "Element_3",
   "Response": "Please implement round robin review options. This is needed to be able to successfully implement our form."
  }
 ]
}

Example return

{
 "FormEntryId": 7077
}

Get help

If you have additional questions, need to report a bug, or would like to make enhancement requests for the FireForm system, submit a FireForm Support Request.