Forms and Regions REST API

Forms and Regions REST API

Overview

The Forms and Regions REST API services allow Customers the ability to get Form and Form Template information from the Field2Base system.

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

Header (Required)
Authorization: Basic {CompanyID}:{Username}:{Password}:{API Sync Key}
Content-Type: application/json
Authorization Header above is the standard for all F2B REST API calls.


F2B API Prerequisites

To use the Devices 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.

Devices

Endpoint
Method
Description
forms/
GET
get collection of form templates in company
forms/{folderKey}
GET
get collection of form templates in a given folder (folderKey = projectKey/ProjKey)
forms/regions/{formTemplateID}
GET
get collection of regions in a given form template
forms/region/options/{formTemplateID}/{DataSourceName guid}
GET
get possible datasource options
forms/region/options/{formTemplateID}/{DataSourceName guid}?parameters={parameter option}
GET
get results of executing a given datasource in a given form template if datasource uses parameters
Note: Be sure to add "/" at the end of the call if there is a period in the Username. 


API Samples

Endpoint: forms/
Method: GET

Response:
  1. [   
  2.     {
  3.         "TemplateId": "1dd66dcf-2ab2-40b0-8241-98bfdf5a6d84",
  4.         "Name": "Inspection Sheet",
  5.         "ProjKey": "ed02146a-2ca7-4ce7-980f-7f840ba3f568",
  6.         "ProjName": "Sandbox (Ceara)",
  7.         "Version": 27,
  8.         "Description": "for home inspections"
  9.     },
  10.     {
  11.         "TemplateId": "ba056acd-75f7-45b1-b5ab-1937aab8e411",
  12.         "Name": "DVIR",
  13.         "ProjKey": "3fec86e5-7069-41e4-966e-b3ad96ed1f8e",
  14.         "ProjName": "Sandbox (Nick)",
  15.         "Version": 1,
  16.         "Description": ""
  17.     },
  18.     {
  19.         "TemplateId": "1d5f3b89-ae47-4d1d-afae-5f6d5d9d233f",
  20.         "Name": "F2B Statement of Work",
  21.         "ProjKey": "0f4300b6-9548-4e7a-85d9-c53122626010",
  22.         "ProjName": "Contracts",
  23.         "Version": 4,
  24.         "Description": ""
  25.     },
  26.     {
  27.         "TemplateId": "2d1dfad1-9ae4-4990-a3e8-ba86bdb07b1f",
  28.         "Name": "Sample Expense Report",
  29.         "ProjKey": "1be2fd67-9c0b-40ba-a440-40a9c6fe0589",
  30.         "ProjName": "Form Library",
  31.         "Version": 23,
  32.         "Description": ""
  33.     },
  34.     {
  35.         "TemplateId": "e8bac552-3486-47ff-87ed-6cfaf3c1c0fb",
  36.         "Name": "Sample Timesheet",
  37.         "ProjKey": "1be2fd67-9c0b-40ba-a440-40a9c6fe0589",
  38.         "ProjName": "Form Library",
  39.         "Version": 2,
  40.         "Description": ""
  41.     }
  42. ]

Endpoint: forms/{folderKey (aka ProjKey)}
Method: GET
Example: forms/1be2fd67-9c0b-40ba-a440-40a9c6fe0589

Response:
  1. [
  2.     {
  3.         "TemplateId": "2d1dfad1-9ae4-4990-a3e8-ba86bdb07b1f",
  4.         "Name": "Sample Expense Report",
  5.         "ProjKey": "1be2fd67-9c0b-40ba-a440-40a9c6fe0589",
  6.         "ProjName": "Form Library",
  7.         "Version": 23.
  8.         "Description": "for work expenses, has a workflow for approval then send to Payroll"
  9.     },
  10.     {
  11.         "TemplateId": "e8bac552-3486-47ff-87ed-6cfaf3c1c0fb",
  12.         "Name": "Sample Timesheet",
  13.         "ProjKey": "1be2fd67-9c0b-40ba-a440-40a9c6fe0589",
  14.         "ProjName": "Form Library",
  15.         "Version": 2,
  16.         "Description": ""
  17.     },
  18.     {
  19.         "TemplateId": "e0646cf6-db54-4b59-86aa-ba4953f052b9",
  20.         "Name": "Sample Work Order for Phone",
  21.         "ProjKey": "1be2fd67-9c0b-40ba-a440-40a9c6fe0589",
  22.         "ProjName": "Form Library",
  23.         "Version": 5,
  24.         "Description": ""
  25.     }
  26. ]



Endpoint: forms/regions/{formTemplateID}
Method: GET
Example: forms/regions/2d1dfad1-9ae4-4990-a3e8-ba86bdb07b1f

Response:
  1. [
  2.     {
  3.         "Number": 1,
  4.         "Name": "PageName1",
  5.         "Description": "",
  6.         "Title": "Page 1 Regions",
  7.         "Regions": [
  8.             {
  9.                 "FullName": "Page1@ApprovalSignDate",
  10.                 "DisplayName": "ApprovalSignDate",
  11.                 "Type": "Label",
  12.                 "DefaultValue": "",
  13.                 "DateTimeFormat": null,
  14.                 "Options": null,
  15.                 "MaxTextLength": null,
  16.                 "MinDateValue": null,
  17.                 "MaxDateValue": null,
  18.                 "IsRequired": false,
  19.                 "DecimalPlaces": null,
  20.                 "MaxNumericValue": null,
  21.                 "MinNumericValue": null,
  22.                 "Formula": "",
  23.                 "UserCanOverride": false,
  24.                 "UserCanEdit": true,
  25.                 "ToolTip": "",
  26.                 "DataSourceName": "",
  27.                 "DataSourceParameters": []
  28.             },
  29.             {
  30.                 "FullName": "Page1@ApprovedBy",
  31.                 "DisplayName": "ApprovedBy",
  32.                 "Type": "Text",
  33.                 "DefaultValue": "",
  34.                 "DateTimeFormat": null,
  35.                 "Options": null,
  36.                 "MaxTextLength": null,
  37.                 "MinDateValue": null,
  38.                 "MaxDateValue": null,
  39.                 "IsRequired": true,
  40.                 "DecimalPlaces": null,
  41.                 "MaxNumericValue": null,
  42.                 "MinNumericValue": null,
  43.                 "Formula": "",
  44.                 "UserCanOverride": false,
  45.                 "UserCanEdit": true,
  46.                 "ToolTip": "",
  47.                 "DataSourceName": "",
  48.                 "DataSourceParameters": []
  49.             },
  50.             {
  51.                 "FullName": "Page1@EmployeeName",
  52.                 "DisplayName": "EmployeeName",
  53.                 "Type": "Text",
  54.                 "DefaultValue": "",
  55.                 "DateTimeFormat": null,
  56.                 "Options": null,
  57.                 "MaxTextLength": null,
  58.                 "MinDateValue": null,
  59.                 "MaxDateValue": null,
  60.                 "IsRequired": true,
  61.                 "DecimalPlaces": null,
  62.                 "MaxNumericValue": null,
  63.                 "MinNumericValue": null,
  64.                 "Formula": "",
  65.                 "UserCanOverride": false,
  66.                 "UserCanEdit": true,
  67.                 "ToolTip": "",
  68.                 "DataSourceName": "",
  69.                 "DataSourceParameters": []
  70.             },
  71.             {
  72.                 "FullName": "Page1@EmployeeSignDate",
  73.                 "DisplayName": "EmployeeSignDate",
  74.                 "Type": "Label",
  75.                 "DefaultValue": "",
  76.                 "DateTimeFormat": null,
  77.                 "Options": null,
  78.                 "MaxTextLength": null,
  79.                 "MinDateValue": null,
  80.                 "MaxDateValue": null,
  81.                 "IsRequired": false,
  82.                 "DecimalPlaces": null,
  83.                 "MaxNumericValue": null,
  84.                 "MinNumericValue": null,
  85.                 "Formula": "",
  86.                 "UserCanOverride": false,
  87.                 "UserCanEdit": true,
  88.                 "ToolTip": "",
  89.                 "DataSourceName": "",
  90.                 "DataSourceParameters": []
  91.             },
  92.             {
  93.                 "FullName": "Page1@EndDate",
  94.                 "DisplayName": "EndDate",
  95.                 "Type": "Date",
  96.                 "DefaultValue": "",
  97.                 "DateTimeFormat": "M/d/yyyy",
  98.                 "Options": null,
  99.                 "MaxTextLength": null,
  100.                 "MinDateValue": "0002-01-01T00:00:00",
  101.                 "MaxDateValue": "9998-12-31T23:59:59.999",
  102.                 "IsRequired": true,
  103.                 "DecimalPlaces": null,
  104.                 "MaxNumericValue": null,
  105.                 "MinNumericValue": null,
  106.                 "Formula": "",
  107.                 "UserCanOverride": false,
  108.                 "UserCanEdit": true,
  109.                 "ToolTip": "",
  110.                 "DataSourceName": "",
  111.                 "DataSourceParameters": []
  112.             },
  113.             {
  114.                 "FullName": "Page1@MileageRate",
  115.                 "DisplayName": "MileageRate",
  116.                 "Type": "Numeric",
  117.                 "DefaultValue": "",
  118.                 "DateTimeFormat": null,
  119.                 "Options": null,
  120.                 "MaxTextLength": null,
  121.                 "MinDateValue": null,
  122.                 "MaxDateValue": null,
  123.                 "IsRequired": false,
  124.                 "DecimalPlaces": null,
  125.                 "MaxNumericValue": null,
  126.                 "MinNumericValue": null,
  127.                 "Formula": "",
  128.                 "UserCanOverride": false,
  129.                 "UserCanEdit": true,
  130.                 "ToolTip": "",
  131.                 "DataSourceName": "",
  132.                 "DataSourceParameters": []
  133.             },
  134.             {
  135.                 "FullName": "Page1@ReportTitle",
  136.                 "DisplayName": "ReportTitle",
  137.                 "Type": "Text",
  138.                 "DefaultValue": "",
  139.                 "DateTimeFormat": null,
  140.                 "Options": null,
  141.                 "MaxTextLength": null,
  142.                 "MinDateValue": null,
  143.                 "MaxDateValue": null,
  144.                 "IsRequired": true,
  145.                 "DecimalPlaces": null,
  146.                 "MaxNumericValue": null,
  147.                 "MinNumericValue": null,
  148.                 "Formula": "",
  149.                 "UserCanOverride": false,
  150.                 "UserCanEdit": true,
  151.                 "ToolTip": "",
  152.                 "DataSourceName": "",
  153.                 "DataSourceParameters": []
  154.             },
  155.             {
  156.                 "FullName": "Page1@StartDate",
  157.                 "DisplayName": "StartDate",
  158.                 "Type": "Date",
  159.                 "DefaultValue": "",
  160.                 "DateTimeFormat": "M/d/yyyy",
  161.                 "Options": null,
  162.                 "MaxTextLength": null,
  163.                 "MinDateValue": "0002-01-01T00:00:00",
  164.                 "MaxDateValue": "9998-12-31T23:59:59.999",
  165.                 "IsRequired": true,
  166.                 "DecimalPlaces": null,
  167.                 "MaxNumericValue": null,
  168.                 "MinNumericValue": null,
  169.                 "Formula": "",
  170.                 "UserCanOverride": false,
  171.                 "UserCanEdit": true,
  172.                 "ToolTip": "",
  173.                 "DataSourceName": "",
  174.                 "DataSourceParameters": []
  175.             }
  176.         ]
  177.     },
  178.     {
  179.         "Number": 2,
  180.         "Name": "Page2",
  181.         "Description": "",
  182.         "Title": "Page 2 Regions",
  183.         "Regions": [
  184.             {
  185.                 "FullName": "Page2@ExpenseCategory1",
  186.                 "DisplayName": "ExpenseCategory1",
  187.                 "Type": "Datasource",
  188.                 "DefaultValue": "",
  189.                 "DateTimeFormat": null,
  190.                 "Options": [
  191.                     "Airfare",
  192.                     "Hotel",
  193.                     "Meals",
  194.                     "Rental Car",
  195.                     "Transit / Ride Share",
  196.                     "Personal Vehicle",
  197.                     "Phone Bill"
  198.                 ],
  199.                 "MaxTextLength": null,
  200.                 "MinDateValue": null,
  201.                 "MaxDateValue": null,
  202.                 "IsRequired": false,
  203.                 "DecimalPlaces": null,
  204.                 "MaxNumericValue": null,
  205.                 "MinNumericValue": null,
  206.                 "Formula": "",
  207.                 "UserCanOverride": false,
  208.                 "UserCanEdit": true,
  209.                 "ToolTip": "",
  210.                 "DataSourceName": "7e9a57a3-dba3-41e0-aa43-ea38e3bc8827",
  211.                 "DataSourceParameters": []
  212.             },
  213.             {
  214.                 "FullName": "Page2@ExpenseComments1",
  215.                 "DisplayName": "ExpenseComments1",
  216.                 "Type": "Text",
  217.                 "DefaultValue": "",
  218.                 "DateTimeFormat": null,
  219.                 "Options": null,
  220.                 "MaxTextLength": null,
  221.                 "MinDateValue": null,
  222.                 "MaxDateValue": null,
  223.                 "IsRequired": false,
  224.                 "DecimalPlaces": null,
  225.                 "MaxNumericValue": null,
  226.                 "MinNumericValue": null,
  227.                 "Formula": "",
  228.                 "UserCanOverride": false,
  229.                 "UserCanEdit": true,
  230.                 "ToolTip": "",
  231.                 "DataSourceName": "",
  232.                 "DataSourceParameters": []
  233.             },
  234.             {
  235.                 "FullName": "Page2@ExpenseDate1",
  236.                 "DisplayName": "ExpenseDate1",
  237.                 "Type": "Date",
  238.                 "DefaultValue": "",
  239.                 "DateTimeFormat": "M/d/yyyy",
  240.                 "Options": null,
  241.                 "MaxTextLength": null,
  242.                 "MinDateValue": "0002-01-01T00:00:00",
  243.                 "MaxDateValue": "9998-12-31T23:59:59.999",
  244.                 "IsRequired": false,
  245.                 "DecimalPlaces": null,
  246.                 "MaxNumericValue": null,
  247.                 "MinNumericValue": null,
  248.                 "Formula": "",
  249.                 "UserCanOverride": false,
  250.                 "UserCanEdit": true,
  251.                 "ToolTip": "",
  252.                 "DataSourceName": "",
  253.                 "DataSourceParameters": []
  254.             },
  255.             {
  256.                 "FullName": "Page2@ExpensePhoto1",
  257.                 "DisplayName": "ExpensePhoto1",
  258.                 "Type": "Camera",
  259.                 "DefaultValue": "",
  260.                 "DateTimeFormat": null,
  261.                 "Options": null,
  262.                 "MaxTextLength": null,
  263.                 "MinDateValue": null,
  264.                 "MaxDateValue": null,
  265.                 "IsRequired": false,
  266.                 "DecimalPlaces": null,
  267.                 "MaxNumericValue": null,
  268.                 "MinNumericValue": null,
  269.                 "Formula": "",
  270.                 "UserCanOverride": false,
  271.                 "UserCanEdit": true,
  272.                 "ToolTip": "",
  273.                 "DataSourceName": "",
  274.                 "DataSourceParameters": []
  275.             },
  276.             {
  277.                 "FullName": "Page2@ExpenseTotal1",
  278.                 "DisplayName": "ExpenseTotal1",
  279.                 "Type": "Numeric",
  280.                 "DefaultValue": "",
  281.                 "DateTimeFormat": null,
  282.                 "Options": null,
  283.                 "MaxTextLength": null,
  284.                 "MinDateValue": null,
  285.                 "MaxDateValue": null,
  286.                 "IsRequired": false,
  287.                 "DecimalPlaces": 2,
  288.                 "MaxNumericValue": null,
  289.                 "MinNumericValue": null,
  290.                 "Formula": "",
  291.                 "UserCanOverride": false,
  292.                 "UserCanEdit": true,
  293.                 "ToolTip": "",
  294.                 "DataSourceName": "",
  295.                 "DataSourceParameters": []
  296.             },
  297.             {
  298.                 "FullName": "Page2@MilesDriven1",
  299.                 "DisplayName": "MilesDriven1",
  300.                 "Type": "Numeric",
  301.                 "DefaultValue": "",
  302.                 "DateTimeFormat": null,
  303.                 "Options": null,
  304.                 "MaxTextLength": null,
  305.                 "MinDateValue": null,
  306.                 "MaxDateValue": null,
  307.                 "IsRequired": false,
  308.                 "DecimalPlaces": null,
  309.                 "MaxNumericValue": null,
  310.                 "MinNumericValue": null,
  311.                 "Formula": "",
  312.                 "UserCanOverride": false,
  313.                 "UserCanEdit": true,
  314.                 "ToolTip": "Mileage rate is automatically calculated at .58 per mile",
  315.                 "DataSourceName": "",
  316.                 "DataSourceParameters": []
  317.             },
  318.             {
  319.                 "FullName": "Page2@NoReceipt1",
  320.                 "DisplayName": "NoReceipt1",
  321.                 "Type": "Checkbox",
  322.                 "DefaultValue": "",
  323.                 "DateTimeFormat": null,
  324.                 "Options": null,
  325.                 "MaxTextLength": null,
  326.                 "MinDateValue": null,
  327.                 "MaxDateValue": null,
  328.                 "IsRequired": false,
  329.                 "DecimalPlaces": null,
  330.                 "MaxNumericValue": null,
  331.                 "MinNumericValue": null,
  332.                 "Formula": "",
  333.                 "UserCanOverride": false,
  334.                 "UserCanEdit": true,
  335.                 "ToolTip": "",
  336.                 "DataSourceName": "",
  337.                 "DataSourceParameters": []
  338.             }
  339.         ]
  340.     }
  341. ]



Endpoint: forms/region/options/{formTemplateID}/{DataSourceName}
Method: GET
Example: forms/region/options/2d1dfad1-9ae4-4990-a3e8-ba86bdb07b1f/7e9a57a3-dba3-41e0-aa43-ea38e3bc8827

Response:
  1. [
  2.     "Airfare",
  3.     "Hotel",
  4.     "Meals",
  5.     "Rental Car",
  6.     "Transit / Ride Share",
  7.     "Personal Vehicle",
  8.     "Phone Bill"
  9. ]


Endpoint: forms/region/options/{formTemplateID}/{DataSourceName}?parameters={parameter option}
Method: GET

This example assumes that we are using two regions, with Region 1 as a parameter for the Region 2 query. For this example, we will assume that the corresponding datafile contains an ExpenseCategory "Airfare" with a corresponding Rate of "$100".

Region 1: {
                      FullName: "Page2@ExpenseCategory1",              
                      Type: "Datasource",
                      DataSourceName: "7e9a57a3-dba3-41e0-aa43-ea38e3bc8827"
                 }

Region 2: {
                      FullName: "Page2@Rate1",              
                      Type: "Datasource",
                      DataSourceName: "1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                      DataSourceParameters: [
                              "{Page2@ExpenseCategory1}"
                      ]
                 }

Region 2 SQL Query: 
                  SELECT [Rate]
                  FROM [SheetName$]
                  WHERE [ExpenseCategory] = ?

                  Parameters: {Page2@ExpenseCategory1}

Example: forms/region/options/2d1dfad1-9ae4-4990-a3e8-ba86bdb07b1f/1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx?parameters=Airfare
Response:
  1. {
  2.       "$100"
  3. }

Note: If you are using multiple parameters in a query, use the endpoint format: forms/region/options/{formTemplateID}/{DataSourceName}?parameters={parameter option}&parameters={parameter option}


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