Candidate PIF Webservice
Please Note: this webservice is to be used with Old Appliciation Forms and is NOT to be used with RAC - Responsible Application Component.
The Candidate PIF Webservice (Simplified ApplicationProcess WS) gives a customer the possibility to create a flexible and bespoke one-page application process and implement it on their career site.
Using the Methods available within that web service it is possible to create candidates with their applications within TalentLink as well as adding their attachments.
This Web service includes three new methods:
- getPifStructure – this method is used to get the most recent structure of Personal Information Form (PIF) assigned to the relevant posting
- submitApplication - this method is used to create the candidate’s application in TalentLink based on provided filled forms.
- savePif – this method creates the candidate’s application in TalentLink with correctly structured PIF
- addAttachment – this method adds attachment/s to the candidate’s application created by savePif method
Typical workflow
Use Case
This new Web service supports customers in the creation of a simple application process which allows candidates to put all their data onto a single page and submit this application without going through a more complex application process extended over several pages as traditional with TalentLink.
Customers can build a custom one page application process based on the structure of the assigned PIF. Customers may then build their career site with no lay-out and style constraints.
Pre-requisites:
A candidate’s application will be created against relevant postings which first have to be fetched using dedicated web service methods available in different bundles/projects.
The structure of the PIF has to be defined in TalentLink back office and assigned to relevant application process and to relevant advertisements (known as postings). Advertisement should be posted to career site (technical ID) from where candidates will be created.
An example scenario
Building one page application process
- A configurable PIF is created in TalentLink and set as career site PIF or defined in standard /default application process for the specific organization (it is also possible to link one page application process with customized application process but then if different application processes take advantage of different PIFs, one page application process has to be created per posting, which is less stable but flexible solution)
- To retrieve the structure of the PIF assigned to relevant career site or standard application process an advertisement (or example advertisement) has to be published on that site and the interface has to call getPifStructure method.
- Based on the structure provided in the response a one page application process can be built.
Creating Candidates
- The one page application process is built.
- A job is created in TalentLink and posted to a relevant career site where a one page application process is implemented.
- The candidate completes the form (PIF) and submits their application.
- To create the candidate’s application in TalentLink against the relevant job the interface has to call the savePif method and then it passes the relevant data provided by the candidate as well as data related to posting (postingTargetID) and form (formID)
- If the candidate added attachment/s, the interface has to fetch a token from the response after running the savePif method.
- To add the attachment/s to the relevant candidate’s application the method addAttachment should be called with the file defined in a binary format (coding: Base64) as well as relevant information about attachment which should be provided in the call.
- If the candidate added more than one attachment, step 6 should be repeated as many times as required for number of attachments.
Response Format
XML
SOAP METHODS
https://api3.lumesse-talenthub.com/CareerPortal/SOAP/Simple/ApplicationProcess?wsdl
https://apiapac.lumesse-talenthub.com/CareerPortal/SOAP/Simple/ApplicationProcess?wsdl
https://api2.lumesse-talenthub.com/CareerPortal/CAT/SOAP/Simple/ApplicationProcess?wsdl
getPifStructure
This method must be called with anonymous access.
The user name must be set to the following format: TechnicalID:guest:FO.
The password must be set to "guest".
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| postingTargetId |
long | of the job Note: postingTargetID is provided by a few of our webservice methods (for example: getAdvertisements from CareerPortal > FoAdvert |
| langCode |
LangCode | If null then EN will be used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| pifStructure |
FormStructure | PIF Structure |
| FormQuestions |
List | |
| question |
FormQuestion | |
| label |
String | Question label in language defined in langCode parameter. |
| order |
Integer | Order of the question in structure. |
| SubQuestions |
List | |
| subQuestion |
FormQuestion | |
| repeatable |
Boolean | If true – more than one instance of answer for the question is allowed; if false – only one instance is allowed |
| required |
Boolean | If true – answer for the question is required; if false – answer is optional. |
| ValidationRules |
List | |
| validationRule |
ValidationRule | |
| type |
String | Type of validation (for example: maxLength). |
| value |
String | Definition of validation (number of characters allowed) or definition of question (free_text). |
| answerable |
Boolean | If true – answer for the question can be created; if false – answer cannot be created (for example: it is section label) |
| Options |
List | |
| option |
Option | |
| label |
String | Option (answer) label in language defined in langCode parameter |
| DependantQuestionIds |
List | |
| dependantQuestionId |
Long | |
| Options |
List | |
| option |
Option | |
| id |
Long | ID of relevant option (answer) assigned to question |
| id |
Long | ID of relevant question assigned to PIF structure |
| formSettings |
FormSettings | |
| langCode |
LangCode | Language of the form (please see localization view of PIF in TlanetLink back office to define relevant translations). All questions will be provided in defined language. |
| id |
Long | ID of the PIF which is linked with defied posting (via postingTargetID) |
addAttachment
This method must be called with anonymous access.
The user name must be set to the following format: TechnicalID:guest:FO.
The password must be set to "guest".
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| pifAttachment |
PifAttachment | to be added |
| attachmentType |
PifAttachment.AttachmentType | Type of attached file. NOTE: Supported values are – RESUME, COVER_LETTER, OTHER. |
| langCode |
LangCode | If null then EN will be used. Click to see possible values |
| binaryData |
DataHandler | The binary representation of the file. |
| fileName |
String | Name of the file with file extension. |
| token |
String | NOTE: Token is provided as a response after successfully executed savePif method. |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| void |
void |
submitApplication
This method must be called with anonymous access.
The user name must be set to the following format: TechnicalID:guest:FO.
The password must be set to "guest".
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| application |
Application | answered questions data |
| FilledForms |
List | |
| filledForm |
FilledForm | |
| formId |
Long | Id of the form being submitted |
| Answers |
List | |
| answer |
Answer | |
| questionId |
Long | ID of relevant question in PIF structure |
| SelectedOptions |
List | |
| optionId |
Long | |
| SubAnswers |
List | |
| answer |
Answer | |
| value |
String | Answer for relevant question (please see questionID) given by candidate. |
| postingTargetId |
Long | Id of the posting target related to given application. |
| langCode |
LangCode | If null then EN will be used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| submitApplication |
SavedApplication | object with token identifying the saved application. |
| token |
String | Token uniquely identifying submitted application. |
savePif
This method must be called with anonymous access.
The user name must be set to the following format: TechnicalID:guest:FO.
The password must be set to "guest".
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| pif |
Pif | answered questions data |
| formId |
Long | ID of the PIF which is linked with defied posting (via postingTargetID) |
| Answers |
List | |
| answer |
Answer | |
| questionId |
Long | ID of relevant question in PIF structure |
| SelectedOptions |
List | |
| optionId |
Long | |
| SubAnswers |
List | |
| answer |
Answer | |
| value |
String | Answer for relevant question (please see questionID) given by candidate. |
| postingTargetId |
Long | postingTargetID of the job Note: postingTargetID is provided by a few of our webservice methods (for example: getAdvertisements from CareerPortal > FoAdvert |
| langCode |
LangCode | If null then EN will be used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| savedPif |
SavedPif | object with token identifying the saved PIF. |
| token |
String | Token uniquely identifying submitted application. |