HRhrapi
AbsenceReasons

Gets a single Absence Reason referenced by ID.

Changed on
get/attendance/absencereasons/{id}

Request

Path parameters

idstring required

Absence Reason ID.

Response

OK

ParentIdstring nullable

The Parent ID of this Absence Reason.

Namestring nullable

The Name of this Absence Reason.

Cascade Source:

[ValidAttendanceCategory].[Category] when ParentID is null;

[ValidAttendanceTypes].[Type] when ParentID is not null.

ParentNamestring nullable

The Name of the Parent Absence Reason.

Cascade Source: [ValidAttendanceCategory].[Category] of the Parent Absence Reason.

Holidayboolean nullable

This Absence Reason represents a Holiday.

Cascade Source: [ValidAttendanceCategory].[Holiday]

Absentboolean nullable

This Absence Reason represents an Absence.

Cascade Source: [ValidAttendanceCategory].[Absent]

Sickboolean nullable

This Absence Reason represents a Sickness.

Cascade Source: [ValidAttendanceCategory].[Sick]

StatutoryMaternityPayApplicableboolean nullable

This Absence Reason has Statutory Maternity Pay.

Cascade Source: [ValidAttendanceCategory].[SMPApplicable]

StudyExamboolean nullable

This Absence Reason represents an absence for Study or Exam.

Cascade Source: [ValidAttendanceCategory].[Code] = 96 or 97

FlexiLeaveboolean nullable

This Absence Reason represents Flexi Leave.

Cascade Source: [ValidAttendanceCategory].[Code] = 11

Lieuboolean nullable

This Absence Reason represents Lieu.

Cascade Source: [ValidAttendanceCategory].[Lieu]

AllowOpenEndedboolean nullable

This Absence Reason can be Open-Ended.

Cascade Source: ([ValidAttendanceCategory].[Absence] = 1 OR [ValidAttendanceCategory].[Sick] = 1)

AND [ValidAttendanceCategory].[SMPApplicable] = 0

AND ([ValidAttendanceCategory].[Code] = 96 OR [ValidAttendanceCategory].[Code] = 97)

AllowOverlapboolean nullable

This Absence Reason can be Overlapped by another Absence Reason or Overlap another Absence Reason when both Absence Reasons are set to true.

Cascade Source: [ValidAttendanceCategory].[IgnoreDateConflict]

ShowOnCalendarboolean nullable

Show Absences based on this Absence Reason on the Employee Calendar.

Cascade Source: [ValidAttendanceCategory].[ShowOnPlanner]

IncludeInBradfordFactorboolean nullable

This Absence Reason is included in Bradford Factor Calculations.

Cascade Source: [ValidAttendanceCategory].[IncludeInBradfordFactor]

SourceSystemIdstring nullable

Source HR System Id. Cascade Source:

If the ParentId is null then [ValidAttendanceCategory].[Id] If the ParentId is not null then [ValidAttendanceTypes].[Key] If Parent.Name = 'Statutory Leave' then [ValidSystemListItem].[SystemListItemId] Note - Statutory Leave Absence Reasons come from 'Statutory Leave' System List

SourceSystemCreatedOnstring date-time nullable

The date when the Absence Reason record was created in the Source HR System.

Cascade Source: N/A

SourceSystemLastModifiedOnstring date-time nullable

The date when the Absence Reason was created or last updated in the Source HR System.

Cascade Source: N/A

Idstring nullable

The ID of the Absence Reason.

This field is generated by Iris HR platform and not related to the Cascade ID.

CreatedOnstring date-time

The date time when the Absence Reason was created in the Iris HR platform.

CreatedBystring nullable

Not used as the Iris HR platform has no concept of users at the moment.

LastModifiedOnstring date-time nullable

The date time when the Absence Reason was created or last updated.

LastModifiedBystring nullable

Not used as the Iris HR platform has no concept of users at the moment.

Changes

  • 638d402d3872Revision changes
    • breaking

      added the pattern ^[0-9a-fA-F-]{36}$ to the path request parameter id

    • warning

      for the path request parameter id, the maxLength was set to 36

  • 7a4734dbe370Revision changes
    • info

      media type application/json; version=1 was changed to application/json for the response status

    • info

      media type application/json; version=1 was changed to application/json for the response status

    • info

      media type application/json; version=1 was changed to application/json for the response status

    • info

      media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status

    • info

      media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status

    • info

      media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status

    • info

      media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status

    • info

      media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status

    • info

      media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status

    • info

      media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status

    • info

      media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status

    • info

      media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status

    • info

      media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status

    • info

      media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status

    • info

      media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status

    • info

      media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status

    • info

      media type application/xml; version=1 was changed to application/xml for the response status

    • info

      media type application/xml; version=1 was changed to application/xml for the response status

    • info

      media type application/xml; version=1 was changed to application/xml for the response status

    • info

      media type text/plain; version=1 was changed to text/plain for the response status

    • info

      media type text/plain; version=1 was changed to text/plain for the response status

    • info

      media type text/plain; version=1 was changed to text/plain for the response status