Configure the multiple form entries API in FireForm
On this page:
Overview
You can get multiple FireForm form entries based on the form code with the Form Entries (Get) API. The API will return the metadata, workflow information, sections, elements, and responses for each form entry.
Configuration
To configure this API, see /api/v1/forms/entries/{FormCode} 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 |
| LastUpdateDateTime |
Date and time the form was last modified |
Date/Time (yyyyMMddTHHmmssZ) |
N |
| State |
The form's state |
Alphanumeric (200 characters max) |
N |
| Page |
The number of pages of results to be returned |
Integer (3 digits max) |
N |
| Per_Page |
The number of entries to be returned per page |
Integer (max value 1,000) |
N |
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):
|
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": "catering",
"LastUpdateDateTime": "",
"state": "new",
"page": "1",
"per_page": "2",
}Example return
[
{
"FormCode": "catering",
"FormName": "Catering",
"ShortIdNumber": 4185,
"QueueName": "Catering Queue",
"RoutingStep": "1",
"UserName": "jdoe",
"UserFullName": "Joe, JaneElaine",
"UID": "1234567890",
"EmailAddress": "jdoe@ iu.edu ",
"Assignee": "username1,username2,username3",
"FormStateName": "New",
"SubmittedDatetime": "10/14/2019 12:56 PM",
"UpdatedDatetime": "10/14/2019 12:56 PM",
"UserDefinedEmailAddresses": null,
"Sections": [
{
"Name": "Contact Information",
"Elements": [
{
"ID": 7,
"Name": "Account Number (For IU Employees Only)",
"Response": "123456",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "Financial Data"
},
{
"ID": 6,
"Name": "Department",
"Response": "UITS",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 3,
"Name": "Email Address",
"Response": "jdoe@ test.com ",
"Type": "Email Address",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 1,
"Name": "First Name",
"Response": "Jane",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 2,
"Name": "Last Name",
"Response": "Doe",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 8,
"Name": "Organization",
"Response": null,
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 4,
"Name": "Phone Number",
"Response": "555-555-5555",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 5,
"Name": "Title",
"Response": "Executive Assistant",
"Type": "Text (short)",
"DataClassification": null,
"DataDomain": null
}
]
},
{
"Name": "Event Details",
"Elements": [
{
"ID": 21,
"Name": "Approximate Budget",
"Response": "$2000.00",
"Type": "Currency",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 20,
"Name": "Estimated Guest Count",
"Response": "100",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 24,
"Name": "Event End Date",
"Response": "11/01/2019",
"Type": "Date",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 19,
"Name": "Event End Time",
"Response": "2:00 PM",
"Type": "Time",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 23,
"Name": "Event Start Date",
"Response": "11/01/2019",
"Type": "Date",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 18,
"Name": "Event Start Time",
"Response": "11:00 AM",
"Type": "Time",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 22,
"Name": "Location",
"Response": "Indiana Memorial Union",
"Type": "Drop Down List",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 15,
"Name": "Mobile Phone",
"Response": "555-555-5555",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 14,
"Name": "On-Site Contact Name",
"Response": "Jane Doe",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 17,
"Name": "Type of Catering Service",
"Response": "Corporate Catering",
"Type": "Drop Down List",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 16,
"Name": "Type of Event",
"Response": "Conference",
"Type": "Drop Down List",
"DataClassification": "University Internal",
"DataDomain": "None"
}
]
},
{
"Name": "Setup Details",
"Elements": [
{
"ID": 10,
"Name": " I'd like to discuss making this a zero-waste event.",
"Response": "Agreed: I'd like to discuss making this a zero-waste event.",
"Type": "Agreement",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 12,
"Name": "I need to rent tables for this event.",
"Response": "No",
"Type": "Yes/No",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 13,
"Name": "List any allergies, dietary restrictions, or other special requests we should know about. ",
"Response": "Vegetarian and vegan options should be available",
"Type": "Text (long)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 11,
"Name": "What type of food do you prefer? ",
"Response": null,
"Type": "Drop Down List",
"DataClassification": "University Internal",
"DataDomain": "None"
}
]
}
],
"FormEntryTransactionDetail": {
"PaymentType": "PP",
"Operator": "ashbush",
"Amount": 10,
"Status": "Completed"
}
},
{
"FormCode": "catering",
"FormName": "Catering",
"ShortIdNumber": 4186,
"QueueName": "Catering Queue",
"RoutingStep": "1",
"UserName": "jdoe",
"UserFullName": "Doe, Jane Elaine",
"UID": "0001789948",
"EmailAddress": "jdoe@ iu.edu ",
"Assignee": "username1,username2,username3",
"FormStateName": "New",
"SubmittedDatetime": "10/14/2019 01:00 PM",
"UpdatedDatetime": "10/14/2019 01:00 PM",
"UserDefinedEmailAddresses": null,
"Sections": [
{
"Name": "Contact Information",
"Elements": [
{
"ID": 7,
"Name": "Account Number (For IU Employees Only)",
"Response": "987654",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "Financial Data"
},
{
"ID": 6,
"Name": "Department",
"Response": "RPS",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 3,
"Name": "Email Address",
"Response": "johnd@test.test",
"Type": "Email Address",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 1,
"Name": "First Name",
"Response": "John",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 2,
"Name": "Last Name",
"Response": "Doe",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 8,
"Name": "Organization",
"Response": null,
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 4,
"Name": "Phone Number",
"Response": "555-555-5555",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 5,
"Name": "Title",
"Response": "Event Coordinator",
"Type": "Text (short)",
"DataClassification": null,
"DataDomain": null
}
]
},
{
"Name": "Event Details",
"Elements": [
{
"ID": 21,
"Name": "Approximate Budget",
"Response": "$5000.00",
"Type": "Currency",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 20,
"Name": "Estimated Guest Count",
"Response": "50",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 24,
"Name": "Event End Date",
"Response": "12/19/2019",
"Type": "Date",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 19,
"Name": "Event End Time",
"Response": "8:00 PM",
"Type": "Time",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 23,
"Name": "Event Start Date",
"Response": "12/19/2019",
"Type": "Date",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 18,
"Name": "Event Start Time",
"Response": "5:00 PM",
"Type": "Time",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 22,
"Name": "Location",
"Response": "RPS Admin Building",
"Type": "Drop Down List",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 15,
"Name": "Mobile Phone",
"Response": "555-555-5555",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 14,
"Name": "On-Site Contact Name",
"Response": "John Doe",
"Type": "Text (short)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 17,
"Name": "Type of Catering Service",
"Response": "Bento Catering",
"Type": "Drop Down List",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 16,
"Name": "Type of Event",
"Response": "Party",
"Type": "Drop Down List",
"DataClassification": "University Internal",
"DataDomain": "None"
}
]
},
{
"Name": "Setup Details",
"Elements": [
{
"ID": 10,
"Name": " I'd like to discuss making this a zero-waste event.",
"Response": "",
"Type": "Agreement",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 12,
"Name": "I need to rent tables for this event.",
"Response": "Yes",
"Type": "Yes/No",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 13,
"Name": "List any allergies, dietary restrictions, or other special requests we should know about. ",
"Response": "Linens should also be provided, if possible",
"Type": "Text (long)",
"DataClassification": "University Internal",
"DataDomain": "None"
},
{
"ID": 11,
"Name": "What type of food do you prefer? ",
"Response": null,
"Type": "Drop Down List",
"DataClassification": "University Internal",
"DataDomain": "None"
}
]
}
],
"FormEntryTransactionDetail": {
"PaymentType": "PP",
"Operator": "jdoe",
"Amount": 10,
"Status": "Completed"
}
}
]
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.
Related documents
This is document bgcb in the Knowledge Base.
Last modified on 2023-07-18 11:50:03.