Introduction 

The document communicates new features, modules, and major changes in the release of Synergy Workforce version 4.2.5 

About this Release 

This release note includes important changes to Synergy API, unlocking access to our data in a standardise and structured way. 

We are in the process of reviewing system performance and enhancing our user experience by adding tooltips and user guides to improve orientation. 

Major Announcements 

Synergy Workforce API V2 - Breaking Changes.

Dear Synergy Workforce User, 

 

If you currently use the Synergy Workforce API to integrate with third-party systems, then please note that we are making changes and introducing a RESTful API in version 4.2.5.  

 

The RESTful API (API v2) is fully documented (click here for details) and extends functionality into exciting new areas that will bring more ways to use data captured by Synergy Workforce. 

 

Please note: If you are a standard user, this will not affect your experience.

 

We will continue to support the current API for a period of 12 months, and we will contact all existing API users in the coming weeks to assist with the transition. 

 

If you would like to speak to us about this in the meantime, then please contact our support team. 

Changes to the API 

A new API V2 was introduced to support pagination in the path parameter.

The API version is visible in the header of the swagger web page; you can control the version by amending the URL at the top of the web page. 

Lock Historical Records

Restrict users from amending historical records.