Update a candidate previous employment
patch
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}
Request
Path Parameters
-
CandidateNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
PreviousEmploymentId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Achievements: string
(byte)
Title:
Achievements
Achievements of the candidate previous employment. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional Information of the candidate previous employment. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type of the candidate previous employment. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL of the candidate previous employment. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Contact supervisor indicator in the candidate experience. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code number of the candidate previous employment. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Indicates whether the job is the current job of the candidate in the previous employment. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department of the candidate previous employment. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct reports of the candidate previous employment. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city of the candidate previous employment. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name of the candidate previous employment. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone of the candidate previous employment. -
EndCompensation: number
Title:
Ending Compensation
End compensation of the candidate previous employment. -
EndDate: string
(date)
Title:
End Date
End date of the candidate previous employment. -
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Full time code of the candidate previous employment. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Indicates whether the job is internal in the candidate previous employment. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family identifier of the candidate previous employment. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function of the candidate previous employment. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title of the candidate previous employment. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Leaving reason of the candidate previous employment. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation of the candidate previous employment. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function of the candidate previous employment. -
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities of the candidate previous employment. -
SectionId: integer
(int64)
Section identifier of the candidate previous employment.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation of the candidate previous employment. -
StartDate: string
(date)
Title:
Start Date
Start date of the candidate previous employment. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position of the candidate previous employment. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code of the candidate previous employment. -
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email of the candidate previous employment. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name of the candidate previous employment. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone of the candidate previous employment. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title of the candidate previous employment.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : recruitingJobSiteCandidates-previousEmployments-item-response
Type:
Show Source
object
-
Achievements: string
(byte)
Title:
Achievements
Achievements of the candidate previous employment. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional Information of the candidate previous employment. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type of the candidate previous employment. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL of the candidate previous employment. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Contact supervisor indicator in the candidate experience. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code number of the candidate previous employment. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Indicates whether the job is the current job of the candidate in the previous employment. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department of the candidate previous employment. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct reports of the candidate previous employment. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city of the candidate previous employment. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name of the candidate previous employment. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone of the candidate previous employment. -
EndCompensation: number
Title:
Ending Compensation
End compensation of the candidate previous employment. -
EndDate: string
(date)
Title:
End Date
End date of the candidate previous employment. -
ExperienceInYears: number
Read Only:
true
Experience in years of the candidate previous employment. -
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Full time code of the candidate previous employment. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Indicates whether the job is internal in the candidate previous employment. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family identifier of the candidate previous employment. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function of the candidate previous employment. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title of the candidate previous employment. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Leaving reason of the candidate previous employment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation of the candidate previous employment. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function of the candidate previous employment. -
PreviousEmploymentId: integer
(int64)
Previous employment identifier of the candidate previous employment.
-
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities of the candidate previous employment. -
SectionId: integer
(int64)
Section identifier of the candidate previous employment.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation of the candidate previous employment. -
StartDate: string
(date)
Title:
Start Date
Start date of the candidate previous employment. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position of the candidate previous employment. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code of the candidate previous employment. -
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email of the candidate previous employment. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name of the candidate previous employment. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone of the candidate previous employment. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title of the candidate previous employment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.