Update the details of the education items of the candidate.
patch
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}
Request
Path Parameters
-
EducationId(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
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Performance of the candidate in education -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Activity Summary in candidate education items. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of study done by the candidate. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade secured in education by the candidate. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Authority granting recognition in the field of education to the candidate. -
City: string
Title:
City
Maximum Length:240
City in which the education was done. -
Comments: string
(byte)
Title:
Comments
Comments on the candidate education details. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed Amount in candidate education items. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed Training Units in candidate education items. -
ContentItemId: integer
(int64)
Title:
Degree
Unique identifier assigned to the content. -
CountryCode: string
Title:
Country
Maximum Length:30
Country Code of the location of education. -
CountryId: integer
(int64)
Title:
Country
ID assigned to the country where the education was done. -
DateAcquired: string
(date)
Title:
Date Acquired
Date when the degree was acquired. -
DegreeName: string
Title:
Degree
Maximum Length:240
Name of the education degree earned by the candidate. -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department in which the education is acquired. -
Description: string
(byte)
Title:
Description
Description of the education item. -
Duration: string
Title:
Duration
Maximum Length:240
Duration of the education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Unit of the duration of education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Name of the education establishment. -
EducationalEstablishmentId: integer
(int64)
Title:
School
ID assigned to the education establishment. -
EducationLevel: string
Title:
Education Level
Maximum Length:30
Level of the education. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
URL of the education. -
Educator: string
Title:
Educator
Maximum Length:240
Educator of the education item. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Indicates if the education is complete. -
EndDate: string
(date)
Title:
End Date
End date of the education item. -
Fee: integer
(int64)
Title:
Fee
Fees of the education item. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Currency in which the education fees has been paid. -
FlowVersionId: integer
This gives service metadata information
-
GPA: number
Title:
GPA
GPA score of the candidate. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Indicates if the candidate is a graduate. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest educational level availed by the candidate. -
Major: string
Title:
Major
Maximum Length:240
Major subjects in the education availed by the candidate. -
Minor: string
Title:
Minor
Maximum Length:240
Minor subjects in education availed by the candidate. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Indicates if the education item is part time or not. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected completion date of the education item. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements that can be availed against an education item. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Indicates if the education item is required or not. -
SectionId: integer
(int64)
Section ID assigned to the education item.
-
StartDate: string
(date)
Title:
Start Date
Start date of the education item. -
StateProvinceCode: string
Title:
State
Maximum Length:360
Code assigned to the State Province where the education took place. -
StateProvinceId: integer
(int64)
Title:
State
Unique identifier assigned to the State Province where the education took place. -
Status: string
Title:
Status
Maximum Length:30
Status of the education. -
SubmissionId: integer
Submission ID generated against the educational details entered by the candidate.
-
Title: string
Title:
Title
Maximum Length:240
Title of the education item -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount of the education item -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Indicates if the education item is a terminal degree -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Mode of tuition availed during the course of education. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year in which the education was completed.
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 : recruitingCECandidateEducationItems-item-response
Type:
Show Source
object
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Performance of the candidate in education -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Activity Summary in candidate education items. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of study done by the candidate. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade secured in education by the candidate. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Authority granting recognition in the field of education to the candidate. -
City: string
Title:
City
Maximum Length:240
City in which the education was done. -
Comments: string
(byte)
Title:
Comments
Comments on the candidate education details. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed Amount in candidate education items. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed Training Units in candidate education items. -
ContentItemId: integer
(int64)
Title:
Degree
Unique identifier assigned to the content. -
CountryCode: string
Title:
Country
Maximum Length:30
Country Code of the location of education. -
CountryId: integer
(int64)
Title:
Country
ID assigned to the country where the education was done. -
DateAcquired: string
(date)
Title:
Date Acquired
Date when the degree was acquired. -
DegreeName: string
Title:
Degree
Maximum Length:240
Name of the education degree earned by the candidate. -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department in which the education is acquired. -
Description: string
(byte)
Title:
Description
Description of the education item. -
Duration: string
Title:
Duration
Maximum Length:240
Duration of the education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Unit of the duration of education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Name of the education establishment. -
EducationalEstablishmentId: integer
(int64)
Title:
School
ID assigned to the education establishment. -
EducationId: integer
(int64)
ID assigned to the education item.
-
EducationLevel: string
Title:
Education Level
Maximum Length:30
Level of the education. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
URL of the education. -
Educator: string
Title:
Educator
Maximum Length:240
Educator of the education item. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Indicates if the education is complete. -
EndDate: string
(date)
Title:
End Date
End date of the education item. -
Fee: integer
(int64)
Title:
Fee
Fees of the education item. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Currency in which the education fees has been paid. -
FlowVersionId: integer
This gives service metadata information
-
GPA: number
Title:
GPA
GPA score of the candidate. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Indicates if the candidate is a graduate. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest educational level availed by the candidate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Major: string
Title:
Major
Maximum Length:240
Major subjects in the education availed by the candidate. -
Minor: string
Title:
Minor
Maximum Length:240
Minor subjects in education availed by the candidate. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Indicates if the education item is part time or not. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected completion date of the education item. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements that can be availed against an education item. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Indicates if the education item is required or not. -
SectionId: integer
(int64)
Section ID assigned to the education item.
-
StartDate: string
(date)
Title:
Start Date
Start date of the education item. -
StateProvinceCode: string
Title:
State
Maximum Length:360
Code assigned to the State Province where the education took place. -
StateProvinceId: integer
(int64)
Title:
State
Unique identifier assigned to the State Province where the education took place. -
Status: string
Title:
Status
Maximum Length:30
Status of the education. -
SubmissionId: integer
Submission ID generated against the educational details entered by the candidate.
-
Title: string
Title:
Title
Maximum Length:240
Title of the education item -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount of the education item -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Indicates if the education item is a terminal degree -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Mode of tuition availed during the course of education. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year in which the education was completed.
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.