Image
abstract swish line in gradient colouring from pink to blue on a dark blue background

Event stream documentation

AbsenceLeaveCreated, AbsenceSicknessCreated, and AbsenceOtherCreated events

An AbsenceLeaveCreated, AbsenceSicknessCreated or AbsenceOtherCreated event will be raised when:

  • a leave|sickness|other absence is created for a person

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidUnique Person Identifier
personalReferencestringmax-length: 20
occupancyIdguidUnique Occupancy Identifier
jobReferencestringmax-length: 20
absenceIdguidUnique Absence Identifier
absenceTypeCodestringmax-length: 40; reference-data
absenceTypeNamestringmax-length: 80; reference-data
absenceCategoryCodestringmax-length: 40; Indicator of category the absence type is allocated to (i.e. Leave, Sickness, Family or Other)
startDatedateThe start date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
startDatePartCodestringmax-length: 40; reference-data
startDateTotalMinutesintegerDuration of the start day of the absence (in minutes) [booking in hours only]
endDatedateThe end date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
endDatePartCodestringmax-length: 40; reference-data
endDateTotalMinutesintegerDuration of the end day of the absence (in minutes) [booking in hours only]
absenceStateCodestringmax-length: 40; reference-data. The approval state of the absence.
expectedEndDatedateThe expected end date (if open ended absence) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
sicknessReasonstringmax-length: 80; reference-data
absenceBookedDatedatetimeThe date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
lostHoursinteger(Deprecated. Replaced by totals in minutes fields)
totalExpectedWorkingTimeInMinutesintegerSum of the hours worked over period according to their working pattern in minutes
totalLostTimeInMinutesintegerSum of the hours booked as absence over the period in minutes


Example of this event

{
  "personId": "",
  "personalReference": "",
  "occupancyId": "",
  "jobReference": "",
  "absenceId": "",
  "absenceTypeCode": "",
  "absenceTypeName": "",
  "absenceCategoryCode": "",
  "startDate": "",
  "startDatePartCode": "",
  "startDateTotalMinutes": "",
  "endDate": "",
  "endDatePartCode": "",
  "endDateTotalMinutes": "",
  "absenceStateCode": "",
  "expectedEndDate": "",
  "sicknessReason": "",
  "absenceBookedDate": "",
  "lostHours": "",
  "totalExpectedWorkingTimeInMinutes": "",
  "totalLostTimeInMinutes": ""
}

AbsenceLeaveChanged, AbsenceSicknessChanged and AbsenceOtherChanged events

An AbsenceLeaveChanged, AbsenceSicknessChanged or AbsenceOtherChanged event will be raised when:

  • any properties on a leave|sickness|other absence are changed

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidUnique Person Identifier
personalReferencestringmax-length: 20
occupancyIdguidUnique Occupancy Identifier
jobReferencestringmax-length: 20
absenceIdguidUnique Absence Identifier
absenceTypeCodestringmax-length: 40; reference-data
absenceTypeNamestringmax-length: 80; reference-data
absenceCategoryCodestringmax-length: 40; Indicator of the category the absence type is allocated to (i.e. Leave, Sickness, Family or Other)
originalStartDatedateThe start date prior to the change in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
originalStartDatePartCodestringmax-length: 40; reference-data. The start day part code prior to the change.
originalStartDateTotalMinutesintegerDuration of the start day of the absence (in minutes) prior to the change [booking in hours only]
startDatedateThe start date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
startDatePartCodestringmax-length: 40; reference-data
startDateTotalMinutesintegerDuration of the start day of the absence (in minutes) [booking in hours only]
originalEndDatedateThe end date prior to the change in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
originalEndDatePartCodestringmax-length: 40; reference-data. The end day part code prior to the change.
originalEndDateTotalMinutesintegerDuration of the end day of the absence (in minutes) prior to the change [booking in hours only]
endDatedateThe end date of the absence is in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
endDatePartCodestringmax-length: 40; reference-data
endDateTotalMinutesintegerDuration of the end day of the absence (in minutes) [booking in hours only]
absenceStateCodestringmax-length: 40; reference-data. The approval state of the absence.
previousAbsenceStateCodestringmax-length: 40; reference-data. The approval state prior to the change.
expectedEndDatedateThe expected end date of the absence (if open ended) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
sicknessReasonstringmax-length: 80; reference-data
absenceBookedDatedatetimeThe date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
lostHoursinteger(Deprecated. Replaced by totals in minutes fields)
totalExpectedWorkingTimeInMinutesintegerSum of the hours worked over period according to their working pattern in minutes
totalLostTimeInMinutesintegerSum of the hours booked as absence over the period in minutes


Example of this event

{
  "personId": "",
  "personalReference": "",
  "occupancyId": "",
  "jobReference": "",
  "absenceId": "",
  "absenceTypeCode": "",
  "absenceTypeName": "",
  "absenceCategoryCode": "",
  "startDate": "",
  "startDatePartCode": "",
  "startDateTotalMinutes": "",
  "endDate": "",
  "endDatePartCode": "",
  "endDateTotalMinutes": "",
  "absenceStateCode": "",
  "expectedEndDate": "",
  "sicknessReason": "",
  "absenceBookedDate": "",
  "lostHours": "",
  "totalExpectedWorkingTimeInMinutes": "",
  "totalLostTimeInMinutes": ""
}

AbsenceLeaveDeleted, AbsenceSicknessDeleted and AbsenceOtherDeleted events

An AbsenceLeaveDeleted, AbsenceSicknessDeleted or AbsenceOtherDeleted event will be raised when:

  • a leave|sickness|other absence is deleted

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidUnique Person Identifier
personalReferencestringmax-length: 20
occupancyIdguidUnique Occupancy Identifier
jobReferencestringmax-length: 20
absenceIdguidUnique Absence Identifier
absenceTypeCodestringmax-length: 40; reference-data
absenceTypeNamestringmax-length: 80; reference-data
absenceCategoryCodestringmax-length: 40; Indicator of category the absence type is allocated to (i.e. Leave, Sickness, Family or Other)
startDatedateThe date is in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
startDatePartCodestringmax-length: 40; reference-data
startDateTotalMinutesintegerDuration of the start day of the absence (in minutes) [booking in hours only]
endDatedateThe date is in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
endDatePartCodestringmax-length: 40; reference-data
endDateTotalMinutesintegerDuration of the end day of the absence (in minutes) [booking in hours only]
expectedEndDatedateThe expected end date of the absence (if open ended) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
sicknessReasonstringmax-length: 80; reference-data
absenceBookedDatedatetimeThe date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
lostHoursinteger(Deprecated. Replaced by totals in minutes fields)
totalExpectedWorkingTimeInMinutesintegerSum of the hours worked over period according to their working pattern in minutes
totalLostTimeInMinutesintegerSum of the hours booked as absence over the period in minutes


Example of this event

{
  "personId": "",
  "personalReference": "",
  "occupancyId": "",
  "jobReference": "",
  "absenceId": "",
  "absenceTypeCode": "",
  "absenceTypeName": "",
  "absenceCategoryCode": "",
  "startDate": "",
  "startDatePartCode": "",
  "startDateTotalMinutes": "",
  "endDate": "",
  "endDatePartCode": "",
  "endDateTotalMinutes": "",
  "expectedEndDate": "",
  "sicknessReason": "",
  "absenceBookedDate": "",
  "lostHours": "",
  "totalExpectedWorkingTimeInMinutes": "",
  "totalLostTimeInMinutes": ""
}

AbsenceLeaveRejected, AbsenceSicknessRejected and AbsenceOtherRejected events

An AbsenceLeaveRejected, AbsenceSicknessRejected or AbsenceOtherRejected event will be raised when:

  • a leave|sickness|other absence is rejected
     

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidUnique Person Identifier
personalReferencestringmax-length: 20
occupancyIdguidUnique Occupancy Identifier
jobReferencestringmax-length: 20
absenceIdguidUnique Absence Identifier
absenceTypeCodestringmax-length: 40; reference-data
absenceTypeNamestringmax-length: 80; reference-data
absenceCategoryCodestringmax-length: 40; Indicator of category the absence type is allocated to (i.e. Leave, Sickness, Family or Other)
startDatedateThe start date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
startDatePartCodestringmax-length: 40; reference-data
startDateTotalMinutesintegerDuration of the start day of the absence (in minutes) [booking in hours only]
endDatedateThe end date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
endDatePartCodestringmax-length: 40; reference-data
endDateTotalMinutesintegerDuration of the end day of the absence (in minutes) [booking in hours only]
expectedEndDatedateThe expected end date of the absence (if open ended) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
sicknessReasonstringmax-length: 80; reference-data
absenceBookedDatedatetimeThe date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
lostHoursinteger(Deprecated. Replaced by totals in minutes fields)
totalExpectedWorkingTimeInMinutesintegerSum of the hours worked over period according to their working pattern in minutes
totalLostTimeInMinutesintegerSum of the hours booked as absence over the period in minutes


Example of this event

{
  "personId": "",
  "personalReference": "",
  "occupancyId": "",
  "jobReference": "",
  "absenceId": "",
  "absenceTypeCode": "",
  "absenceTypeName": "",
  "absenceCategoryCode": "",
  "startDate": "",
  "startDatePartCode": "",
  "startDateTotalMinutes": "",
  "endDate": "",
  "endDatePartCode": "",
  "endDateTotalMinutes": "",
  "expectedEndDate": "",
  "sicknessReason": "",
  "absenceBookedDate": "",
  "lostHours": "",
  "totalExpectedWorkingTimeInMinutes": "",
  "totalLostTimeInMinutes": ""
}

AbsenceLeaveApproved, AbsenceSicknessApproved and AbsenceOtherApproved events

An AbsenceLeaveApproved, AbsenceSicknessApproved or AbsenceOtherApproved event will be raised when:

  • a leave|sickness|other absence is approved

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidUnique Person Identifier
personalReferencestringmax-length: 20
occupancyIdguidUnique Occupancy Identifier
jobReferencestringmax-length: 20
absenceIdguidUnique Absence Identifier
absenceTypeCodestringmax-length: 40; reference-data
startDatedateThe start date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
startDatePartCodestringmax-length: 40; reference-data
startDateTotalMinutesintegerDuration of the start day of the absence (in minutes) [booking in hours only]
endDatedateThe end date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
endDatePartCodestringmax-length: 40; reference-data
endDateTotalMinutesintegerDuration of the end day of the absence (in minutes) [booking in hours only]
expectedEndDatedateThe expected end date of the absence (if open ended) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
sicknessReasonstringmax-length: 80; reference-data
absenceBookedDatedatetimeThe date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
lostHoursinteger(Deprecated. Replaced by totals in minutes fields)
totalExpectedWorkingTimeInMinutesintegerSum of the hours worked over period according to their working pattern in minutes
totalLostTimeInMinutesintegerSum of the hours booked as absence over the period in minutes


Example of this event

{
  "personId": "",
  "personalReference": "",
  "occupancyId": "",
  "jobReference": "",
  "absenceId": "",
  "absenceTypeCode": "",
  "absenceTypeName": "",
  "absenceCategoryCode": "",
  "startDate": "",
  "startDatePartCode": "",
  "startDateTotalMinutes": "",
  "endDate": "",
  "endDatePartCode": "",
  "endDateTotalMinutes": "",
  "expectedEndDate": "",
  "sicknessReason": "",
  "absenceBookedDate": "",
  "lostHours": "",
  "totalExpectedWorkingTimeInMinutes": "",
  "totalLostTimeInMinutes": ""
}

Looking for something specific?