Event Stream Documentation

WorkingPatternCreated and WorkingPatternChanged events

The payload for these events contains an array of working pattern revisions, showing the changes to the working pattern over time. The array will only contain the working patterns after and including the one that was changed. The reason for this is that changing working pattern can have an effect on a subsequent working pattern revisions, but it cannot affect previous ones.

A WorkingPatternCreated event will be raised when:

a person is added to their first job

A WorkingPatternChanged event will be raised when:

the working pattern for a person is changed (working pattern can be inherited attributes and therefore changes to the source/inherited values will raise this event)

Field definitions for this event;

Field Name	Data Type	Additional information
occupancyId	guid	n/a
personalReference	string	max-length: 20
jobReference	string	max-length: 20
startDate	date	the start date of the occupancy. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
endDate	date	the end date of the occupancy. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
startDate	date	the start date of the hours and basis revision. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
endDate	date	the end date of the hours and basis revision. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
name	string	max-length: 80
startDayNumber	integer	n/a
numberOfDays	integer	n/a
dayNumber	integer	n/a
totalMinutes	integer	n/a

Example of this event

{
  "occupancyId": "",
  "personalReference": "",
  "jobReference": "",
  "startDate": "",
  "endDate": "",
  "workingPatternRevisions": [{
          "startDate": "",
          "endDate": "",
          "name": "",
          "startDayNumber": "",
          "numberOfDays": [{
            "dayNumber": "",
            "totalMinutes": ""
        }
      ]
    }
  ]
}

WorkingPatternCreated and WorkingPatternChanged events

Looking for something specific?