get/curriculum/{curriculumId}/education/{educationId}
Allows to read the education identified by the educationId provided of a CV that belongs to the authenticated user. Only non null fields will not be displayed in the response.
Request
Resource URL
https://api.infojobs.net/api/1/curriculum/{curriculumId}/education/{educationId}
Security
- User Role: role_candidate
- Scope: candidate_read_curriculum_education
Parameters
Name | Description |
---|---|
curriculumId Required String |
Alpha-numeric code identifying the CV to be edited. Example values: E5F8F910-0F03-F307-AC00E6E14F41414D |
educationId Required String |
numeric code identifying the education item to be edited. Example values:14826429040 |
Response
Response fields
Name | Description |
---|---|
id Long Required |
Numeric identifier of the education item. |
educationLevelCode String Required |
Text key identifying the education level code. The operation /dictionary/study returns all the allowed key values. Maximum length: 100 |
courseCode String Optional |
Text key that identifies the branch of study or further details about to the education level previously described. The operation /dictionary/study-detail returns all the allowed key values. * This field will only be displayed when it has a value. Maximum length: 100 |
courseName String Optional |
This field must be informed in the event no courseCode associated to the educationLevelCode exists. * This field will only be displayed when it has a value. Maximum length: 200 |
startingDate Date Optional |
The date the course was started. Date format must be in RFC_3339 format: yyyy-MM-dd. * This field will only be displayed when it has a value. |
finishingDate Date Optional |
The date the course was completed. Date format must be in RFC_3339 format: yyyy-MM-dd. * This field will only be displayed when it has a value. |
stillEnrolled Boolean Required |
Whether the candidate is still enrolled in this course. Default value is false. |
institutionName String Optional |
The name of the institution where the education took place. * This field will only be displayed when it has a value. Maximum length: 200 |
hideEducation Boolean Required |
Whether the candidate wishes to display this education to companies. Default value: false. |
Code | Description |
---|---|
361 |
Security exception when the Curriculum was not found or is trying to be read with no permissions. |
612 |
Security exception when the experience was not found or is trying to be read with no permissions. |
Examples
In the following example the education item identified by educationId "9248429800" of the curriculum identified by id "E5F8F910-0F03-F307-AC00E6E14F41414D" will be retrieved.
Request
GET http://api.infojobs.net/api/1/curriculum/E5F8F910-0F03-F307-AC00E6E14F41414D/education/9248429800
Response
{ "id": 9248429800, "educationLevelCode": "formacion-profesional-grado-superior", "courseCode": "actividades-agrarias", "startingDate": "2005-10-01", "finishingDate": "2006-11-01", "stillEnrolled": false, "institutionName": "Centro", "hideEducation": false }