Overview
The Sent Forms REST API allows Customers the ability to manage Sent Forms for their Company.
Note: Authorization Header above is the same as all other F2B REST API calls.
F2B API Prerequisites
To use the Sent Forms REST API, you need the following:
- An API Sync Key for the Company
- A User Account with the ability to submit to the API (Mobile Forms Administrator role)
Supported Operations
The following operations are supported by the REST web service.
Endpoint
|
Method
|
Description
|
onlinedocs/getsentforms
|
POST
|
Get a list of Sent Forms for a Form Template ID
Additional parameters are available
|
onlinedocs/sentforms/{resource ID}/PDF
|
GET
|
Retrieves a rendered PDF of a Sent Form
|
API Samples
Request: POST
Body
- {
- "templateId": "e8bac552-3486-47ff-87ed-6cfaf3c1c0fb",
- "searchLimit":1 // 1 is currently the only value supported
- }
Body with Optional Parameters
- {
- "templateId": "e8bac552-3486-47ff-87ed-6cfaf3c1c0fb",
- "allUsers": "true", // defaults to false, true will only return a sent form from the logged in user
- "searchLimit":1, // 1 is currently the only value supported
- "includeUnreleased": "true", //default is false
- "minTimestamp": "2021-02-01T00:00:00-05:00",
- "maxTimestamp": "2021-02-15T00:00:00-05:00",
- "data": [
- ["Page1@FirstName","equals","Joe"], //search types include: equals, startswith, endswith, contains
- ["Page1@LastName","contains","Schmoe"]
- ]
- }
Note: In order to use the "data" filtering option, Region Filters must first be created for the Form Template in the Portal (Admin > Form Templates > Region Filters) to capture the data. See the article on
Region Filters for details on how to create regions filters for a Form.
Currently, region filters are limited to 3 per form.
Response: 200 OK
- [
- {
- "ResourceId": "70599f64-d119-4a93-aea1-84622ccaa654",
- "FriendlyName": "Sample Timesheet - Job#: 15-201 - Supervisor 2 - Week Ending: 2/18/2021",
- "RefNum": 17150934,
- "RfiTimestamp": "2021-02-18T12:40:44.813",
- "WorkflowStatus": null,
- "IsClaimable": false
- }
- ]
Request: GET
Response:
PDF is returned as data in the contents of the body of the response with a content disposition of “inline”
Popular Articles
Forms Designer Quick Start Guide
Overview Field2Base Forms Designer is the proprietary software application that allows your existing Forms to be quickly converted to an active, online, smart Form available to your end users via our Mobile Device and Web-based Applications. This ...
Integration Service Configuration Guide
How To Configure Integration Services To Allow Read/Write Access on a Network Path All of our Integration Products, including the DIM, DUU, and EDM have respective Windows Services responsible for communicating with our server. Occassionally, ...
Data Integration Module (DIM) Migration Guide
Overview This article provides the information necessary to migrate the Field2Base Data Integration Module (DIM) over from one server to another. Please refer to the DIM Install Guide for the initial installation of the Field2Base DIM. Once that's ...
Mobile Forms iOS Enterprise App Upgrade to the Mobile Forms iOS App Store
Overview This guide will review how to switch between two versions of the Mobile Forms app, uninstalling the Enterprise build and installing the App Store Build. The primary benefits of switching over are that updates to the App Store build are ...
How to Check the Version of Integration Products Running on a Windows 10 Machine
Right-click on the Start menu button. Click on Apps & Features. In the Apps & Features search bar type in the Integration Product you are looking for, eg. F2B Data Integration Module, F2B Data Upload, or F2B Enterprise Dispatch Module. Click to ...