Devices REST API

Devices REST API

Overview

The Devices REST API services allow Customers the ability to get Device information and directly manage Devices (create, edit, delete, assign, reset) in 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
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 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
devices/
 GET
 Lists of all Devices
devices/{activation id}
 GET
 Get Details of a single Device
devices/lookup/{username}
 GET
 Look up all Devices assigned to a User (by Username)
devices/create
 POST
 Create a new Device using the Body of a post request as JSON
devices/update/{activation id}
 PUT
 Updates a Device using the Activation ID and the Body of a post request as JSON
devices/changeuser/{activation id}/{username}
 PUT
 Changes the Device's Assigned User (by Username)
devices/reset/{activation id}
 PUT
 Resets the history for a Device to allow re-activation
devices/delete/{activation id}
 DEL
 Deletes an existing Device
Note: Be sure to add "/" at the end of the call if there is a period in the Username. 


JSON Definition

  1. {
  2.         "TabletUUID": {guid},
  3.         "Serial": {string},
  4.         "FriendlyName": {string},
  5.         "CompanyID": {int},
  6.         "PrimaryUser": {guid},
  7.         "InsertDT": {string},
  8.         "LastUpdate": {string},
  9.         "RowStatus": {string},
  10.         "DevicePlatform": {string},
  11.         "DeviceType": {string},
  12.         "HardwareSerial": {guid},
  13.         "AssetTag": {string},
  14.         "DeviceMake": {string},
  15.         "DeviceModel": {string},
  16.         "PlatformType": {string},
  17.         "ActivationStatus": {int},
  18.         "BillingReference": {string}, 
  19.         "LastSync": {string},
  20.         "LastContact": {string},
  21.         "Version": {string}
  22. }

API Samples

Get All Devices (devices)

Request: GET

Get Details of a Single Device

Request: GET


Look Up Device(s) by User 


Create a Device with No Activation ID 

NOTE: Requires Provisioning by the F2B Support Team and is the recommended method.

Request: POST

  1. https://fieldconnect.field2base.com/v2/api/devices/create
Body
  1. {
  2.       "DevicePlatform": "iPad",
  3.       "DeviceMake": "Apple",
  4.       "DeviceModel": "iPad Pro 9.7",
  5.       "DeviceType": "Apple iPad Pro 9.7",
  6.       "HardwareSerial": "123",
  7.       "AssetTag": "F2B",
  8.       "PrimaryUser": "00000000-0000-0000-0000-000000000000",      //Must use User Key guid, not Username
  9.       "PlatformType": "Apple iOS",
  10.       "BillingReference": "Small Business",
  11.       "Serial": null
  12. }

Response: 200 OK


Create a Device with an Activation ID

NOTE: Requires a system-wide unique Activation ID to be used in the Serial value in the JSON Body otherwise the request will fail. For this reason, the previous method is recommended.
Request: POST

Body

  1. {
  2.       "DevicePlatform": "Android Tablet",
  3.       "DeviceMake": "Samsung",
  4.       "DeviceModel": "Galaxy Tab S4",
  5.       "DeviceType": "Samsung Galaxy Tab S4",
  6.       "HardwareSerial": "456",
  7.       "AssetTag": "Field2Base",
  8.       "PrimaryUser": "00000000-0000-0000-0000-000000000000",      //Must use User Key guid, not Username
  9.       "PlatformType": "Android Oreo",
  10.       "BillingReference": "Enterprise",
  11.       "Serial": "123456789"
  12. }

Response: 200 OK


Change the User Assigned to Device

Request: PUT

Response: 200 OK


Update a Device

Request: PUT
  1. https://fieldconnect.field2base.com/v2/api/devices/update/{activation id}
Body
  1. {
  2.       "DevicePlatform": "iPad",
  3.       "DeviceMake": "Apple",
  4.       "DeviceModel": "iPad Air 2",
  5.       "DeviceType": "Apple iPad Air 2",
  6.       "HardwareSerial": "N/A",
  7.       "AssetTag": "Test",
  8.       "PrimaryUser": "00000000-0000-0000-0000-000000000000",
  9.       "PlatformType": "Apple iOS 13",
  10.       "BillingReference": "TEST"
  11. }

Response: 200 OK


Reset a Device's Activation History 

This action is to be used with the Mobile Forms Enterprise App Build only.

Request: PUT

Response: 200 OK


Delete a Device 

Request: DEL
Response: 200 OK

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