Sent Forms REST API

Sent Forms REST API

Overview

The Sent Forms REST API allows Customers the ability to manage Sent Forms for their Company.

Base URL 
https://fieldconnect.field2base.com/v2/api

Header (required)
Authorization: Basic {CompanyID}:{Username}:{Password}:{API Sync Key}
Content-Type: application/json
Note: Authorization Header above is the same as all other Mobile Forms REST API calls. 
Note: API Developers can use OAuth 2.0 Authentication instead of the Basic Authentication. The OAuth 2.0 Authentication uses the Client Credentials Grant Type and requires the Company have a Client ID and a Client Secret generated in the Mobile Forms Portal to make web service calls to the REST API Endpoints. You can contact the Professional Services team at f2bps@field2base.com to implement OAuth 2.0 Authentication.

F2B API Prerequisites

To use the Sent Forms REST API, you need the following:
  1. An API Sync Key  for the Company
  2. 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.
Append to the base URL ( https://fieldconnect.field2base.com/v2/api )

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  

Get Sent Forms

Request: POST
Body
  1. {
  2.     "templateId": "e8bac552-3486-47ff-87ed-6cfaf3c1c0fb",
  3.     "searchLimit":1 // must be at least 1
  4. }
Body with Optional Parameters
  1. {
  2.     "templateId": "e8bac552-3486-47ff-87ed-6cfaf3c1c0fb",
  3.     "allUsers": "true",     // defaults to false, true will only return a sent form from the logged in user
  4.     "searchLimit":1,      //must be at least 1
  5.     "includeUnreleased": "true",     //default is false
  6.     "minTimestamp": "2021-02-01T00:00:00-05:00",
  7.     "maxTimestamp": "2021-02-15T00:00:00-05:00",
  8.     "data": [
  9.         ["Page1@FirstName","equals","Joe"],     //search types include: equals, startswith, endswith, contains
  10.         ["Page1@LastName","contains","Schmoe"]
  11.     ]
  12. }
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 5 per form. 

Response: 200 OK
  1. [
  2.     {
  3.         "ResourceId": "70599f64-d119-4a93-aea1-84622ccaa654",
  4.         "FriendlyName": "Sample Timesheet - Job#: 15-201 - Supervisor 2 - Week Ending: 2/18/2021",
  5.         "RefNum": 17150934,
  6.         "RfiTimestamp": "2021-02-18T12:40:44.813",
  7.         "WorkflowStatus": null,
  8.         "IsClaimable": false
  9.     }
  10. ]

Get Sent Form PDF

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 paper forms to be quickly converted to a smart E-form available to your end users via our mobile and web-based Mobile Forms 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 ...

    • 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 ...

    • Mobile Forms Android Enterprise App Upgrade to the Mobile Forms Play Store App

      Overview This guide covers how to upgrade from the Enterprise build to the App Store Build of the Mobile Forms app. The primary benefits of switching over are that updates to the App Store build are streamlined and easier to install and that the App ...