put/curriculum/{curriculumId}/education

Allows to edit one education item of a CV that belongs to the authenticated user. Using this operation is also possible to create a new education item for the given CV.

Request

Resource URL

https://api.infojobs.net/api/2/curriculum/{curriculumId}/education

Security

User Role: role_candidate
Scope: candidate_edit_curriculum_education

Parameters

Name	Description
curriculumId Required String	Alpha-numeric code identifying the CV to be edited. Example values: E5F8F910-0F03-F307-AC00E

Name

Description

curriculumId

Required

String

Alpha-numeric code identifying the CV to be edited.

Example values: E5F8F910-0F03-F307-AC00E

Body Request Fields

{
	"id": "9248429794",			
	"educationLevelCode": "ingeniero-superior",
	"courseCode": "forestal",
	"courseName": "",
	"startingDate": "2003-10-01",
	"finishingDate": "2005-10-01",
	"stillEnrolled": "false",
	"institutionName": "Broward Community College",
	"hideEducation": "false"
}

Field Name	Description
id Long Optional	Numeric identifier of the education item. When the id is not informed the education item will be treated as a new item. When the id is informed the operation will attempt to edit an existing record. If such record does not exist an exception will be thrown. Example values: 9248429794
educationLevelCode String Required	Text key identifying the education level code. The operation /dictionary/study returns all the allowed key values. If this field is not informed or the value is invalid an exception will be thrown. Example values: ingeniero-superior
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. * When the educationLevelCode provided is "bachillerato" or "educacion-secundaria-obligatoria" this field should not be informed. Example values: forestal
courseName String Optional*	This field must be informed in the event no courseCode associated to the educationLevelCode exists. * When the educationLevelCode is "otros-titulos" this field is required. * When the educationLevelCode provided is "bachillerato" or "educacion-secundaria-obligatoria" this field should not be informed. IMPORTANT: Please note in compliance with JSON format you must not send carriage returns within the value field, but replace them with "\n" instead. Maximum length: 200 Example values: Machine Learning
startingDate Date Optional*	The date the course was started. Date format must be in RFC_3339 format: yyyy-MM-dd. This field should not be informed when the educationLevelCode is "otros-titulos". Example values:* 2003-10-01
finishingDate Date Optional*	The date the course was completed. It must be bigger than the starting date. Date format must be in RFC_3339 format: yyyy-MM-dd. This field is mandatory when educationLevelCode is "otros-titulos". This field is not required and should not be informed if stillEnrolled is true. Example values: 2005-10-01
stillEnrolled Boolean Optional*	Whether the candidate is still enrolled in this course. Default value is false. If set to true finishingDate should not be informed. Example values: true
institutionName Optional	The name of the institution where the education took place. IMPORTANT: Please note in compliance with JSON format you must not send carriage returns within the value field, but replace them with "\n" instead. Maximum length: 200 Example values: Broward Community College
hideEducation Boolean Optional	Whether the candidate wishes to display this education to companies. Default value: false. Example values: true

Field Name

Description

Long

Optional

Numeric identifier of the education item. When the id is not informed the education item will be treated as a new item. When the id is informed the operation will attempt to edit an existing record. If such record does not exist an exception will be thrown.

Example values: 9248429794

educationLevelCode

String

Required

Text key identifying the education level code. The operation /dictionary/study returns all the allowed key values.

If this field is not informed or the value is invalid an exception will be thrown.

Example values: ingeniero-superior

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.

* When the educationLevelCode provided is "bachillerato" or "educacion-secundaria-obligatoria" this field should not be informed.

Example values: forestal

courseName

String

Optional*

This field must be informed in the event no courseCode associated to the educationLevelCode exists.

* When the educationLevelCode is "otros-titulos" this field is required.

* When the educationLevelCode provided is "bachillerato" or "educacion-secundaria-obligatoria" this field should not be informed.

IMPORTANT: Please note in compliance with JSON format you must not send carriage returns within the value field, but replace them with "\n" instead.

Maximum length: 200

Example values: Machine Learning

startingDate

Date

Optional*

The date the course was started. Date format must be in RFC_3339 format: yyyy-MM-dd.

*This field should not be informed when the educationLevelCode is "otros-titulos".

Example values: 2003-10-01

finishingDate

Date

Optional*

The date the course was completed. It must be bigger than the starting date. Date format must be in RFC_3339 format: yyyy-MM-dd.

*This field is mandatory when educationLevelCode is "otros-titulos".

*This field is not required and should not be informed if stillEnrolled is true.

Example values: 2005-10-01

stillEnrolled

Boolean

Optional*

Whether the candidate is still enrolled in this course. Default value is false.

If set to true finishingDate should not be informed.

Example values: true

institutionName

Optional

The name of the institution where the education took place.

IMPORTANT: Please note in compliance with JSON format you must not send carriage returns within the value field, but replace them with "\n" instead.

Maximum length: 200

Example values: Broward Community College

hideEducation

Boolean

Optional

Whether the candidate wishes to display this education to companies. Default value: false.

Example values: true

Response

Response fields

Fields related to Education entity
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.

Error codes

Code	Description
361	Security exception when the Curriculum was not found or is trying to be read with no permissions.
602	The value of educationLevelCode provided: {0} is not valid.
603	A value for educationLevelCode is required.
605	The startingDate parameter is required for the levelCode selected.
606	Either finishingDate or stillEnrolled must be informed.
607	The finishingDate should be bigger than the startingDate informed: {startingDate}
608	The level code informed: {levelCode} is invalid
609	The course name provided for the educationLevelCode informed: {educationLevelCode} is invalid.
610	The course code provided: {courseCode} is invalid for the educationLevelCode informed: {educationLevelCode}
611	The institutionName provided is invalid.
612	Security exception when the experience was not found or is trying to be read with no permissions.
613	The field: {field} should NOT be informed for the educationLevelCode informed: {educationLevelCode}

Examples

In the following example the education section identified by id: "9248429800" of the curriculum identified by id "E5F8F910-0F03-F307-AC00E6E14F41414D" will be edited with the values attached in the Body Request.

Request

PUT http://api.infojobs.net/api/2/curriculum/E5F8F910-0F03-F307-AC00E6E14F41414D/education


{
     "id": 9248429800,
     "educationLevelCode": "formacion-profesional-grado-superior",
     "courseCode": "actividades-agrarias",
     "startingDate": "2005-10-01",
     "finishingDate": "2006-11-01",
     "stillEnrolled": false,
     "institutionName": "Centro",
     "hideEducation": false
}

Response


{
     "id": 14826429040,
     "educationLevelCode": "otros-titulos",
     "courseName": "Some other course",
     "finishingDate": "2012-10-01",
     "stillEnrolled": false,
     "institutionName": "Broward Community College",
     "hideEducation": false
}

InfoJobs

put/curriculum/{curriculumId}/education

Request

Resource URL

Security

Parameters

Body Request Fields

Response

Response fields

Error codes

Examples

Request

Response

Sections: