Configure the single form entry API in FireForm

On this page:

Overview
Configuration
Expected input parameters
Return values
Example
Get help

Overview

You can get a single FireForm form entry based on the form code and form entry short ID with the Form Entry (Get) API. The API will return the metadata, workflow information, sections, elements, and responses for each form entry.

Note:

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

Configuration

To configure this API, see /api/v1/forms/entry/{FormCode}/{EntryShortId} on the FireForm API page.

Expected input parameters

Parameter	Description	Format	Required (Y/N)
FormCode	The form's unique identifier	Alphanumeric (15 characters max)	Y
EntryshortId	The form entry's unique identification number	Integer	Y

Return values

Expected return data

Parameter	Description	Format
FormCode	The form's unique identifier	Alphanumeric (15 characters max)
FormName	The name of the form	Alphanumeric (100 characters max)
ShortIDNumber	The form entry's unique identification number	Integer
QueueName	Queue name associated with the form	Alphanumeric (200 characters max)
RoutingStep	Number associated with the form entry's current routing step	Integer
UserName	Form submitter's username	Alphanumeric (20 characters max)
UserFullName	Form submitter's first, middle, and last names	Alphanumeric (300 characters max)
UID	Form submitter's University ID number	Alphanumeric (11 characters max)
EmailAddress	Form submitter's email address	Alphanumeric (100 characters max)
Assignee	Usernames of individuals assigned to take action on a form entry at its current step	Alphanumeric (8,000 characters max)
FormStateName	The form's current state	Alphanumeric (200 characters max)
SubmittedDatetime	Date and time the form was submitted	Date/time2
UpdatedDatetime	Date and time the form was updated	Date/time2
UserDefinedEmailAddresses	List of additional user-defined email addresses	Alphanumeric; list of email addresses separated by semicolons (2,000 characters max)
Sections:	Data for each section of the form is grouped.	N/A
Sections: Name	The section's name	Alphanumeric (200 characters max)
Sections: Elements:	Data for each element is grouped.	N/A
Sections: Elements: ID	The element's unique identification number	Integer
Sections: Elements: Name	Name of the element	Alphanumeric (200 characters max)
Sections: Elements: Response	Form submitter's element response	Alphanumeric (8,000 characters max)
Sections: Elements: Type	The element's data type	Alphanumeric (100 characters max)
Sections: Elements: DataClassification	The element's institutional data data classification level	Alphanumeric (30 characters max)
Sections: Elements: DataDomain	The element's data subject area	Alphanumeric (100 characters max)
FormEntryTransactionDetail	Data for each financial transaction associated with the form entry is grouped.	N/A
FormEntryTransactionDetail: PaymentType	The transaction's payment type	Alphanumeric (50 characters max): `PP`: PayPal `SVC`: Gold SVC/CrimsonCash `SBBIL`: Department billing `Invoice`: Invoice
FormEntryTransactionDetail: Operator	Person who made the payment	Alphanumeric (100 characters max)
FormEntryTransactionDetail: Amount	Payment amount	Decimal (18, 2)
FormEntryTransactionDetail: Status	Transaction status	Alphanumeric (50 characters max)

Other return values

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

Example

Example input

{
 "FormCode": "askrps",
 "EntryShortId": "4187",
}

Example return

{
 "FormCode": "askrps",
 "FormName": "askRPS",
 "ShortIdNumber": 4187,
 "QueueName": "Tim's Forms",
 "RoutingStep": "1",
 "UserName": "jdoe",
 "UserFullName": "Doe, Jane Elaine",
 "UID": "1234567890",
 "EmailAddress": "jdoe@iu.edu",
 "Assignee": "username1",
 "FormStateName": "New",
 "SubmittedDatetime": "10/14/2019 01:09 PM",
 "UpdatedDatetime": "10/14/2019 01:09 PM",
 "UserDefinedEmailAddresses": null,
 "Sections": [
  {
   "Name": "askRPS Inquiry",
   "Elements": [
    {
     "ID": 1,
     "Name": "Reason for your inquiry",
     "Response": "Facilities/Custodial",
     "Type": "Pivot",
     "DataClassification": "Public",
     "DataDomain": "None"
    },
    {
     "ID": 2,
     "Name": "Sub-Topic",
     "Response": "Appliance Problem",
     "Type": "Pivot",
     "DataClassification": "Public",
     "DataDomain": "None"
    }
   ]
  },
  {
   "Name": "Maintenance Disclaimer",
   "Elements": [
    {
     "ID": 14,
     "Name": "Disclaimer",
     "Response": "*Work orders will be processed within 24 hours*",
     "Type": "Statement",
     "DataClassification": "Public",
     "DataDomain": "None"
    }
   ]
  },
  {
   "Name": "Maintenance Request",
   "Elements": [
    {
     "ID": 6,
     "Name": "Building",
     "Response": "Ashton",
     "Type": "Pivot",
     "DataClassification": "University Internal",
     "DataDomain": "None"
    },
    {
     "ID": 9,
     "Name": "Category",
     "Response": "Appliance",
     "Type": "Drop Down List",
     "DataClassification": "Public",
     "DataDomain": "None"
    },
    {
     "ID": 5,
     "Name": "Emergency Statement",
     "Response": "**NOTE:** If this is an emergency, please contact 555-555-5555",
     "Type": "Statement",
     "DataClassification": "Public",
     "DataDomain": "None"
    },
    {
     "ID": 8,
     "Name": "I've reported this problem before",
     "Response": "Agreed:I've reported this problem before",
     "Type": "Agreement",
     "DataClassification": "Public",
     "DataDomain": "None"
    },
    {
     "ID": 4,
     "Name": "Photo of the issue",
     "Response": "Dishwasher attachment.PNG",
     "Type": "File Attachment",
     "DataClassification": "Restricted",
     "DataDomain": "Facilities Data"
    },
    {
     "ID": 3,
     "Name": "Problem Description",
     "Response": "The dishwasher will not turn on",
     "Type": "Text (long)",
     "DataClassification": "Restricted",
     "DataDomain": "Health Data"
    },
    {
     "ID": 7,
     "Name": "Room",
     "Response": "Cafeteria",
     "Type": "Pivot",
     "DataClassification": "University Internal",
     "DataDomain": "None"
    },
    {
     "ID": 10,
     "Name": "Sub-Category",
     "Response": "Dishwasher",
     "Type": "Drop Down List",
     "DataClassification": "Public",
     "DataDomain": "None"
    }
   ]
  },
  {
   "Name": "Meal Plan",
   "Elements": [
    {
     "ID": 15,
     "Name": "What's wrong with your meal plan?",
     "Response": null,
     "Type": "Text (long)",
     "DataClassification": "Public",
     "DataDomain": "None"
    }
   ]
  },
  {
   "Name": "Person Information",
   "Elements": [
    {
     "ID": 12,
     "Name": "Your Name",
     "Response": "Jane Doe",
     "Type": "Text (short)",
     "DataClassification": "University Internal",
     "DataDomain": "None"
    },
    {
     "ID": 13,
     "Name": "Your Phone Number",
     "Response": "555-555-5555",
     "Type": "Text (short)",
     "DataClassification": "University Internal",
     "DataDomain": "None"
    }
   ]
  },
  {
   "Name": "Standard Request",
   "Elements": [
    {
     "ID": 11,
     "Name": "Inquiry/Issue Description",
     "Response": null,
     "Type": "Text (long)",
     "DataClassification": "University Internal",
     "DataDomain": "None"
    }
   ]
  }
 ],
 "FormEntryTransactionDetail": null
}

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.