Jobs

Update a Job referenced by an ID.

Changed on
put/jobs/{id}

Request

Path parameters

idstring required

The ID of the Job to update.

Request body

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].

ChangeReasonstring nullable

The reason for the change.

Cascade Source: [EmployeeJobs].[Reason].

NextIncrementDatestring date-time nullable

The next increment date.

Cascade Source: [EmployeeJobs].[IncrementDate].

TimesheetLocationstring nullable

The timesheet location.

Cascade Source: [EmployeeJobs].[TimesheetLocation].

TimesheetLunchDurationstring nullable

The time set lunch duration.

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

Cascade Source: [EmployeeJobs].[LunchDuration].

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].

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].

Response

No Content

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

      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; 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; 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=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=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; 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=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=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; 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=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.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=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/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 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

    • info

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