Developer Portal Home > Introduction

Product Introduction

Field Force Manager is mobile workforce management application that is delivered as an on-demand application. Field Force Manager allows companies to measure manage and optimize their mobile service organizations through a suite of application functionality. The Field Force Manager suite of web services allows 3rd party software systems to send and retrieve information from the Field Force Manager system.

Integration can be accomplished using a series of different technologies depending upon your needs and existing infrastructure.

Integration can be accomplished in many ways. Depending on whether you need to information returned to you on a five minute interval or only need information on a daily or weekly basis will affect which integration technology you choose. Below are the available technologies and suggested uses.

Overview

Field Force Manager offers a series of web services that allow customers and partners to extend and leverage existing investments in other software and systems by synchronizing and sharing data between the systems.

Authentication

Access to the Field Force Manager web services is provided via a username/password/company id combination of authentication information. This combination of information must be passed on each web service request. The capabilities and access of the requesting user are determined by the web services user specified role and associated security permissions.

The authentication parameters are passed in the http header, this is commonly confused with the SOAP header. The parameters need to be passed with each request.

To view WSDL or connect to web services go to the following URL: https://connectorprod.fieldforcemanager.com/services

You will be prompted to enter your web service user credentials to gain access to the services and WSDL’s. You can create a web service user by logging into the application as an administrator and creating a user with a web service role.

The username for web services will be a combination of the username for the user and the company (username@companyID). For example the username for a user with a username of bob in company 9999 would be bob@9999. The password will be the password for the web service user.

Polling and Usage Restrictions

The Field Force Manager web services system is designed to allow the user to keep their system synchronized with other back office systems. Here are a couple restrictions to keep in mind when querying the system for data.

  • The Field Force Manager system limits web service responses to returning up to 500 items. If you request returns more than 500 items, try limiting the date range or other filter ranges you’re querying for.
  • The Field Force Manager system limits querying for data from a specific web service method to once every five minutes. Web service requests that happen more often are subject to being shut down by Field Force Manager system administrators.
  • The Field Force Manager system is monitored for excessive usage and reserves the right to turn off web service accounts for excessive usage. Customers whose web services accounts are turned off due to excessive usage will be notified of the revoked credentials by Field Force Manager.

Security & Roles

Access to Field Force Manager web services are controlled by the role of the user making the request. Each web service request must contain a valid username and password for the requesting user. If an invalid username and password are provided access to the service is restricted. The default web service role is configured with all web service permissions for the company. The permissions available to roles within a company are controlled by the package or features available to a company or account. The following is a list of all permissions that are available:


Web Services available by package

Service
Limited
Basic
Premium
Company Admin Service
x
x
User Status Service
x
x
Location Service
x
x
Message Service
x
x
Alert Service
x
x
Job Service
x
GPS Service
x


Methods available by service

Web Service
Method
Permission
GpsService-0.0.1
getGpsByWorker
GPS Read
getGps
GPS Read
getGpsbydivision
GPS Read
submitGps
Submit GPS
getStopsandTravel
Stop/Travel Read
getStopsandTravelByWorker
Stop/Travel Read
getStopsAndTravelByDivision
Stop/Travel Read
getStops
Stop/Travel Read
getStopByWorker
Stop/Travel Read
getStopsByDivision
Stop/Travel Read
getTravel
Stop/Travel Read
getTravelByWorker
Stop/Travel Read
getTravelByDivision
Stop/Travel Read
CompanyAdminService-0.0.1
getWorkers
Worker Read
getWorkerByName
Worker Read
getWorkersByName
Worker Read
createCompany
Company Create
createWorker
Worker Create
updateWorker
Worker Update
createOrUpdateWorker
Worker Update
deleteWorker
Worker Delete
createDevice
Device Create
getDevice
Device Read
getDevices
Device Read
updateDevice
Device Update
createOrUpdateDevice
Device Update
deleteDevice
Device Delete
linkDeviceToWorker
Device Link
CompanyAdminService-wrapped-0.0.2
createGroup
Group Create
getGroups
Division Read
createCompany
Company Create
deleteGroups
Group Delete
createDevice
Device Create
getWorkers
Worker Read
getWorkerByName
Worker Read
getWorkersByName
Worker Read
getDevice
Device Read
getDevices
Device Read
deleteDevice
Device Delete
updateDevice
Device Update
createOrUpdateDevice
Device Update
linkDeviceToWorker
Device Link
createWorker
Worker Create
updateWorker
Worker Update
createOrUpdateWorker
Worker Update
deleteWorker
Worker Delete
getDivisions
All Groups or Divisions
updateGroup
Group Update
populateWorkerCustomStatus
Worker Update
MessageService-0.0.1
sendMessage
Send Message
UserStatusService-0.0.1
getTimesheets
Timesheets Read
getTimesheetsByWorkerName
Timesheets Read
submitUserAction
User Action
Create
getTimecardActions
Timesheets Read
getTimecardActionsByWorkerName
Timesheets Read
getUserForms
UserFormsRead
getUserFormsByWorkerName
UserFormsRead
getUserFormsByFormName
UserFormsRead
JobService-0.0.1
createJobs
Job Create
updateJobs
Job Create
createOrUpdateJobs
Job Create and
Job Update
createJob
Job Create
updateJob
Job Create
createOrUpdateJob
Job Create and
Job Update
getJobByReferenceNumber
Job Read
submitJobAction
Submit Job
Action
getJobs
Job Read
getJobsByDivision
Job Update
assignWorkerToJob
Job Update
deleteJob
Job Update
restoreJob
Job Update
terminateJob
Job Update
terminateJobForWorker
Job Update
unassignJob
Job Update
removeWorkerFromJob
Job Update
assignWorkerAndUpdateJob
Job Update
getUpdatedActions
Job Update
getUpdatedActionsByDivision
Job Update
Location Service- 0.0.1
createLocation
Location Create
updateLocation
Location Update
createorUpdateLocation
Location Create
and Location
Update
getLocationsByLocationType
Location Read
Alert Service-0.0.1
getFiredAlerts
Fired Alert Read
getFiredAlertsByWorker
Fired Alert Read
getFiredAlertsByDivision
Fired Alert Read

 

Date & Time Formats

The Field Force Manager web services utilize dates and date ranges to allow the web service user to poll for data over a specified date range. The Field Force Manager web services use GMT/UTC date time zone for the date ranges of all queries. When making a web service request to the Field Force Manager system, the web service will query items that have been created or updated during the date range specified.
The date range queried looks at changes to the Field Force Manager system during that timeframe, meaning that events that may have taken place in the past (GPS, Timecard Actions) which may have been stored and forwarded on a device will have a last updated date time of when they’re received. These events will also have an entry date time that specifies when the event actually took place. The Field Force Manager system allows you to synchronize data using continuous date ranges that are inclusive on the startDate but exclusive on the endDate. When querying over a date range you should use the endDate provide to you as the the startDate for your next query. The endDate returned is the Field Force Manager system time and using it as your start date time will ensure no data is duplicated or missed.

The format of the date/time is as follows:

YYYY-MM-DD HH:MM:SS.MMM

Dates are stored in GMT/UTC so query parameters and returned data will be in this offset and format.

For example February 13, 2006 12:45 PM would be

2006-02-13 12:45:00.000