Event Stream Documentation

EmploymentPeriodStartDateChanged event

The payload for this event contains the Person id and reference number of the person whose employment start date has been changed and the revised start date.

An EmploymentPeriodStartDateChanged event will be raised when:

The Employment start date of an employee is modified

Field definitions for this event;

Field Name	Data Type	Additional information
personId	guid	n/a
personalReferenceNumber	string	max-length: 20
employmentStartDate	date	the revised start date of the person's Employment Period. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
employmentPeriodId	guid	the identify of the employment period

Example of this event

{
          "personId": "",
          "personalReferenceNumber": "",
          "employmentStartDate": ""
          "employmentPeriodId": ""
          }

EmploymentPeriodCreated, EmploymentPeriodEnded and EmploymentPeriodReinstated event

An EmploymentPeriodCreated event will be raised when:

an employment period is created in hrm (currently in people first, this automatically happens when a person is created)

An EmploymentPeriodEnded event will be raised when:

a person is made a leaver (this effectively occurs when and end date is added to an employment period)

An EmploymentPeriodReinstated event will be raised when:

the action of making a person a leaver action is reverted (this effectively occurs when the end date is removed from an employment period)

Field definitions for this event;

Field Name	Data Type	Additional information
personId	guid	n/a
personalReference	string	max-length: 20
startDate	date	The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
endDate	date	The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
employerName	string	80
isExitInterviewCompleted	boolean	n/a
lastPaymentDate	date	The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
lastWorkingDate	date	The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
reEmployable	string	max-length: 80
reEmployableCode	string	max-length: 40; reference-data
reasonForLeaving	string	max-length: 80
reasonForLeavingCode	string	max-length: 40; reference-data
forwardingAddressType	string	max-length: 80
forwardingAddressTypeCode	string	max-length: 40; reference-data
line1	string	max-length: 80
line2	string	max-length: 80
line3	string	max-length: 80
line4	string	max-length: 80
line5	string	max-length: 80
line6	string	max-length: 80

Example of this event

{
  "personId": "",
  "personalReference": "",
  "startDate": "",
  "endDate": "",
  "employerName": "",
  "isExitInterviewCompleted": "",
  "lastPaymentDate": "",
  "lastWorkingDate": "",
  "reEmployable": "",
  "reEmployableCode": "",
  "reasonForLeaving": "",
  "reasonForLeavingCode": "",
  "forwardingAddressType": "",
  "forwardingAddressTypeCode": "",
  "forwardingAddress": ""{
    "line1": "",
    "line2": "",
    "line3": "",
    "line4": "",
    "line5": "",
    "line6": ""
  }
}

EmploymentPeriodStartDateChanged event

EmploymentPeriodCreated, EmploymentPeriodEnded and EmploymentPeriodReinstated event

Looking for something specific?