Groups REST API

Groups REST API

Overview

The Groups REST API allows you to manage Groups (create, edit, delete, assign) for your 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.


Supported Operations

Append to the Base URL:  https://fieldconnect.field2base.com/v2/api
  1. GET groups/
    1. Retrieve a list of all Groups
  2. GET groups/{groupID}
    1. Get details for a single Group
  3. POST groups/create
    1. Create a new Group
  4. PUT groups/update/{groupID}
    1. Update a Group
  5. PUT groups/adduser/{groupID}/{username}
    1. Add a User to a Group
  6. DELETE groups/removeuser/{groupID}/{username}
    1. Remove a User from a Group
  7. DELETE groups/delete/{groupID}
    1. Delete an existing Group
 Note: You will need to add "/" at the end of the call if there is a period in the Username or Group Name.



API Samples

Get List of Groups

Request: GET
  1. https://fieldconnect.field2base.com/v2/api/groups

Get details of one Group

Request: GET
  1. https://fieldconnect.field2base.com/v2/api/groups/{group id}


Create a Group

Request: POST
  1. https://fieldconnect.field2base.com/v2/api/groups/create
Body
  1. {
  2.       "Name": "TEST GROUP",
  3.       "Users": ["00000000-0000-0000-0000-000000000000"]
  4. }


Update a Group (change group name and/or list of users)

Request: PUT
  1.  https://fieldconnect.field2base.com/v2/api/groups/update/100
Body
  1. {
  2.       "GroupId": 100,
  3.       "Name": "TEST GROUP",
  4.       "Users": ["00000000-0000-0000-0000-000000000000",
  5.       "00000000-0000-0000-0000-000000000001"]
  6. }


Add a User to a Group

Request: PUT
  1. https://fieldconnect.field2base.com/v2/api/groups/adduser/123/{username}/


Remove a User from a Group

Request: DELETE
  1. https://fieldconnect.field2base.com/v2/api/groups/removeuser/123/{username}/


Delete a Group

Request: DELETE
  1. https://fieldconnect.field2base.com/v2/api/groups/delete/{group id}