Jump to

• Request
• Response

Get a education information from job application

get

/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{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=
• JobApplicationId(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: string
  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: string
  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 Top

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.

Body ()

Root Schema : recruitingJobApplications-education-item-response

Type: object

Show Source

• AcademicStanding: string
  Title: Academic Standing

  Maximum Length: 30

  Educational academic standing of the candidate.
• ActivitySummary: string (byte)
  Title: Summary of Activities

  Educational activity summary of the candidate.
• AreaOfStudy: string
  Title: Area of Study

  Maximum Length: 240

  Educational area of study of the candidate.
• AverageGrade: string
  Title: Average Grade

  Maximum Length: 240

  Educational average grade of the candidate.
• AwardingBody: string
  Title: Awarding Body

  Maximum Length: 240

  Institution awarding the academic grade.
• City: string
  Title: City

  Maximum Length: 240

  City of education of the candidate.
• Comments: string (byte)
  Title: Comments

  Comments on education.
• CompletedAmount: integer (int64)
  Title: Completed Amount

  Percentage of completion of education.
• CompletedTraningUnits: string
  Title: Training Completed Units

  Maximum Length: 240

  Number of training units completed by the candidate.
• ContentItemId: integer (int64)
  Title: Degree

  ID assigned to each item of education.
• CountryId: integer (int64)
  Title: Country

  ID assigned to the country where the education was completed.
• DateAcquired: string (date)
  Title: Date Acquired

  Date when the educational degree was acquired.
• DegreeName: string
  Title: Degree

  Maximum Length: 240

  Name of the acquired degree
• Department: string
  Title: Faculty or Department

  Maximum Length: 240

  Department of education.
• Description: string (byte)
  Title: Description

  Description of education.
• Duration: string
  Title: Duration

  Maximum Length: 240

  Duration of education.
• DurationUnits: string
  Title: Duration Units

  Maximum Length: 30

  Duration units of education.
• EducationalEstablishment: string
  Title: School Name

  Maximum Length: 2000

  Name of the educational establishment in education.
• EducationalEstablishmentId: integer (int64)
  Title: School

  ID assigned to the educational establishment.
• EducationId: integer (int64)
  ID assigned to the education of the candidate.
• EducationLevel: string
  Title: Education Level

  Maximum Length: 30

  Level of education acquired by the candidate.
• EducationURL: string
  Title: Education URL

  Maximum Length: 2000

  URL of education.
• Educator: string
  Title: Educator

  Maximum Length: 240

  Name of the educator.
• EduLevelCompletedFlag: boolean
  Title: Education Level Completed

  Maximum Length: 30

  Indicates if the educational level is completed.
• EndDate: string (date)
  Title: End Date

  End date of an education.
• Fee: integer (int64)
  Title: Fee

  Educational fees.
• FeeCurrency: string
  Title: Fee Currency

  Maximum Length: 30

  Currency of the fees in education.
• GPA: number
  Title: GPA

  GPA acquired in education.
• GraduatedFlag: boolean
  Title: Graduated

  Maximum Length: 30

  Indicated if the candidate is a graduate.
• HighestEduLevel: string
  Title: Highest Education Level

  Maximum Length: 30

  Highest level of education acquired by the candidate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Major: string
  Title: Major

  Maximum Length: 240

  Major subject in education.
• Minor: string
  Title: Minor

  Maximum Length: 240

  Minor subject in education.
• PartTimeFlag: boolean
  Title: Part Time

  Maximum Length: 30

  Indicates if the course completed by the candidate is part time.
• ProjectedCompletionDate: string (date)
  Title: Projected Completion Date

  Projected date of completion of education.
• Reimbursements: string (byte)
  Title: Reimbursement Arrangements

  Reimbursements claimed by the candidate for their education.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 30

  Indicates the educational qualification is mandatory to be mentioned.
• SectionId: integer (int64)
  ID assigned to each educational section.
• StartDate: string (date)
  Title: Start Date

  Start date of an education.
• StateProvinceId: integer (int64)
  Title: State

  ID assigned to the state or province where the education was availed.
• Status: string
  Title: Status

  Maximum Length: 30

  Status of the education.
• Title: string
  Title: Title

  Maximum Length: 240

  Title of the education.
• TotalAmount: integer (int64)
  Title: Total Amount

  Total amount spent on the education.
• TrmnlDegDiscpFlag: boolean
  Title: Terminal Degree for Discipline

  Maximum Length: 30

  Indicates whether the education item is a terminal degree for the discipline.
• TuitionMethod: string
  Title: Tuition Method

  Maximum Length: 30

  Method of tuition availed.
• YearAcquired: integer (int64)
  Title: Year Acquired

  Year when the degree was attained.

{
    "type":"object",
    "properties":{
        "AcademicStanding":{
            "title":"Academic Standing",
            "maxLength":30,
            "type":"string",
            "description":"Educational academic standing of the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivitySummary":{
            "title":"Summary of Activities",
            "type":"string",
            "description":"Educational activity summary of the candidate.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AreaOfStudy":{
            "title":"Area of Study",
            "maxLength":240,
            "type":"string",
            "description":"Educational area of study of the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "AverageGrade":{
            "title":"Average Grade",
            "maxLength":240,
            "type":"string",
            "description":"Educational average grade of the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "AwardingBody":{
            "title":"Awarding Body",
            "maxLength":240,
            "type":"string",
            "description":"Institution awarding the academic grade.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":240,
            "type":"string",
            "description":"City of education of the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments on education.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CompletedAmount":{
            "title":"Completed Amount",
            "type":"integer",
            "description":"Percentage of completion of education.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CompletedTraningUnits":{
            "title":"Training Completed Units",
            "maxLength":240,
            "type":"string",
            "description":"Number of training units completed by the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "title":"Degree",
            "type":"integer",
            "description":"ID assigned to each item of education.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CountryId":{
            "title":"Country",
            "type":"integer",
            "description":"ID assigned to the country where the education was completed.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateAcquired":{
            "title":"Date Acquired",
            "type":"string",
            "description":"Date when the educational degree was acquired.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DegreeName":{
            "title":"Degree",
            "maxLength":240,
            "type":"string",
            "description":"Name of the acquired degree",
            "nullable":true,
            "x-queryable":true
        },
        "Department":{
            "title":"Faculty or Department",
            "maxLength":240,
            "type":"string",
            "description":"Department of education.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of education.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Duration":{
            "title":"Duration",
            "maxLength":240,
            "type":"string",
            "description":"Duration of education.",
            "nullable":true,
            "x-queryable":false
        },
        "DurationUnits":{
            "title":"Duration Units",
            "maxLength":30,
            "type":"string",
            "description":"Duration units of education.",
            "nullable":true,
            "x-queryable":false
        },
        "EduLevelCompletedFlag":{
            "title":"Education Level Completed",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the educational level is completed.",
            "nullable":true,
            "x-queryable":false
        },
        "EducationId":{
            "type":"integer",
            "description":"ID assigned to the education of the candidate.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EducationLevel":{
            "title":"Education Level",
            "maxLength":30,
            "type":"string",
            "description":"Level of education acquired by the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "EducationURL":{
            "title":"Education URL",
            "maxLength":2000,
            "type":"string",
            "description":"URL of education.",
            "nullable":true,
            "x-queryable":false
        },
        "EducationalEstablishment":{
            "title":"School Name",
            "maxLength":2000,
            "type":"string",
            "description":"Name of the educational establishment in education.",
            "nullable":true,
            "x-queryable":true
        },
        "EducationalEstablishmentId":{
            "title":"School",
            "type":"integer",
            "description":"ID assigned to the educational establishment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Educator":{
            "title":"Educator",
            "maxLength":240,
            "type":"string",
            "description":"Name of the educator.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of an education.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Fee":{
            "title":"Fee",
            "type":"integer",
            "description":"Educational fees.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FeeCurrency":{
            "title":"Fee Currency",
            "maxLength":30,
            "type":"string",
            "description":"Currency of the fees in education.",
            "nullable":true,
            "x-queryable":false
        },
        "GPA":{
            "title":"GPA",
            "type":"number",
            "description":"GPA acquired in education.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":15,
                "scale":2
            }
        },
        "GraduatedFlag":{
            "title":"Graduated",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicated if the candidate is a graduate.",
            "nullable":true,
            "x-queryable":false
        },
        "HighestEduLevel":{
            "title":"Highest Education Level",
            "maxLength":30,
            "type":"string",
            "description":"Highest level of education acquired by the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "Major":{
            "title":"Major",
            "maxLength":240,
            "type":"string",
            "description":"Major subject in education.",
            "nullable":true,
            "x-queryable":true
        },
        "Minor":{
            "title":"Minor",
            "maxLength":240,
            "type":"string",
            "description":"Minor subject in education.",
            "nullable":true,
            "x-queryable":false
        },
        "PartTimeFlag":{
            "title":"Part Time",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the course completed by the candidate is part time.",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"Projected date of completion of education.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Reimbursements":{
            "title":"Reimbursement Arrangements",
            "type":"string",
            "description":"Reimbursements claimed by the candidate for their education.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates the educational qualification is mandatory to be mentioned.",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"ID assigned to each educational section.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of an education.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "StateProvinceId":{
            "title":"State",
            "type":"integer",
            "description":"ID assigned to the state or province where the education was availed.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the education.",
            "nullable":true,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the education.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"integer",
            "description":"Total amount spent on the education.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TrmnlDegDiscpFlag":{
            "title":"Terminal Degree for Discipline",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the education item is a terminal degree for the discipline.",
            "nullable":true,
            "x-queryable":false
        },
        "TuitionMethod":{
            "title":"Tuition Method",
            "maxLength":30,
            "type":"string",
            "description":"Method of tuition availed.",
            "nullable":true,
            "x-queryable":false
        },
        "YearAcquired":{
            "title":"Year Acquired",
            "type":"integer",
            "description":"Year when the degree was attained.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top