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
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:
- 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.
Append to the Base URL (https://fieldconnect.field2base.com/v2/api)
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
- {
- "TabletUUID": {guid},
- "Serial": {string},
- "FriendlyName": {string},
- "CompanyID": {int},
- "PrimaryUser": {guid},
- "InsertDT": {string},
- "LastUpdate": {string},
- "RowStatus": {string},
- "DevicePlatform": {string},
- "DeviceType": {string},
- "HardwareSerial": {guid},
- "AssetTag": {string},
- "DeviceMake": {string},
- "DeviceModel": {string},
- "PlatformType": {string},
- "ActivationStatus": {int},
- "BillingReference": {string},
- "LastSync": {string},
- "LastContact": {string},
- "Version": {string}
- }
API Samples
Get All Devices (devices)
Request: GET
Get Details of a Single Device
Request: GET
- https://fieldconnect.field2base.com/v2/api/devices/{activation id}
Look Up Device(s) by User
Request: GET
Create a Device with No Activation ID
NOTE: Requires Provisioning by the F2B Support Team and is the recommended method.Request: POST
Body
- {
- "DevicePlatform": "iPad",
- "DeviceMake": "Apple",
- "DeviceModel": "iPad Pro 9.7",
- "DeviceType": "Apple iPad Pro 9.7",
- "HardwareSerial": "123",
- "AssetTag": "F2B",
- "PrimaryUser": "00000000-0000-0000-0000-000000000000", //Must use User Key guid, not Username
- "PlatformType": "Apple iOS",
- "BillingReference": "Small Business",
- "Serial": null
- }
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
- {
- "DevicePlatform": "Android Tablet",
- "DeviceMake": "Samsung",
- "DeviceModel": "Galaxy Tab S4",
- "DeviceType": "Samsung Galaxy Tab S4",
- "HardwareSerial": "456",
- "AssetTag": "Field2Base",
- "PrimaryUser": "00000000-0000-0000-0000-000000000000", //Must use User Key guid, not Username
- "PlatformType": "Android Oreo",
- "BillingReference": "Enterprise",
- "Serial": "123456789"
- }
Response: 200 OK
Change the User Assigned to Device
Request: PUT
- https://fieldconnect.field2base.com/v2/api/devices/changeuser/{activation id}/{username}/
Response: 200 OK
Update a Device
Request: PUT
- https://fieldconnect.field2base.com/v2/api/devices/update/{activation id}
Body
- {
- "DevicePlatform": "iPad",
- "DeviceMake": "Apple",
- "DeviceModel": "iPad Air 2",
- "DeviceType": "Apple iPad Air 2",
- "HardwareSerial": "N/A",
- "AssetTag": "Test",
- "PrimaryUser": "00000000-0000-0000-0000-000000000000",
- "PlatformType": "Apple iOS 13",
- "BillingReference": "TEST"
- }
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
- https://fieldconnect.field2base.com/v2/api/devices/reset/{activation id}
Response: 200 OK
Delete a Device
Request: DEL
- https://fieldconnect.field2base.com/v2/api/devices/delete/{activation id}
Response: 200 OK
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 ...