Locations REST API

Locations REST API


The Locations REST API services allow Customers the ability to get Locations information and manage Locations (create, edit, delete) in the Field2Base system.

Base URL

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

Locations Endpoints

locations/     (GET) - Get list of all locations
locations/{locationID}     (GET) - Get details of a single Location
locations/create    (POST) - Create a new location with JSON in body of request
locations/update/{locationID}     (PUT) - Update a Location with JSON in body of request
locations/delete/{locationID}     (DEL) - Delete a Location

Location Requirement Endpoints

locations/requirements     (GET) - Get list of Requirements for all Locations
locations/requirement/{LocationRequirementID}     (GET) - Get Requirements for a single Location
locations/create/requirement     (POST) - Create a new requirement
locations/update/requirement/{LocationRequirementID}     (PUT) - Update an existing requirement
locations/delete/requirement/{LocationRequirementID}     (DEL) - Delete an existing requirement

JSON Definitions


  1.  {
  2.         "LocationID": 6,
  3.         "Name": "F2B Office",
  4.         "Type": "office",
  5.         "ContactName": "ABC",
  6.         "ContactPhone": "123-456-7890",
  7.         "ContactEmail": "fake@email.com",
  8.         "GroupID": 1095,
  9.         "LocationRequirementsAssigned": [
  10.             "Gifts",
  11.             "Mask"
  12.         ]
  13.  }


  1. [
  2.     {
  3.         "LocationRequirementID": 7,
  4.         "Requirement": "Gifts"
  5.     },
  6.     {
  7.         "LocationRequirementID": 8,
  8.         "Requirement": "Mask"
  9.     }
  10. ]

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