28th August 2025 Data API Release Notes

1.21.0

Changes

1. User Defined Controls have been added to the People endpoint. The table below lists the new fields in the [GET]/api/People endpoint and where the information is retrieved from in RotaMaster:

RotaMaster Data API RotaMaster
name Personnel > User Defined Controls > Control name
type Personnel > User Defined Controls > Control type e.g. text, check box, date
value Personnel > User Defined Controls > Actual value entered against control

Example schema:

 

2. Shift comments have been added to the View Rota and View Rota/Payrates endpoints. 

Example schema of the [GET]/api/ViewRota endpoint:

Example schema of the [GET]/api/ViewRota/PayRates endpoint:

Where information is retrieved from in RotaMaster:

RotaMaster Data API RotaMaster
comment View Rota > Shift > Comments

 

3. A field to indicate hidden shifts has been added to the [GET]/api/ShiftPatternManager endpoint. 

Example schema:

We have also created parameters to return hidden shifts. If left as null, both active and hidden shifts will be returned. If true, only hidden shifts will be returned. If false, only active shifts will be returned.