post/offer/{offerId}/application
The authenticated user uses this operation to make a job application for the indicated offer. It is imporant to notice that some offers include several questions that should be answered as a requirement to complete the application. These questions are called Killer Question for the multiple choice ones, and Open Questions for those the answer is a free input text. This operation has been developed to optimize the process of applying to an offer from a mobile device. It allows to edit an existing coverletter at the same time the application is submited. So if a user decides to save the coverletter they just used for the future they can do so by informing the field "doSave".
Request
Resource URL
https://api.infojobs.net/api/4/offer/{offerId}/application
Security
- User Role: role_candidate
- Scope: my_applications
Parameters
Name | Description |
---|---|
offerId Required |
Offer identifier. Example values: 1ea3d2bedb4940bc83aad93726cb16 |
Body Request Fields
Its structure is specified in the example below.
{ "curriculumCode":"25910c23-37cd-40f6-97ca-9aa1e1959002", "coverLetter":{ "name": "Carta 1", "key": "4961a461-23b3-44ed-a424-56a458df5c14", "main": false, "text": "My old coverletter with some changes that I could like to save.", "doSave": true }, "offerOpenQuestions":[ { "id": 2391697190, "answer": "Si, vivo en Barcelona." } ], "offerKillerQuestions":[ { "id": 2391697192, "answerId":2391697196 }, { "id": 2391697192, "answerId":2391697196 } ] }
Field Name | Description |
---|---|
curriculumCode String Optional |
The code that identifies the cv to be used for this application. If this field is not informed the default cv will be used. The operation /operation/curriculum-list returns all available cv for the authenticated user. Example values: E5F8F910-0F03-F307-AC00E6E14F41414D Maximum length: 100 |
coverLetter Optional* |
A coverletter to be used with the current application, this parameter is optional. If not informed no coverletter will be included. For more information review the section CoverLetter. The operation operation/coverletter-list returns all available coverletters for the authenticated user. Example values: "coverLetter":{ "name": "Carta 1", "key": "4961a461-23b3-44ed-a424-56a458df5c14", "main": false, "text": "My old coverletter with some changes that I could like to save", "doSave": true }
|
offerKillerQuestions Required* |
An array of Killer Questions Answers required by the offer. *If the offer has not killer questions, this parameter is optional. The operation /operation/offer-killerquestion-list returns all available killer questions for the given offerId. Example values: "offerKillerQuestions":[ { "id": 2391697192, "answerId":2391697196 }, { "id": 2391697192, "answerId":2391697196 } ]
|
offerOpenQuestions Required* |
An array of Open Questions Answers required by the offer. *If the offer has no open questions, this parameter is optional. The operation /operation/offer-openquestion-list returns all available open questions for the given offerId. IMPORTANT: Please note in compliance with JSON format you must not send carriage returns within the value field, but replace them with "\n" instead. Example values: "offerOpenQuestions":[ { "id": 2391697190, "answer": "Si, vivo en Barcelona." } ],
|
Name | Description |
---|---|
key String Optional |
The coverletter unique identifier. If this field is not informed and the field doSave is set to true an attempt to save the coverletter as new item will be made. If this is informed it must be a valid coverletter key or an exception will be thrown. If this field is informed and the field doSave is set to true the coverletter identified by the key provided will be updated. Maximum length: 100 |
name String Required |
The coverletter title. Maximum length: 100 |
text String Required |
The coverletter description. If this field is not informed an exception will be thrown. The cover letter in text format to be edited. It must be in "UTF-8" format. 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: 4000 |
main Boolean Optional |
True if the given coverletters is to be set as the default one. |
doSave Boolean Optioanl |
True if you wish to save the given coverletter for future use. Default: false. |
Response
Response fields
Name | Description |
---|---|
code |
Application identifier. |
cv |
Name of the CV used by the candidate to apply for the offer. |
hasCoverLetter |
Returns true when the candidate has used a cover letter on the application, false otherwise. |
coverLetterSavedKO |
Returns true when the user requested to save the coverletter used for this application and some problem occured during the saving process, false otherwise. |
eventsReadPending |
Number of events pending to read by the candidate in this application timeline. |
date |
Indicates when the candidate has been applied for the offer. |
Code | Description |
---|---|
313 |
The indicated offer in the request is not a valid parameter, maybe it doesn't exists or it is not active at this moment. |
314 |
The application could not be created successfully. |
315 |
The answer in the request is not a valid parameter for a specific question, perhaps it does not exist (Killer Questions) or it is empty (Open Questions). |
316 |
The selected CV in the request is not a valid parameter, perhaps it does not exist or it's incomplete or it does not belong to the authenticated user. |
317 |
The application for the offer already exists with the authenticated user. |
322 |
The offer has his own external url to apply. You must redirect the user to this url. You can read this url from field externalUrlForm. |
340 |
The selected cover letter in the request is not a valid parameter, perhaps it does not exist or it does not belong to the authenticated user. |
341 |
The coverletter text is invalid, it should be less than 4000 characters long. |
Examples
This example makes an application for the offer identified by "1ea3d2bedb4940bc83aad93726cb16". The authenticated user wants to use their CV identified by code "25910c23-37cd-40f6-97ca-9aa1e1959002" and use a cover letter named "Carta 1". He answers two killer questions and one open question: in the first two he selects a correct answer from the list and in the second one he writes the answer.
Request
POST http://api.infojobs.net/api/4/offer/1ea3d2bedb4940bc83aad93726cb16/application
{ "curriculumCode":"25910c23-37cd-40f6-97ca-9aa1e1959002", "coverLetter":{ "name": "Carta 1", "key": "4961a461-23b3-44ed-a424-56a458df5c14", "main": false, "text": "My old coverletter with some changes that I could like to save.", "doSave": true }, "offerOpenQuestions":[ { "id": 2391697190, "answer": "Si, vivo en Barcelona." } ], "offerKillerQuestions":[ { "id": 2391697192, "answerId":2391697196 }, { "id": 2391697192, "answerId":2391697196 } ] }
Response
{ "hasCoverLetter": true, "coverLetterSavedKO": false, "cv": "auto_cand32", "code": "e58f7150-e3f4-4657-84fa-e71e4f53bf89", "date": "2015-03-02T08:39:22.000+0000", "eventsReadPending": 0 }