Get a education of the recruiting partner candidate
get
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}
Request
Path Parameters
-
CandidateToken(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
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 : recruitingPartnerCandidateDetails-educations-item-response
Type:
Show Source
object-
AcademicStanding: string
Read Only:
trueAcademic standing in education of recruiting partner candidate. -
ActivitySummary: string
(byte)
Read Only:
trueActivity summary of education of recruiting partner candidate. -
AreaOfStudy: string
Read Only:
trueArea Of Study in educations of recruiting partner candidate. -
AverageGrade: string
Read Only:
trueAverage Grade in educations of recruiting partner candidate. -
AwardingBody: string
Read Only:
trueAwarding Body in educations of recruiting partner candidate. -
City: string
Read Only:
trueCity in educations of recruiting partner candidate. -
Comments: string
(byte)
Read Only:
trueComments in the education of recruiting partner candidate. -
CompletedAmount: integer
Read Only:
trueCompleted Amount in educations of recruiting partner candidate. -
CompletedTrainingUnits: string
Read Only:
trueCompleted Training Units in educations of recruiting partner candidate. -
Country: string
Read Only:
trueCountry in educations of recruiting partner candidate. -
DateAcquired: string
(date)
Read Only:
trueDate Acquired in educations of recruiting partner candidate. -
DegreeName: string
Read Only:
trueDegree Name in educations of recruiting partner candidate. -
Department: string
Read Only:
trueDepartment in educations of recruiting partner candidate. -
Description: string
(byte)
Read Only:
trueDescription for education of recruiting partner candidate. -
Duration: string
Read Only:
trueMaximum Length:255Duration of education of recruiting partner candidate. -
DurationUnits: string
Read Only:
trueUnits of the duration of education of recruiting partner candidate. -
EducationId: integer
Read Only:
trueEducation ID in educations of recruiting partner candidate. -
EducationLevel: string
Read Only:
trueEducation Level in educations of recruiting partner candidate. -
EducationLevelCompletedFlag: boolean
Read Only:
trueIndicates if the education level is complete for recruiting partner candidate. -
EducationURL: string
Read Only:
trueURL of the education of recruiting partner candidate. -
Educator: string
Read Only:
trueEducator in educations of recruiting partner candidate. -
EndDate: string
(date)
Read Only:
trueEnd Date in educations of recruiting partner candidate. -
Fee: integer
Read Only:
trueEducation fees of recruiting partner candidate. -
FeeCurrency: string
Read Only:
trueCurrency of the education fees of recruiting partner candidate. -
GPA: number
Read Only:
trueGPA in educations of recruiting partner candidate. -
GraduatedFlag: boolean
Read Only:
trueIndicates that the recruiting partner candidate is a graduate. -
HighestEducationLevel: string
Read Only:
trueHighest education level of recruiting partner candidate. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Major: string
Read Only:
trueMajor in educations of recruiting partner candidate. -
Minor: string
Read Only:
trueMinor in educations of recruiting partner candidate. -
PartTimeFlag: boolean
Read Only:
trueIndicates if the education was pursued as a part time course by recruiting partner candidate. -
ProjectedCompletionDate: string
(date)
Read Only:
trueProjected Completion Date in educations of recruiting partner candidate. -
Reimbursements: string
(byte)
Read Only:
trueReimbursement arrangements of education of recruiting partner candidate. -
SchoolName: string
Read Only:
trueSchool Name in educations of recruiting partner candidate. -
SectionId: integer
Read Only:
trueSection ID assigned for each section in education of recruiting partner candidate. -
SectionName: string
Read Only:
trueSection Name assigned for each section in education of recruiting partner candidate. -
StartDate: string
(date)
Read Only:
trueStart Date in educations of recruiting partner candidate. -
State: string
Read Only:
trueState in educations of recruiting partner candidate. -
Status: string
Read Only:
trueStatus in educations of recruiting partner candidate. -
Title: string
Read Only:
trueLabel in educations of recruiting partner candidate. -
TotalAmount: integer
Read Only:
trueTotal Amount in educations of recruiting partner candidate. -
TrmnlDegDiscpFlag: boolean
Read Only:
trueIndicates that it's the terminal degree in the education of the recruiting partner candidate. -
TuitionMethod: string
Read Only:
trueTuition method of education of recruiting partner candidate. -
YearAcquired: string
Read Only:
trueYear Acquired in educations of recruiting partner candidate.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.