Skip to main content

Search

Welcome to the Help Centre

API Introduction

  • Updated
The WorkMobileAPI provides programmatic access to the WorkMobile server. It enables
developers to connect their own software to WorkMobile and perform tasks including:

  • Adding mobile users
  • Creating jobs
  • Retrieving form data
 
As a SOAP web service, it can be accessed from a variety of technologies, including .Net and Java.

By navigating to the URL of the WebService you can see the exposed methods

https://www.esayworkmobile.co.uk/wmbapi36/workmobileintegration.asmx
 
 Generically the API works by choosing an action, as specified in the WSDL definition above and then passing in an object to specify which class of object the action should be performed on. A full list of entities/objects that the API can act on is located at 
 

In general the following operations are supported
 
Update (object, security) - you will have retrieved a single object, by using the RetrieveById, or RetrieveAll method and selecting an item from the list. Any amendments will be applied to the properties of the object and the update method will be called to put the system into the new state..
 
Add (object, security) - the object will be fully populated with the parameters required for that object. The id field of the object should be left as the default. Retrieving an object already populated via the UI will assist in understanding the property formats.
 
Delete (Object, security) - A delete method is provided and will respect any system constraints and limitations when trying to perform this action. Generally, creating an instance of a class of object, populating the id property of the item you wish to delete and calling the delete method will invoke the delete functionality.
 
Retrieve<xxxxxxxx>(Object) - A range of methods exist for obtaining data from the system, for both the user captured field data and also the standard entities within the product.
 
For standard entities, the RetrieveAll and RetrieveId methods allow for either the full retrieval of entities, or specific ones. RetrieveAll can be used on these types of objects where the volume count is typical less than 1000 records. 
 
For User data, the retrieve methods differ slightly and for a moderate volume (<1000 individual records in a form) implementation, the retrieveAll method should be avoided. RetrieveNew will deliver any new records extracted prior to the previous call, and is the method that should be employed for batch operations.
 
Important:  It is envisaged that the RetrieveNew method will not be called in excess of once per 60 minutes and is designed for batch activity. For near real-time data integration you should investigate the WebHook style functionality delivered by WorkMobile Notifications