Document
This service can be used to retrieve structured documents and attachments related to Candidates and Postings.
Typical workflow
Use Case
The Document API can be used to obtain candidate information from the application process within the TalentLink system. THE ERP system can retrieve attached documents along with structure documents of candidate profile.
Pre-condition -
- Role Access must be given within the TalentLink system to specific attachments.
- Certain documents are only available to be retrieved if marked to be made available within the Job Posting.
Scenario
- Candidate application questionnaire and answers are stored as structured documents. These can be retrieved by the client, End Users HRIS and Back office system.
- Recruiter can attach certain specific documents to be used in the Front office and these can be retrieved by specifying the document ID using the method getDocumentsByApplicationId.
- To download the attached file, use the method downloadAttachedFile, a document ID will be required, to retrieve document ID’s use the appropriate operation to get this ID.
(For example: use method getAttachments from the Posting web service.) - These documents are required by either Client HRIS/BO system, Candidate Portals, Job Boards etc.
Response Format
XML
SOAP METHODS
https://api3.lumesse-talenthub.com/HRIS/SOAP/Document?WSDL
https://apiapac.lumesse-talenthub.com/HRIS/SOAP/Document?WSDL
addTag
Adds tag value and category to specified document.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentId |
Long
|
ID of the document. |
| tagName |
String
|
Name of tag. |
| tagTypeName |
String
|
Name of the tag type. |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| void |
Void
|
downloadAttachedFile
This method returns brief information of the file that is requested to be downloaded. As part of the response the file is sent as a soap attachment (base64-encoded binary in XML).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentId |
Long
|
ID of the file to be downloaded |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| attachedFile |
AttachedFileDto
|
Dto containing info about downloaded attached file |
| id |
Long
|
TLK Internal ID |
| fileName |
String
|
[mandatory] Name of the file with file extension |
| description |
String
|
Description of the file. |
| docType |
DocumentType
|
[mandatory] Business type of the current document (cover letter, resume, mail...) Click to see possible values |
| docLanguage |
String
|
Language code used whilst uploading of the document. |
| binaryData |
DataHandler
|
The binary representation of the file |
| creationDate |
Date
|
Time and date of the document was added to the post |
| size |
Long
|
Size of file |
| author |
String
|
Name of the user who uploaded the document |
| docId |
Long
|
ID for the document that needs to be used for downloading the attachements. (Use method downloadAttachedFile within the Document web service to download). |
| publishable |
Boolean
|
TRUE or FALSE |
downloadSharedDocument
Returns shared document (template) with given id. File is sent as SOAP attachment (base64-encoded binary in XML). This method can be called either by FO candidate (only documents for logged FO Candidate should be accessible) or by BO user (only documents accessible for BO user should be accessed, based on logged user roles).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| templateId |
Long
|
ID of template to download |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| attachedFile |
AttachedFileDto
|
Dto containing info about downloaded shared document |
| id |
Long
|
TLK Internal ID |
| fileName |
String
|
[mandatory] Name of the file with file extension |
| description |
String
|
Description of the file. |
| docType |
DocumentType
|
[mandatory] Business type of the current document (cover letter, resume, mail...) Click to see possible values |
| docLanguage |
String
|
Language code used whilst uploading of the document. |
| binaryData |
DataHandler
|
The binary representation of the file |
| creationDate |
Date
|
Time and date of the document was added to the post |
| size |
Long
|
Size of file |
| author |
String
|
Name of the user who uploaded the document |
| docId |
Long
|
ID for the document that needs to be used for downloading the attachements. (Use method downloadAttachedFile within the Document web service to download). |
| publishable |
Boolean
|
TRUE or FALSE |
getBasicStructuredDocumentDtoById
Returns StructuredDocumentDto searched by id.
This method can be called by FO or BO user.
- For FO User - method will display only documents available in CHP.
- For BO user - document should be returned only in case when user has rights to access it.
This method can be called by FO or BO user.
- For FO User - method will display only documents available in CHP.
- For BO user - document should be returned only in case when user has rights to access it.
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentId |
Long
|
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| structuredDocumentDto |
StructuredDocumentDto
|
Structured document with answers or null if not found |
| questions |
List
|
List of questions for document |
| questions |
AssignedQuestionDto
|
Document question |
| id |
Long
|
Assigned question ID that is specific for document, copy of the question from template, form |
| label |
String
|
Question label |
| order |
Long
|
Order of a question in the form |
| type |
String
|
Answer type |
| localizedLabel |
String
|
Question label translated to the language specified in langCode |
| questionId |
Long
|
Question ID that value does not changed for documents based on the same form |
| index |
Integer
|
Question index |
| id |
Long
|
Assigned question ID that is specific for document, copy of the question from template form |
getDocumentsByApplicationId
Returns list of brief information of the STRUCTURED documents which belong to a given application. List will contain only documents which can be viewed by the requesting user.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| applicationId |
Long
|
Id of the application for which the list of structured document information to be returned. |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| document |
List
|
List of candidate documents informations |
| id |
Long
|
Unique Id of the document |
| applicationId |
Long
|
Id of the application this document belongs to. |
| name |
String
|
Name of the current Document |
| description |
String
|
Free text description of the current document. |
| documentType |
String
|
Business type of the current document (cover letter, resume, mail...) Click to see possible values |
| 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. |
| author |
String
|
Author of the document - person who created structured document or uploaded file. |
| creationDate |
Date
|
Date when the current document was first created |
| lastUpdateDate |
Date
|
Date when the current document was last modified. |
getDocumentsByCandidateId
Returns list of brief information of ALL documents which belong to a given Candidate. List will contain only documents which can be viewed by the requesting user.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| candidateId |
Long
|
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| document |
List
|
List of candidate documents informations |
| id |
Long
|
Unique Id of the document |
| applicationId |
Long
|
Id of the application this document belongs to. |
| name |
String
|
Name of the current Document |
| description |
String
|
Free text description of the current document. |
| documentType |
String
|
Business type of the current document (cover letter, resume, mail...) Click to see possible values |
| 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. |
| author |
String
|
Author of the document - person who created structured document or uploaded file. |
| creationDate |
Date
|
Date when the current document was first created |
| lastUpdateDate |
Date
|
Date when the current document was last modified. |
getFormAnsweredByDocumentId
Returns FormAnsweredDto constucted from a structured document with provided id. This method can be called by FO user (method will display only documents from CHP) or BO user (user need to have acces to the document).
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentId |
Long
|
Id of the document, cannot be null |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| formAnsweredDto |
FormAnsweredDto
|
Sctructured document with answers or null if not found |
| questionsAnswered |
QuestionsAnsweredDto
|
|
| questionAnswered |
QuestionAnsweredDto
|
|
| answerTextValue |
String
|
Free form answer |
| 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
|
|
| lovValue |
String
|
Answer must match value from list of values assigned to a question |
| competencyOption |
Long
|
ID of the selected option |
| index |
Integer
|
Sub-question position on the list of questions |
| children |
List
|
List of sub-questions |
| childQuestionAnswered |
QuestionAnsweredDto
|
|
| questionId |
Long
|
[mandatory] Question ID that is being answered |
getFreeFormDocumentById
Returns a free form document by id.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentId |
Long
|
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| freeFormDocument |
FreeFormDocumentDto
|
Free form document or null if not found |
| content |
String
|
|
| documentType |
String
|
getMailDocumentById
Returns the email document with all attachments.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentId |
Long
|
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| mailDocument |
MailDto
|
Details of the email |
| from |
String
|
Sender's email |
| subject |
String
|
Subject of the email |
| sentDate |
Date
|
Date of the email |
| content |
String
|
Content of the email (body). |
| type |
String
|
Type of the email. |
| attachments |
List
|
List and details of the attached documents. |
| attachment |
DocumentBaseDto
|
Document object. |
| id |
Long
|
Unique Id of the document |
| applicationId |
Long
|
Id of the application this document belongs to. |
| name |
String
|
Name of the current Document |
| description |
String
|
Free text description of the current document. |
| documentType |
String
|
Business type of the current document (cover letter, resume, mail...) Click to see possible values |
| 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. |
| author |
String
|
Author of the document - person who created structured document or uploaded file. |
| creationDate |
Date
|
Date when the current document was first created |
| lastUpdateDate |
Date
|
Date when the current document was last modified. |
getStructuredDocumentById
This method returns structure document/questionnaires with answers for a specified id. Document is returned only in case where the user rights to access it.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| documentId |
Long
|
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| structuredDocument |
FullStructuredDocumentDto
|
Structured document with answers or null if not found |
| objectType |
String
|
Constant Value STRUCTURED |
| formCreationDate |
Date
|
Date when the current document was first created. Marked to be deprecated. |
| lastModified |
Date
|
Date when the current document was last modified. Marked to be deprecated. |
| answers |
List
|
Answers relevant to the current document. This could be 1 or more… |
| answer |
FullAnswerDto
|
Represents an answer given by a candidate to a question in a generic form. This could be 1 or more… |
| id |
Long
|
Unique ID of the current assigned question. |
| order |
Long
|
Relative order of the current answer in its corresponding document. |
| creationDate |
Date
|
Date when the current answer was given. |
| dateAnswer |
Date
|
Answer content for questions of type date. |
| freeText |
String
|
Free text attached to the current answer. |
| creatorType |
String
|
Creator type assigned to the current answer. |
| assignedQuestion |
FullAssignedQuestionDto
|
Assigned question for which the current answer has been given. Represents an answer given by a candidate to a question in a generic form. This could be 1 or more… |
| id |
Long
|
Unique ID of the current assigned question. |
| order |
Long
|
Ordinal value for the current assigned question |
| scoreMultiplier |
Long
|
Score Multiplier for the current assigned question |
| type |
QuestionType
|
Type of the current question. Click to see possible values |
| unlocalValue |
String
|
Un-localized value for the current assigned question. |
| hasChildren |
Boolean
|
Whether the current question has children. |
| repeatable |
Boolean
|
Whether the current question may be answered more than once. |
| privateQuestion |
Boolean
|
Whether the current question is private. Set in diversity questions. |
| children |
FullAnswerDto
|
Ordered set of relationships (sub-questions) for this question. |
| selectedOptions |
FullSelectedOptionDto
|
Set of selected options for the current answer. This can be 1 or more. |
| id |
Long
|
Unique ID of the current selected option. |
| assignedOption |
FullAssignedOptionDto
|
Assigned option the current selected option is based on. |
| id |
Long
|
Unique ID of the current assigned option. |
| order |
Long
|
Order where the current option is placed among all the options. |
| optionScore |
Long
|
Value which the current option is assigned. |
| hasScore |
Boolean
|
Whether there is a score assigned to the current option. |
| default |
Boolean
|
Whether the current assigned option is a default one among others. |
| unlocalValue |
String
|
Un-localized value for the current assigned option. |
| isCandidateAnswer |
Boolean
|
Tells if this answer was given by a candidate him/herself or by a TLK user. Returns "true" if answer was given by a candidate, "false" if by a TLK user. |
| readOnly |
Boolean
|
Whether allowed to be editable. |
| score |
Long
|
Score assigned to the current document. |
| id |
Long
|
Unique Id of the document |
| name |
String
|
Name of the current Document |
| type |
String
|
Do not use it is only for backward compatibility of WebServices. |
| author |
String
|
Name of the author of the current document. May also contain the name of the system that created the document if the real author's name is not available. |
| description |
String
|
Free text description of the current document. |
| origin |
String
|
The process that originated the current document. (ApplicationProcess, Others...). |
| creationDate |
Date
|
Date when the current document was first created. |
| updateDate |
Date
|
Date when the current document was last modified. |
| versionDate |
Date
|
Date of the current version |
| publishable |
Boolean
|
Flag / Info on whether the file can be publishable. |
| openingId |
Long
|
Helper method used for example during marshalling process. Returns only openingId instead of whole object. |
| applicationId |
Long
|
ID of the application |
| candidateId |
Long
|
ID of Candidate |
| departmentId |
Long
|
ID of Organization |
getTagTypes
Returns collection of all documents which can be searched by tag name and tag category (documents which have tags added).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| type |
Collection
|
Collection of documents searched by tag name and tag category |
| labelKey |
String
|
[optional] Tag type label |
| name |
String
|
Tag type name |
getTaggedDocuments
Returns the list of documents with given tag.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| tagName |
String
|
Name of tag. |
| tagTypeName |
String
|
Name of the tag type. |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| document |
Collection
|
Returns list of tags with specified tag type. |
| id |
Long
|
Unique Id of the document |
| applicationId |
Long
|
Id of the application this document belongs to. |
| name |
String
|
Name of the current Document |
| description |
String
|
Free text description of the current document. |
| documentType |
String
|
Business type of the current document (cover letter, resume, mail...) Click to see possible values |
| 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. |
| author |
String
|
Author of the document - person who created structured document or uploaded file. |
| creationDate |
Date
|
Date when the current document was first created |
| lastUpdateDate |
Date
|
Date when the current document was last modified. |
getTagsForType
Returns list of tags with specified tag type.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| tagTypeName |
String
|
Name of the tag type. |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| tag |
Collection
|
List of tags for specified tag type |
| labelKey |
String
|
[optional] Tag label |
| name |
String
|
Tag name |
| type |
TagTypeDto
|
Tag type |
| labelKey |
String
|
[optional] Tag type label |
| name |
String
|
Tag type name |