Data API 3rd May 2022 Release Notes

IMPORTANT: We have depreciated the following endpoints – these will likely be removed in the upcoming months and replaced with the ones listed below. Please update any script or app that you have that uses these – if you have used our Data API Script Generator to create your python script and are on i98 or later of Rotamaster, you can reuse it to create a new script with the correct endpoints. 

We have added a new field to the People endpoint of 'WTD Inclusion' - this field will tell you whether the staff member has opted in or out of Working Time Directive.

We have added a number of new fields to the ViewRota endpoint of:

• Contract code
• DutyStationID
• ShiftGroupID
• TeamID
• AllocationMethodID
• PersonPostContractID
• ShiftCategoryID
• DependentCount
• SeatID
• isLocumSession,
• HasShiftAdjustment

We have added a new field to the  PayRateGroup endpoint of 'Hourly Pay Rate Reference'

We have updated the schema of the PayRateGroup endpoint to the following:

 "payRateGroupID": 0,
    "name": "string",
    "payRateReference": "string",
    "linkedPayRateGroupDates": [
      {
        "payRateGroupDateId": 0,
        "payStartDate": "2022-04-28T10:47:39.999Z",
        "payEndDate": "2022-04-28T10:47:39.999Z",
        "defaultRate": 0,
        "defaultPayElementCode": "string",
        "linkedPayRateGroupZones": [
          {
            "payRateGroupZoneID": 0,
            "zoneID": 0,
            "zoneName": "string",
            "rate": 0,
            "startTime": "string",
            "endTime": "string",
            "payElementCode": "string",
            "hourlyPayRateReference": "string"

This will help make clearer which rates sit within which Pay Rate Group. If you use the numberOfRecords parameter to limit how much data is returned, this will now restrict how many Pay Rate Groups are returned. Previously, it would restrict how many pay rates were returned.