put/curriculum/{curriculumId}/personaldata
Allows to edit the personal data section of a given curriculum for the authenticated user. In the personal data section the candidate can provide information about his localization like country and province and also contact details like his phone number and his mobile phone number.
Request
Resource URL
https://api.infojobs.net/api/3/curriculum/{curriculumId}/personaldata
Security
- User Role: role_candidate
- Scope: candidate_edit_curriculum_personal_data
Parameters
Name | Description |
---|---|
curriculumId String Required |
Identifier of the curriculum to edit. This curriculum must belongs to the authenticated user. Example values: 70628530-6d45-483a-8327-d8c81b |
Body Request Fields
Its structure is specified in the example below.
{ "name": "Pepe", "surname1": "Lopez", "surname2": "Perez", "gender": "hombre", "nationalIdentityCardType": "pasaporte", "nationalIdentityCard": "AA1234568", "birthDay": "1985-02-12", "country": "espana", "province": "barcelona", "cityCode": "barcelona", "zipCode": "08765", "preferredContactPhone": "mobile-phone", "mobilePhone": "655777434", "driverLicenses": [ "a" ], "vehicleOwner": true, "freelance": true, "nationalities": [ "espana" ] }
Field Name | Description |
---|---|
name String Required |
Candidate's name. *This field is mandatory. Example values: Pepe Maximum Length: 50 |
surname1 String Required |
Candidate's family name. *This field is mandatory in Spain. Example values: Lopez Maximum Length: 50 |
surname2 String Optional |
Candidate's second family name. *This field is mandatory in Spain. Example values: Perez Maximum Length: 50 |
nationalIdentityCardType String Required* |
The type of identification the candidate has provided. The operation /dictionary/id-type returns all available values. *This field should not be informed in the rest of countries. Example values: pasaporte |
nationalIdentityCard String Required |
The national identity card informed by the candidate. *This field should not be informed in the rest of countries. Example values: AA1234568 Maximum Lenth: 15 |
birthDay Date Required |
The candidate's date of birth. Date format must be in RFC_3339 format: yyyy-MM-dd. The candidate's age must be between 16 and 80 years old. Example values: 1985-02-12 |
gender String Required |
The candidate's gender. The operation /dictionary/gender returns all available values. Example values: mujer |
country String Required |
The country the authenticated user inhabits. The operation /dictionary/country returns all available values. Example values: espana NOTE: Some of the dictonary values are continents, so, ensure only country values are used for this operation. |
province String Required |
The province the authenticated user inhabits. The operation /dictionary/province returns all available values. Example values: barcelona |
cityCode String Optional (if set, then cityName is skipped) NOTE: At least one cityCode or cityName is required. The use of cityCode is recommended
|
The city the authenticated user inhabits. The operation /dictionary/city returns all available values. Example values: sabadell |
cityName String Optional (skipped when cityCode is used) NOTE: At least one cityCode or cityName is required. The use of cityCode is recommended
|
The name of the city where the authenticated user inhabits. Use this property as an exception when the city you want to use is not in the city's dictionary Example values: Riobamba |
zipCode String Required |
The zip code the authenticated user inhabits. Depending of the country, the zip code is 5 numeric characters long or more (leading zeros must be included). Example values: 28007 |
address String Optional |
The home address the authenticated user inhabits. Example values: Villarroel 2, 1 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: 100 |
preferredContactPhone String Required |
Which user phone is preferred for contact. Possible values are foreign-phone, mobile-phone, land-line-phone. Example values: mobile-phone |
mobilePhone String Required if preferredContactPhone is set to mobile-phone |
The mobile phone of the authenticated user. The phone does not include the country area and is composed by numerical characters. Depending of the country the phone is 9 numeric characters long or more. Example values: 695190828 |
landLinePhone String Required if preferredContactPhone is set to land-line-phone |
The regular phone line of the authenticated user. The phone does not include the country area and is composed by numerical characters. Depending of the country the phone is 9 numeric characters long or more. Example values: 912738394 |
internationalPhone String Required if preferredContactPhone is set to foreign-phone |
The foreign phone of the authenticated user. The phone contains the country code and is composed by an optional plus sign followed by up to 20 numeric characters Example values: +59322575859 Maximum length: 20 |
webpages Array(URL) Optional |
An array of URL objects where the first String is a URL like http://facebook.com/usersample and the second String is an optional URL type like facebook or twitter. The operation /dictionary/url-type returns all available URL type values. The URL entity is detailed bellow. NOTE: the type value is optinal, and normally this value is automatically calculated by the InfoJobs API service Example URL values: http://facebook.com/usersample, http://twitter.com/usersample, http://usersamplesite.com/ Example URL type values: facebook, twitter (or even empty for autodetection) |
driverLicenses Array(String) Required |
The driver licenses the authenticated user holds. It's possible to inform multiple values. The operation /dictionary/driver-license returns all available values. Example values: a, b |
vehicleOwner Boolean Required |
True is the authenticated user has a car, false otherwise. Example values: true |
freelance Boolean Required |
True if the authenticated user wants to work as a freelance, false otherwise Example values: true |
nationalities Array(String) Required |
The countries list where the authenticated user holds a nationality. Maximum amount of nationalities informed: 5. The operation /dictionary/country returns all available values. Example values: espana NOTE: Some of the dictonary values are continents, so, ensure only country values are used for this operation. |
workPermits Array(String) Optional |
Array with the countries or regions where the authenticated user is allowed to work. The operation /dictionary/work-permit returns all available values. Example values: espana |
pendingWorkPermit String Optional |
An open text field for declaring where the authenticated user is requesting for a work permit Example values: Francia y Rusia 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: 100 |
Response
Response fields
Name | Description |
---|---|
name String |
Candidate's name. |
surname1 String |
Candidate's family name. |
surname2 String |
Candidate's family name. |
nationalIdentityCardType String |
The type of identification the candidate has provided. The operation /dictionary/id-type returns all available values. |
nationalIdentityCard String |
The national identity card informed by the candidate. |
birthDay Date |
The candidate's date of birth. Date format RFC_3339 format: yyyy-MM-dd. |
country String |
The country the authenticated user inhabits. The operation /dictionary/country returns all available values. |
province String |
The province the authenticated user inhabits. The operation /dictionary/province returns all available values. |
cityCode String |
The city the authenticated user inhabits. The operation /dictionary/city returns all available values. |
cityName String |
If the cityCode is not present, then the cityName will appear as a regular text string. Prefer to use the cityCode value since the cityName value will appear only for non recognized user cities. |
zipCode String |
The zip code the authenticated user inhabits. Depending of the country, the zip code is 5 numeric characters long or more (leading zeros must be included). |
address String |
The home address the authenticated user inhabits. Maximum length: 100 |
preferredContactPhone String |
Which user phone is preferred for contact. Possible values are foreign-phone, mobile-phone, land-line-phone. |
mobilePhone String |
The mobile phone of the authenticated user. The phone does not include the country area and is composed by numerical characters. Depending of the country the phone is 9 numeric characters long or more. |
landLinePhone String |
The regular phone line of the authenticated user. The phone does not include the country area and is composed by numerical characters. Depending of the country the phone is 9 numeric characters long or more. |
internationalPhone String |
The foreign phone of the authenticated user. The phone contains the country code and is composed by an optional plus sign followed by up to 20 numeric characters Maximum length: 20 |
webpages Array(URL) |
An array of URL objects where the first String is a URL like http://facebook.com/usersample and the second String is an optional URL type like facebook or twitter. The operation /dictionary/url-type returns all available URL type values. The URL objects are detailes in the URL Entity section |
driverLicenses Array(String) |
The driver licenses the authenticated user holds. It's possible to inform multiple values. The operation /dictionary/driver-license returns all available values. |
vehicleOwner Boolean |
True is the authenticated user has a car, false otherwise. |
freelance Boolean |
True if the authenticated user wants to work as a freelance, false otherwise |
gender String |
The gender of the candidate. The operation /dictionary/gender returns all available values. |
nationalities Array(String) |
The countries list where the authenticated user holds a nationality. The operation /dictionary/country returns all available values. |
workPermits Array(String) |
Array with the countries or regions where the authenticated user is allowed to work. The operation /dictionary/work-permit returns all available values. |
pendingWorkPermit String |
An open text field for declaring where the authenticated user is requesting for a work permit Maximum length: 100 |
URL Entitiy
URL fields
Name | Description |
---|---|
url String Required |
A valid URL like http://www.facebook.com/username or https://username.blogspot.com |
type String Optional |
The kind of URL like facebook or twitter. The operation /dictionary/url-type returns all available values. |
Error codes
Code | Description |
---|---|
361 |
The curriculum was not found or the authenticated user is not the owner. |
541 |
The field name is required. |
542 |
The field surname1 is required. |
543 |
The field surname1: SURNAME1 is invalid. It must be between 1 and 50 characters long. |
544 |
The field nationalIdCardType is required. |
545 |
The value of the national identity card type NATIONALIDENTITYCARDTYPE is not valid. |
546 |
The field nationalIdCard is required. |
547 |
The value of the national identity card NATIONALIDENTITYCARD is not valid. |
548 |
The value of the birthDay is required. |
549 |
The value of the birthDay: BIRTHDAY is not valid. |
550 |
The value of the gender GENDER is not valid. |
551 |
The value of country is not valid. |
552 |
The value of country is required. |
553 |
The value of province is not valid. |
554 |
The value of province is required. |
556 |
The length of the cityName value is not valid. |
557 |
The value of cityCode is not valid. |
558 |
The value of cityName is not valid. |
559 |
The zipCode field is required. |
560 |
The format of the zipCode value is not valid. |
561 |
The value of zipCode is not valid. Code should be numeric. |
562 |
The value of zipCode is not valid. |
563 |
The address field is required. |
564 |
The value of address is not valid. |
565 |
The preferredContactPhone is required. |
566 |
The length of the mobilePhone is not valid. |
567 |
The numeric value of mobilePhone is not valid. |
568 |
The value of landLinePhone is required if selected as preferred contact. |
569 |
The numeric value of landLinePhone is not a valid number. |
570 |
The length of thelandLinePhone value is not valid. |
571 |
The numeric value of landLinePhone is not valid. |
572 |
The value of internationalPhone is required if selected as preferred contact. |
573 |
The numeric value of internationalPhone is not valid. |
575 |
The webpages field contains the url value that is not valid. |
576 |
The webpages field contains the url type that is not valid. Look at the posible dictionary values for url-types |
577 |
The webpage field contains the url value that is not a valid URL. |
578 |
The driverLicenses field contains the value that is not valid. |
579 |
The driverLicenses field is required to contain at least one item. |
580 |
The nationalities field contains items. It can contain at most items. |
581 |
The nationalities field contains the value that is not valid. |
582 |
The nationalities field is required to contain at least one item. |
583 |
The nationalities field should not contain an empty value |
584 |
The driverLicense field should not contain an empty value |
585 |
The nationalities field contains a value which is a continent, the value should be a country. |
586 |
The pendigWorkPermit field contains an invalid length, it should be from up to characters long |
588 |
The birthdate is invalid |
589 |
The NIE is invalid |
590 |
The DNI is invalid |
591 |
The NIE is required |
592 |
The DNI is required |
593 |
The DNI length is invalid |
594 |
The value of the work permit code is not valid. |
595 |
The value of preferredContactPhone is not valid. The possible values are land-line-phone, mobile-phone or foreign-phone |
596 |
The numeric value of mobilePhone is not a valid number. |
597 |
The value of mobilePhone is required if selected as preferred contact. |
598 |
The value of cityCode or cityName are required. |
Examples
This example edits the personal data section of the given curriculum.
Request
https://api.infojobs.net/api/2/curriculum/70628530-6d45-483a-8327-d8c81b0a62ab/personaldata
{ "name": "Pepe", "surname1": "Lopez", "nationalIdentityCardType": "pasaporte", "nationalIdentityCard": "77665598A", "birthDay": "1978-10-08", "country": "espana", "gender": "hombre", "province": "barcelona", "cityName": "girona", "zipCode": "08290", "address": "Villarroel 2 1", "preferredContactPhone": "mobile-phone", "mobilePhone": "669854125", "landLinePhone": "936543212", "internationalPhone": "+0035987654321", "webpages": [ { "url": "http://usuario.blogspot.com" }, { "url": "http://www.facebook.com/usuario" } ], "driverLicenses": [ "a", "b" ], "vehicleOwner": true, "freelance": false, "nationalities": [ "espana" ], "workPermits": [ "cuba", "union-europea" ], "pendingWorkPermit": "Inicio tramite octubre 2010" }
Response
{ "name": "Pepe", "surname1": "Lopez", "surname2": "Garcia", "nationalIdentityCardType": "pasaporte", "nationalIdentityCard": "77665598A", "birthDay": "1978-10-08", "gender": "hombre", "country": "espana", "province": "barcelona", "cityCode": "seleccionar", "zipCode": "08290", "address": "Villarroel 2 1", "preferredContactPhone": "mobile-phone", "mobilePhone": "669854125", "landLinePhone": "936543212", "internationalPhone": "+0035987654321", "webpages": [ { "url": "http://usuario.blogspot.com" }, { "url": "http://www.facebook.com/usuario", "type": "facebook" } ], "driverLicenses": [ "a", "b" ], "vehicleOwner": true, "freelance": false, "nationalities": [ "espana" ], "workPermits": [ "union-europea", "cuba" ], "pendingWorkPermit": "Inicio tramite octubre 2010" }
NOTE: in this example, the cityName becomes a cityCode in the response since the city was successfully detected. Try to use cityCode preferrably. Only for non-recognized cities, the value cityName must be used.
NOTE: the webpage's URL of this example was autodetected with the type facebook. You may set the url type at the request time but is easier and more consistent to let the API service autodetect the url type.