Talent Documents
This Webservice allows candidates to manage their documents and personal data.
Response Format
XML
https://api3.lumesse-talenthub.com/CareerPortal/SOAP/TalentDocuments?wsdl
SOAP METHODS
getDocumentContentById
The method getDocumentContentById returns specified document in binary form. Please note: Documents that were uploaded during application process are returned in original. All structured documents are converted into PDF. LangCode is used to provide localized version of structured documents. This method must be called with candidate credentials. The user name must be set to the following format for example: TechnicalID:saif:FO The password must be the candidates password used for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentId |
Long | [mandatory] Document ID of document that belongs to candidate. |
| langCode |
LangCode | Language code Used for translation of document labels and error messages If not provided then site master language is used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentContent |
DocumentContentDTO | |
| documentName |
String | Document name it can be form name for structured document or name of uploaded file. |
| mimeType |
String | Document mime type. |
| content |
byte | Document binary content. |
getListByApplicationId
The method getListByApplicationId returns list of documents connected with application. LangCode is used to provide localized names of structured documents. This method must be called with candidate credentials. The user name must be set to the following format for example: TechnicalID:saif:FO The password must be the candidates password used for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| applicationId |
Long | [mandatory] ApplicationId ID for which documents should be listed. |
| langCode |
LangCode | Language code Used for translation of document labels and error messages If not provided then site master language is used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| Document |
List | Document object |
| description |
String | Free text description of the current document. |
| author |
String | Author of the document - person who created structured document or uploaded file. |
| name |
String | Document name. It can be file name, form name that was used for structured document or name modified in TLK BO. |
| applicationId |
Long | Id of the application this document belongs to. |
| objectType |
String | Type of document that can be used to distinct between uploaded file - ATTACHEDFILE or form based document- STRUCTURED or free form document - FREEFORM. |
| documentType |
String | Type of document content RESUME, COVERLETTER, OTHER, etc. |
| id |
Long | Id of the document. |
| lastUpdateDate |
Date | Date and time when document was updated last time. For new document lastUpdateDate = creationDate. |
| creationDate |
Date | Date and time when document was created or uploaded. Time offset is provided. |
removeDocuments
This method allows to remove candidate documents (both binary or based on structured form). This method must be called with candidate credentials. The user name must be set to the following format for example: TechnicalID:saif:FO The password must be the candidates password used for example: "Saif123!""
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentIds |
java.util.List |
[mandatory] Document ID that is expected to be removed. Element can be repeated to delete multiple documents. |
| langCode |
LangCode | Language code Used for translation of error messages If not provided then site master language is used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| void |
void |
updatePif
This method updates candidate's Personal Information Form (PIF) based on the provided parameters. Please note: answers must be provided to all questions marked as required (validation mechanism in place). If the answers are not valid for related questions then method throws an exception with detailed information about the cause of the error. Error message is localized according to the language specified by langCode parameter. If any error occurs then nothing is updated. This method must be called with candidate credentials. The user name must be set to the following format for example: TechnicalID:saif:FO The password must be the candidates password used for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| form |
FormAnsweredDto | form filled in with answers for questions coming from PIF structure. |
| questionsAnswered |
QuestionsAnsweredDto | |
| questionAnswered |
QuestionAnsweredDto | |
| questionId |
Long | [mandatory] Question ID that is being answered |
| lovValue |
String | Answer must match value from list of values assigned to a question |
| answerTextValue |
String | Free form answer |
| index |
Integer | Sub-question position on the list of questions |
| children |
List | List of sub-questions |
| childQuestionAnswered |
QuestionAnsweredDto | |
| competencyOption |
Long | |
| selectedAssignedOptionIds |
List | Option IDs that are selected as answers for a question. Can be selected more then one options if question is multiple-choice. |
| assignedOptionId |
Long | |
| langCode |
LangCode | Language code Used for translation of validation failures and error messages If not provided then site master language is used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| void |
void |
updateQuestions
Method allows to update the content of candidate personal information file (structured document) question by question. If the answers are not valid for related questions then method throws an exception with detailed information about the cause of the error. Error message is localized according to the language specified by langCode parameter. If any error occurs then nothing is updated. This method must be called with candidate credentials. The user name must be set to the following format for example: TechnicalID:saif:FO The password must be the candidates password used for example: "Saif123!
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| form |
FormAnsweredDto | filled in with answers for questions coming from PIF structure. |
| questionsAnswered |
QuestionsAnsweredDto | |
| questionAnswered |
QuestionAnsweredDto | |
| questionId |
Long | [mandatory] Question ID that is being answered |
| lovValue |
String | Answer must match value from list of values assigned to a question |
| answerTextValue |
String | Free form answer |
| index |
Integer | Sub-question position on the list of questions |
| children |
List | List of sub-questions |
| childQuestionAnswered |
QuestionAnsweredDto | |
| competencyOption |
Long | |
| selectedAssignedOptionIds |
List | Option IDs that are selected as answers for a question. Can be selected more then one options if question is multiple-choice. |
| assignedOptionId |
Long | |
| langCode |
LangCode | Language code Used for localizing question language and translation of and error messages If not provided then site master language is used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| void |
void |
viewPif
The method returns list of pairs (question and answer) currently available in candidate personal information file structured document. This method must be called with candidate credentials. The user name must be set to the following format for example: TechnicalID:saif:FO The password must be the candidates password used for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| langCode |
LangCode | Language code Used for translation of document labels and error messages If not provided then site master language is used. Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| pif |
StructuredDocumentDto | Pif document |
| questions |
List | |
| questions |
AssignedQuestionDto | Question and answer. |
| label |
String | Question label |
| questionId |
Long | Question ID that value does not changed for documents based on the same form |
| order |
Long | Order of a question in the form |
| type |
String | Answer type |
| localizedLabel |
String | Question label translated to the language specified in langCode |
| answer |
AnswerDto | Answer element is returned if question is simple, in case complex this value is returned inside children questions |
| values |
List | List of answers |
| value |
String | |
| index |
Integer | |
| id |
Long | Assigned question ID that is specific for document, copy of the question from template, form |
| children |
List | children question list |
| children |
AssignedQuestionDto | Question and answer. |
| id |
Long | Assigned question ID that is specific for document, copy of the question from template form |