Image
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
The absenceDurationUnit is Daily or Hourly. Day-part codes apply to daily bookings; total-minute, local-time and time-zone fields apply to hourly bookings. Fields that do not apply or have no recorded value are null.
Field definitions for this event;
| Field Name | Data Type | Additional information |
|---|---|---|
| personId | guid | Unique Person Identifier |
| personalReference | string | max-length: 20 |
| occupancyId | guid | Unique Occupancy Identifier |
| jobReference | string | max-length: 20 |
| absenceId | guid | Unique Absence Identifier |
| absenceTypeCode | string | max-length: 40; reference-data |
| absenceTypeName | string | max-length: 80; reference-data |
| absenceCategoryCode | string | max-length: 40; Indicator of category the absence type is allocated to (i.e. Leave, Sickness, Family or Other) |
| absenceDurationUnit | string | The booking duration unit: Daily or Hourly. |
| startDate | date | The start date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| startDatePartCode | string | max-length: 40; reference-data |
| startDateTotalMinutes | integer | Duration of the start day of the absence (in minutes) [booking in hours only] |
| startDayStartTime | string | The local start time on the start day in HH:mm format [booking in hours only] |
| startDayEndTime | string | The local end time on the start day in HH:mm format [booking in hours only] |
| startDayTimeZone | string | The time-zone identifier for the start day (e.g. Europe/London) [booking in hours only] |
| endDate | date | The end date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| endDatePartCode | string | max-length: 40; reference-data |
| endDateTotalMinutes | integer | Duration of the end day of the absence (in minutes) [booking in hours only] |
| endDayStartTime | string | The local start time on the end day in HH:mm format [booking in hours only] |
| endDayEndTime | string | The local end time on the end day in HH:mm format [booking in hours only] |
| endDayTimeZone | string | The time-zone identifier for the end day (e.g. Europe/London) [booking in hours only] |
| absenceStateCode | string | max-length: 40; reference-data. The approval state of the absence. |
| expectedEndDate | date | The expected end date (if open ended absence) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| sicknessReason | string | max-length: 80; reference-data |
| absenceBookedDate | datetime | The date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| lostHours | integer | (Deprecated. Replaced by totals in minutes fields) |
| totalExpectedWorkingTimeInMinutes | integer | Sum of the hours worked over period according to their working pattern in minutes |
| totalLostTimeInMinutes | integer | Sum of the hours booked as absence over the period in minutes |
Example of this event
{
"personId": "",
"personalReference": "",
"occupancyId": "",
"jobReference": "",
"absenceId": "",
"absenceTypeCode": "",
"absenceTypeName": "",
"absenceCategoryCode": "",
"absenceDurationUnit": "",
"startDate": "",
"startDatePartCode": "",
"startDateTotalMinutes": "",
"startDayStartTime": "",
"startDayEndTime": "",
"startDayTimeZone": "",
"endDate": "",
"endDatePartCode": "",
"endDateTotalMinutes": "",
"endDayStartTime": "",
"endDayEndTime": "",
"endDayTimeZone": "",
"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
The absenceDurationUnit is Daily or Hourly. Day-part codes apply to daily bookings; total-minute, local-time and time-zone fields apply to hourly bookings. Fields that do not apply or have no recorded value are null. Original fields contain values prior to the change when available; original local-time and time-zone fields are null for daily bookings.
Field definitions for this event;
| Field Name | Data Type | Additional information |
|---|---|---|
| personId | guid | Unique Person Identifier |
| personalReference | string | max-length: 20 |
| occupancyId | guid | Unique Occupancy Identifier |
| jobReference | string | max-length: 20 |
| absenceId | guid | Unique Absence Identifier |
| absenceTypeCode | string | max-length: 40; reference-data |
| absenceTypeName | string | max-length: 80; reference-data |
| absenceCategoryCode | string | max-length: 40; Indicator of the category the absence type is allocated to (i.e. Leave, Sickness, Family or Other) |
| absenceDurationUnit | string | The booking duration unit: Daily or Hourly. |
| originalStartDate | date | The start date prior to the change in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| originalStartDatePartCode | string | max-length: 40; reference-data. The start day part code prior to the change. |
| originalStartDateTotalMinutes | integer | Duration of the start day of the absence (in minutes) prior to the change [booking in hours only] |
| startDate | date | The start date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| startDatePartCode | string | max-length: 40; reference-data |
| startDateTotalMinutes | integer | Duration of the start day of the absence (in minutes) [booking in hours only] |
| startDayStartTime | string | The local start time on the start day in HH:mm format [booking in hours only] |
| startDayEndTime | string | The local end time on the start day in HH:mm format [booking in hours only] |
| startDayTimeZone | string | The time-zone identifier for the start day (e.g. Europe/London) [booking in hours only] |
| endDayStartTime | string | The local start time on the end day in HH:mm format [booking in hours only] |
| endDayEndTime | string | The local end time on the end day in HH:mm format [booking in hours only] |
| endDayTimeZone | string | The time-zone identifier for the end day (e.g. Europe/London) [booking in hours only] |
| originalEndDate | date | The end date prior to the change in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| originalEndDatePartCode | string | max-length: 40; reference-data. The end day part code prior to the change. |
| originalEndDateTotalMinutes | integer | Duration of the end day of the absence (in minutes) prior to the change [booking in hours only] |
| originalStartDayStartTime | string | The local start time on the start day prior to the change in HH:mm format [booking in hours only] |
| originalStartDayEndTime | string | The local end time on the start day prior to the change in HH:mm format [booking in hours only] |
| originalStartDayTimeZone | string | The time-zone identifier for the start day prior to the change (e.g. Europe/London) [booking in hours only] |
| endDate | date | The end date of the absence is in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| endDatePartCode | string | max-length: 40; reference-data |
| endDateTotalMinutes | integer | Duration of the end day of the absence (in minutes) [booking in hours only] |
| originalEndDayStartTime | string | The local start time on the end day prior to the change in HH:mm format [booking in hours only] |
| originalEndDayEndTime | string | The local end time on the end day prior to the change in HH:mm format [booking in hours only] |
| originalEndDayTimeZone | string | The time-zone identifier for the end day prior to the change (e.g. Europe/London) [booking in hours only] |
| absenceStateCode | string | max-length: 40; reference-data. The approval state of the absence. |
| previousAbsenceStateCode | string | max-length: 40; reference-data. The approval state prior to the change. |
| expectedEndDate | date | The expected end date of the absence (if open ended) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| sicknessReason | string | max-length: 80; reference-data |
| absenceBookedDate | datetime | The date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| lostHours | integer | (Deprecated. Replaced by totals in minutes fields) |
| totalExpectedWorkingTimeInMinutes | integer | Sum of the hours worked over period according to their working pattern in minutes |
| totalLostTimeInMinutes | integer | Sum of the hours booked as absence over the period in minutes |
Example of this event
{
"personId": "",
"personalReference": "",
"occupancyId": "",
"jobReference": "",
"absenceId": "",
"absenceTypeCode": "",
"absenceTypeName": "",
"absenceCategoryCode": "",
"absenceDurationUnit": "",
"originalStartDate": "",
"originalStartDatePartCode": "",
"originalStartDateTotalMinutes": "",
"originalStartDayStartTime": "",
"originalStartDayEndTime": "",
"originalStartDayTimeZone": "",
"startDate": "",
"startDatePartCode": "",
"startDateTotalMinutes": "",
"startDayStartTime": "",
"startDayEndTime": "",
"startDayTimeZone": "",
"originalEndDate": "",
"originalEndDatePartCode": "",
"originalEndDateTotalMinutes": "",
"originalEndDayStartTime": "",
"originalEndDayEndTime": "",
"originalEndDayTimeZone": "",
"endDate": "",
"endDatePartCode": "",
"endDateTotalMinutes": "",
"endDayStartTime": "",
"endDayEndTime": "",
"endDayTimeZone": "",
"absenceStateCode": "",
"previousAbsenceStateCode": "",
"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
The absenceDurationUnit is Daily or Hourly. Day-part codes apply to daily bookings; total-minute, local-time and time-zone fields apply to hourly bookings. Fields that do not apply or have no recorded value are null.
Field definitions for this event;
| Field Name | Data Type | Additional information |
|---|---|---|
| personId | guid | Unique Person Identifier |
| personalReference | string | max-length: 20 |
| occupancyId | guid | Unique Occupancy Identifier |
| jobReference | string | max-length: 20 |
| absenceId | guid | Unique Absence Identifier |
| absenceTypeCode | string | max-length: 40; reference-data |
| absenceTypeName | string | max-length: 80; reference-data |
| absenceCategoryCode | string | max-length: 40; Indicator of category the absence type is allocated to (i.e. Leave, Sickness, Family or Other) |
| absenceDurationUnit | string | The booking duration unit: Daily or Hourly. |
| startDate | date | The date is in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| startDatePartCode | string | max-length: 40; reference-data |
| startDateTotalMinutes | integer | Duration of the start day of the absence (in minutes) [booking in hours only] |
| startDayStartTime | string | The local start time on the start day in HH:mm format [booking in hours only] |
| startDayEndTime | string | The local end time on the start day in HH:mm format [booking in hours only] |
| startDayTimeZone | string | The time-zone identifier for the start day (e.g. Europe/London) [booking in hours only] |
| endDate | date | The date is in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| endDatePartCode | string | max-length: 40; reference-data |
| endDateTotalMinutes | integer | Duration of the end day of the absence (in minutes) [booking in hours only] |
| endDayStartTime | string | The local start time on the end day in HH:mm format [booking in hours only] |
| endDayEndTime | string | The local end time on the end day in HH:mm format [booking in hours only] |
| endDayTimeZone | string | The time-zone identifier for the end day (e.g. Europe/London) [booking in hours only] |
| expectedEndDate | date | The expected end date of the absence (if open ended) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| sicknessReason | string | max-length: 80; reference-data |
| absenceBookedDate | datetime | The date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| lostHours | integer | (Deprecated. Replaced by totals in minutes fields) |
| totalExpectedWorkingTimeInMinutes | integer | Sum of the hours worked over period according to their working pattern in minutes |
| totalLostTimeInMinutes | integer | Sum of the hours booked as absence over the period in minutes |
Example of this event
{
"personId": "",
"personalReference": "",
"occupancyId": "",
"jobReference": "",
"absenceId": "",
"absenceTypeCode": "",
"absenceTypeName": "",
"absenceCategoryCode": "",
"absenceDurationUnit": "",
"startDate": "",
"startDatePartCode": "",
"startDateTotalMinutes": "",
"startDayStartTime": "",
"startDayEndTime": "",
"startDayTimeZone": "",
"endDate": "",
"endDatePartCode": "",
"endDateTotalMinutes": "",
"endDayStartTime": "",
"endDayEndTime": "",
"endDayTimeZone": "",
"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
The absenceDurationUnit is Daily or Hourly. Day-part codes apply to daily bookings; total-minute, local-time and time-zone fields apply to hourly bookings. Fields that do not apply or have no recorded value are null.
Field definitions for this event;
| Field Name | Data Type | Additional information |
|---|---|---|
| personId | guid | Unique Person Identifier |
| personalReference | string | max-length: 20 |
| occupancyId | guid | Unique Occupancy Identifier |
| jobReference | string | max-length: 20 |
| absenceId | guid | Unique Absence Identifier |
| absenceTypeCode | string | max-length: 40; reference-data |
| absenceTypeName | string | max-length: 80; reference-data |
| absenceCategoryCode | string | max-length: 40; Indicator of category the absence type is allocated to (i.e. Leave, Sickness, Family or Other) |
| absenceDurationUnit | string | The booking duration unit: Daily or Hourly. |
| startDate | date | The start date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| startDatePartCode | string | max-length: 40; reference-data |
| startDateTotalMinutes | integer | Duration of the start day of the absence (in minutes) [booking in hours only] |
| startDayStartTime | string | The local start time on the start day in HH:mm format [booking in hours only] |
| startDayEndTime | string | The local end time on the start day in HH:mm format [booking in hours only] |
| startDayTimeZone | string | The time-zone identifier for the start day (e.g. Europe/London) [booking in hours only] |
| endDate | date | The end date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| endDatePartCode | string | max-length: 40; reference-data |
| endDateTotalMinutes | integer | Duration of the end day of the absence (in minutes) [booking in hours only] |
| endDayStartTime | string | The local start time on the end day in HH:mm format [booking in hours only] |
| endDayEndTime | string | The local end time on the end day in HH:mm format [booking in hours only] |
| endDayTimeZone | string | The time-zone identifier for the end day (e.g. Europe/London) [booking in hours only] |
| expectedEndDate | date | The expected end date of the absence (if open ended) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| sicknessReason | string | max-length: 80; reference-data |
| absenceBookedDate | datetime | The date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| lostHours | integer | (Deprecated. Replaced by totals in minutes fields) |
| totalExpectedWorkingTimeInMinutes | integer | Sum of the hours worked over period according to their working pattern in minutes |
| totalLostTimeInMinutes | integer | Sum of the hours booked as absence over the period in minutes |
Example of this event
{
"personId": "",
"personalReference": "",
"occupancyId": "",
"jobReference": "",
"absenceId": "",
"absenceTypeCode": "",
"absenceTypeName": "",
"absenceCategoryCode": "",
"absenceDurationUnit": "",
"startDate": "",
"startDatePartCode": "",
"startDateTotalMinutes": "",
"startDayStartTime": "",
"startDayEndTime": "",
"startDayTimeZone": "",
"endDate": "",
"endDatePartCode": "",
"endDateTotalMinutes": "",
"endDayStartTime": "",
"endDayEndTime": "",
"endDayTimeZone": "",
"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
The absenceDurationUnit is Daily or Hourly. Day-part codes apply to daily bookings; total-minute, local-time and time-zone fields apply to hourly bookings. Fields that do not apply or have no recorded value are null.
Field definitions for this event;
| Field Name | Data Type | Additional information |
|---|---|---|
| personId | guid | Unique Person Identifier |
| personalReference | string | max-length: 20 |
| occupancyId | guid | Unique Occupancy Identifier |
| jobReference | string | max-length: 20 |
| absenceId | guid | Unique Absence Identifier |
| absenceTypeCode | string | max-length: 40; reference-data |
| absenceTypeName | string | max-length: 80; reference-data |
| absenceCategoryCode | string | max-length: 40; Indicator of category the absence type is allocated to (i.e. Leave, Sickness, Family or Other) |
| absenceDurationUnit | string | The booking duration unit: Daily or Hourly. |
| startDate | date | The start date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| startDatePartCode | string | max-length: 40; reference-data |
| startDateTotalMinutes | integer | Duration of the start day of the absence (in minutes) [booking in hours only] |
| startDayStartTime | string | The local start time on the start day in HH:mm format [booking in hours only] |
| startDayEndTime | string | The local end time on the start day in HH:mm format [booking in hours only] |
| startDayTimeZone | string | The time-zone identifier for the start day (e.g. Europe/London) [booking in hours only] |
| endDate | date | The end date of the absence in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| endDatePartCode | string | max-length: 40; reference-data |
| endDateTotalMinutes | integer | Duration of the end day of the absence (in minutes) [booking in hours only] |
| endDayStartTime | string | The local start time on the end day in HH:mm format [booking in hours only] |
| endDayEndTime | string | The local end time on the end day in HH:mm format [booking in hours only] |
| endDayTimeZone | string | The time-zone identifier for the end day (e.g. Europe/London) [booking in hours only] |
| absenceStateCode | string | max-length: 40; reference-data. The approval state of the absence. |
| expectedEndDate | date | The expected end date of the absence (if open ended) in ISO format in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| sicknessReason | string | max-length: 80; reference-data |
| absenceBookedDate | datetime | The date and time the absence was booked in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) |
| lostHours | integer | (Deprecated. Replaced by totals in minutes fields) |
| totalExpectedWorkingTimeInMinutes | integer | Sum of the hours worked over period according to their working pattern in minutes |
| totalLostTimeInMinutes | integer | Sum of the hours booked as absence over the period in minutes |
Example of this event
{
"personId": "",
"personalReference": "",
"occupancyId": "",
"jobReference": "",
"absenceId": "",
"absenceTypeCode": "",
"absenceTypeName": "",
"absenceCategoryCode": "",
"absenceDurationUnit": "",
"startDate": "",
"startDatePartCode": "",
"startDateTotalMinutes": "",
"startDayStartTime": "",
"startDayEndTime": "",
"startDayTimeZone": "",
"endDate": "",
"endDatePartCode": "",
"endDateTotalMinutes": "",
"endDayStartTime": "",
"endDayEndTime": "",
"endDayTimeZone": "",
"absenceStateCode": "",
"expectedEndDate": "",
"sicknessReason": "",
"absenceBookedDate": "",
"lostHours": "",
"totalExpectedWorkingTimeInMinutes": "",
"totalLostTimeInMinutes": ""
}
