Get candidate education
get
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}
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=
-
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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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-educations-item-response
Type:
Show Source
object
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Academic standing of the candidate education. -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Activity summary of the candidate education. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of study of the candidate education. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade of the candidate education. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Awarding body of the candidate education. -
City: string
Title:
City
Maximum Length:240
CIty of the candidate education. -
Comments: string
(byte)
Title:
Comments
Comments of the candidate education. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount of the candidate education. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units of the candidate education. -
ContentItemId: integer
(int64)
Title:
Degree
Content item identifier of the candidate education. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code of the candidate education. -
DateAcquired: string
(date)
Title:
Date Acquired
Date acquired of the candidate education. -
DegreeName: string
Title:
Degree
Maximum Length:240
Degree name of the candidate education. -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department of the candidate education. -
Description: string
(byte)
Title:
Description
Description of the candidate education. -
Duration: string
Title:
Duration
Maximum Length:240
Duration of the candidate education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Duration units of the candidate education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Educational establishment of the candidate education. -
EducationalEstablishmentId: integer
(int64)
Title:
School
Educational establishment identifier of the candidate education. -
EducationId: integer
(int64)
Education identifier of the candidate education.
-
EducationLevel: string
Title:
Education Level
Maximum Length:30
Education level of the candidate education. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
Education URL of the candidate education. -
Educator: string
Title:
Educator
Maximum Length:240
Educator of the candidate education. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Education level completed indicator of the candidate education. -
EndDate: string
(date)
Title:
End Date
End date of the candidate education. -
Fee: integer
(int64)
Title:
Fee
Fee of the candidate education. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Fee currency of the candidate education. -
GPA: number
Title:
GPA
GPA of the candidate education. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Graduated indicator of the candidate education. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest education level of the candidate education. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Major: string
Title:
Major
Maximum Length:240
Major of the candidate education. -
Minor: string
Title:
Minor
Maximum Length:240
Minor of the candidate education. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Part time indicator of the candidate education. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected completion date of the candidate education. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements of the candidate education. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Indicates whether the education is required in the candidate education. -
SectionId: integer
(int64)
Section identifier of the candidate education.
-
StartDate: string
(date)
Title:
Start Date
Start date of the candidate education. -
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code of the candidate education. -
Status: string
Title:
Status
Maximum Length:30
Status of the candidate education. -
Title: string
Title:
Title
Maximum Length:240
Title of the candidate education. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount of the candidate education. -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Terminal degree discipline indicator of the candidate education. -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Tuition method of the candidate education. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year acquired of the candidate education.
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.