HRhrapi
Jobs

Gets a single Job referenced by an ID.

Changed on
get/jobs/{id}

Request

Path parameters

idstring required

Job ID.

Response

OK

EmployeeIdstring required

The ID of the Employee of the Job.

Must exist in Employee Service.

JobTitlestring nullable

The title of the Job.

Cascade Source: [EmployeeJobs].[JobTitle]

Classificationstring nullable

The classification of the Job e.g. Technical, Professional, Managerial.

Cascade Source: [EmployeeJobs].[Classification] translated through the JOBCLASSIFICATION system list.

StartDatestring date-time required

The start date of the Job.

Cascade Source: [EmployeeJobs].[SYS_EffectiveDate]

EndDatestring date-time nullable

The end date of the Job.

Automatically Calculated.

Cascade Source: [EmployeeJobs].[SYS_CalculatedEndDate]

WorkingCalendarstring nullable

The name of the working calendar of the Job.

Cascade Source: [EmployeeJobs].[CalendarName] which comes from [ValidWorkingCalendar].[CalendarName]

LineManagerIdstring nullable

The ID of the Employee that is the line manager for this Job.

Must exist in Employees Service.

Cascade Source: [EmployeeJobs].[WorksForEmployeeId]

HierarchyNodeIdstring nullable

The ID of the Employee's Hierarchy node of the Job.

Must exist in Hierarchy Service.

Activeboolean

The Job is currently active.

Automatically Calculated.

Cascade Source: [EmployeeJobs].[sys_ActiveJob]

Salarynumber double nullable

The salary of the Job.

Cascade Source: [EmployeeJobs].[BasicPay]

Contractstring nullable

The contract of the Job e.g. Full Time, Part Time.

Cascade Source: [EmployeeJobs].[ContractType] translated through the EMPLOYMENTTYPES system list.

PayFrequencystring nullable

How often the Job's salary will be paid e.g. Monthly, Weekly.

Cascade Source: [EmployeeJobs].[PayFrequency] translated through the PAY FREQ system list.

PayBasisstring nullable

The unit of measurement the salary is specified against e.g. Yearly, Hourly.

Cascade Source: [EmployeeJobs].[PayBasis] translated through the PAY BASIS system list.

FullTimeEquivalentnumber double nullable

The full-time equivalent to a full time employee's hours e.g. 1 = Full Time, 0.5 = Half Hours.

Cascade Source: [EmployeeJobs].[FTE].

Positionstring nullable

The readonly property of employee position.

Cascade Source: [EmployeeJobs].[Postid].

PositionIdstring nullable

The ID of the Position.

Cannot be updated once Job is created to prevent breaking change to API functionality.

Must exist in Position Service.

ChangeReasonstring nullable

The reason for the change.

Cascade Source: [EmployeeJobs].[Reason].

PublicHolidayIdstring nullable

The ID of the Employee's Public Holiday profile for this Job.

Cannot be updated once Job is created to prevent breaking change to API functionality.

Must exist in Public Holiday Service.

PublicHolidaystring nullable

The readonly property of public holiday.

Cascade Soruce: [EmployeeJobs].[HolidayLocation].

WorkingPatternIdstring nullable

The ID of the Employee's Working Pattern for this Job.

Cannot be updated once Job is created to prevent breaking change to API functionality.

Must exist in Working Pattern Service.

PayGradestring nullable

The pay grade name assigned to this job.

Cascade Source: [EmployeeJobs].[PayGrade] which comes from [ValidPayGrade].[Grade].

SpinalPointinteger nullable

The readonly property of pay spinal point.

Cascade Source: [EmployeeJobs].[SpinalPoint].

NextIncrementDatestring date-time nullable

The next increment date.

Cascade Source: [EmployeeJobs].[IncrementDate].

TimesheetLocationstring nullable

The timesheet location.

Cascade Source: [EmployeeJobs].[TimesheetLocation].

TimesheetRuleSetstring nullable

The readonly property of time sheet rule set.

Cascade Source: [EmployeeJobs].[TimesheetRuleSetID].

TimesheetLunchDurationstring nullable

The time set lunch duration.

Valid Values: '20', '30', '60' or null.

Cascade Source: [EmployeeJobs].[LunchDuration].

AutoEnrolmentProfilestring nullable

The readonly property of automatic enrolment profiles.

Cascade Source: [EmployeeJobs].[AutoEnrolmentProfile].

ExpenseSubmissionFrequencystring nullable

The expense submission frequency.

Cascade Source: [EmployeeJobs].[ExpenseSubmissionFrequency].

CostCentrestring nullable

The cost centre.

Cascade Source: [EmployeeJobs].[CostCentre].

JobFamilystring nullable

The job family.

Cascade Source: [EmployeeJobs].[JobFamily].

ApprenticeUnder25boolean nullable

The flag to indicate if the employee is an apprentice under 25.

Cascade Source: [EmployeeJobs].[ApprenticeUnder25].

ApprenticeshipEndDatestring date-time nullable

The end date of the apprenticeship.

Cascade Source: [EmployeeJobs].[ApprenticeshipEndDate].

ContractEndDatestring date-time nullable

The end date of the contract.

Cascade Source: [EmployeeJobs].[ContractEndDate].

ReportsToPoststring nullable

The readonly property of reports to post.

Cascade Source: [EmployeeJobs].[ReportsToPost].

NormalHoursnumber double nullable

The number of normal full-time hours for this job per week.

Cascade Source: [EmployeeJobs].[NormalHours].

RealTimeInformationIrregularFrequencystring nullable

The real time information of irregular frequency.

Cascade Source: [EmployeeJobs].[RTIIrregularFrequency].

NoticePeriodstring nullable

The notice period.

Cascade Source: [EmployeeJobs].[NoticePeriod].

SourceSystemIdstring nullable

The Internal ID for the source HR Product.

Cascade Source: [EmployeeJobs].[RUID]

SourceSystemCreatedOnstring date-time nullable

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

Cascade Source: [EmployeeJobs].[SYS_EffectiveDate]

SourceSystemLastModifiedOnstring date-time nullable

The latest date when the Job record was created or last updated in the Source HR System.

Cascade Source: [EmployeeJobs].[SYS_ModifiedDate]

Idstring nullable

This ID is generated by the Iris Hr platform and does not relate to the Cascade ID.

CreatedOnstring date-time

The date when the Job 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 when the Job was created or last updated.

LastModifiedBystring nullable

Not used as 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

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=minimal;odata.streaming=true)

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=minimal;odata.streaming=false)

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=minimal)

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=full;odata.streaming=true)

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=full;odata.streaming=false)

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=full)

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=none;odata.streaming=true)

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=none;odata.streaming=false)

    • info

      added the optional property to the response with the status (media type: application/json;odata.metadata=none)

    • info

      added the optional property to the response with the status (media type: application/json;odata.streaming=true)

    • info

      added the optional property to the response with the status (media type: application/json;odata.streaming=false)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the optional property to the response with the status (media type: text/plain)

  • 7a4734dbe370Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      media type application/json;odata.metadata=full;odata.streaming=false; version=2 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=2 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=2 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=2 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=2 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=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status

    • info

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

    • info

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

    • info

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

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 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=2 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=2 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=2 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=2 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=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status

    • info

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

    • info

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

    • info

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

    • info

      media type application/json;odata.metadata=none;odata.streaming=false; version=2 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=2 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=2 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=2 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=2 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=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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