Retrieving related records

Retrieving jobs by an employee's display ID

Retrieving Bank Details by an Employee's Display ID

Retrieve an Absence by Employee's Display ID

Retrieving jobs by an employee's display ID

Get Employee by Display ID

Copy 
https://iris.api.co.uk/hr/v2/employees?$filter=DisplayId eq '123'

Take the Id from the result and the use as the employeeId in the following requests:

Get Jobs for Employee

Copy 
https://iris.api.co.uk/hr/v2/jobs?$filter=EmployeeId eq '<employeeId>' 

Returns an array of job records that belong to the employee. Use the Id of the record to update.

Get Active Job for Employee

Copy 
https://iris.api.co.uk/hr/v2/jobs?$filter=EmployeeId eq '<employeeId>' and Active eq true

Returns the active job records that belong to the employee. The active job starts and ends around the current date.

Get Job for Employee Based on Date

Copy 
https://iris.api.co.uk/hr/v2/jobs?$filter=EmployeeId eq '<employeeId>' and StartDate le date('2000-01-01') and EndDate gt date('2000-01-01')'

Returns the active job records that belong to the employee. The active job starts and ends around the current date.

Retrieving Bank Details by an Employee's Display ID

Get Employee by Display ID

Copy 
https://iris.api.co.uk/hr/v2/employees?$filter=DisplayId eq '123'

Take the Id from the result and the use as the employeeId in the following requests:

Get Bank Details for Employee

This end point is disabled by default.

IRIS Cascade only supports a single record of bank details.

Copy 
https://iris.api.co.uk/hr/v2/bankdetails?$filter=EmployeeId eq '<employeeId>'

Returns the bank details record. Use the Id of the record to update.

Retrieve an Absence by Employee's Display ID

Get Employee by Display ID

Copy 
https://iris.api.co.uk/hr/v2/employees?$filter=DisplayId eq '123'

Take the Id from the result and the use as the employeeId in the following request:

Get Absences for Employee

Copy 
https://iris.api.co.uk/hr/v2/absences?$filter=EmployeeId eq '<employeeId>'

Returns an array of absence records that belong to the employee. Use the Id of the record as the absenceId in the next request.

Get AbsenceDays for Absence

Copy 
https://iris.api.co.uk/hr/v2/absencedays?$filter=AbsenceId eq '<absenceId>'

Returns an array of absenceday records that belong to the absence. Use the Id of the record to update.

Get AbsenceDays for Employee

Copy 
https://iris.api.co.uk/hr/v2/absencedays?$filter=EmployeeId eq '<employeeId>'

Returns an array of absenceday records that belong to the absence. Use the Id of the record to update.