Candidates

Candidates Web service is used to retrieve, create candidate information, along with applications made, the web service also allows uploading and attaching a file to a candidate.

There are two methods of retrieving candidates. The first is by using the candidate web service to get either a single candidate or all candidates for an organization at a particular status. The second method is to define a queue of all candidates that match a given criteria and to use the Queue web service to retrieve the candidates one at a time. The queue web service can be configured to send an alert to a URL whenever a new candidate is added to the queue.

Typical workflow Candidates

Use Case

Candidates can be raised in ERP system or an HRIS before being managed by the recruitment team in TalentLink.

Pre-condition - A candidate is created in an ERP system or HRIS.

Scenario

START. A candidate is created in an ERP system or an HRIS by a recruiter or Hiring Manager.
The ERP system or HRIS calls the TalentLink Exchange web service.
To retrieve Candidate information by a candidate ID within an ERP system or by an HRIS recruiter calls the TalentLink Exchange service getCandidateById webservice.
To check applications made by a single candidate within TalentLink use getApplicationsByCandidateId
To get contract information the ERP System or HRIS recruiter calls the TalentLink Exchange to use getContractsByApplicationId webservice, this will return all internal users, salary information, contract type and candidate information.
To upload supporting documents for a candidate for an application the web services to use is uploadAttachedFile. (For this you will require a Candidate ID and Application ID).
If TalentLink Exchange returns an error, an appropriate SOAP response is sent to the web service client (for SOAP web services).

Response Format

XML

This method accepts candidate consent 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!"

Parameter	Data Type	Description
consentId	Long	[mandatory] id of consent to accept
candidateId	Long	Id of candidate
applicationId	Long	Id of application
comment	String	Comment

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
void	Void

This method allows to add tag to the candidate. 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!"

Parameter	Data Type	Description
candidateId	Long	[mandatory] ID of the candidate.
tagName	String	[mandatory] Name of the tag.
tagTypeName	String	[mandatory] Name of tag type.

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
void	Void

This method allows to create the candidate and assign him to Candidate Pool. There can be Data Privacy Consents provided for the candidate. For each candidate consent there should be provided: - consent id - from OBS configuration - consent status - GRANTED or REVOKED_BY_USER Business Validation Errors: - Consents are provided but GDPR_BO_CONSENT is disabled. - Consent for Talent Pool is in status REVOKED_BY_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!"

Parameter	Data Type	Description
candidate	FullProfileDto
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String
folderId	Long	[mandatory]

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
candidate	FullProfileDto
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String

The method createCandidateViaJobNumber creates application for opening with given job number and candidate profile. If candidate already exists in database then its profile is used for the newly created application. If there is no such a candidate in database new one is created and the application for it. There can be Data Privacy Consents provided for the candidate. For each candidate consent there should be provided: - consent id - from OBS configuration - consent status - GRANTED or REVOKED_BY_USER Business Validation Errors - Job number can be modified in Talentlink. Therefore if the job number is used for more than one job error is returned and candidate is not created. - Opening should not be in either of status ("Closed", "Closed/Filled"); if it is then the candidate is not created. - Consents are provided but GDPR_BO_CONSENT is disabled. - Consent for Application is in status REVOKED_BY_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!"

Parameter	Data Type	Description
candidate	FullProfileDto
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String
jobNumber	String	[mandatory] Job number

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
candidate	FullProfileDto
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String

The method createCandidateViaOpening creates application for given opening and candidate profile. If candidate already exists in database then its profile is used for the newly created application. If there is no such a candidate in database new one is created and the application for it. There can be Data Privacy Consents provided for the candidate. For each candidate consent there should be provided: - consent id - from OBS configuration - consent status - GRANTED or REVOKED_BY_USER Business Validation Errors - If the passed openingId does not exist then error is returned. - Opening should not be in either of status ("Closed", "Closed/Filled"); if it is then the candidate is not created - Consents are provided but GDPR_BO_CONSENT is disabled. - Consent for Application is in status REVOKED_BY_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!"

Parameter	Data Type	Description
candidate	FullProfileDto
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String
openingId	Long	[mandatory] This is the position Id

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
candidate	FullProfileDto
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String

Returns attached document with given id. File is sent as 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!"

Parameter	Data Type	Description
documentId	Long	[mandatory] ID of the document (file).

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
attachedFile	AttachedFileDto
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

This method allows to edit existing tag names and/or types which were assigned to the candidate. 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!"

Parameter	Data Type	Description
candidateId	Long	[mandatory] ID of Candidate
tagName	String	[mandatory] Name of the existing tag.
tagTypeName	String	[mandatory] Name of the existing tag type.
newTagName	String	[mandatory] New tag name.
newTagTypeName	String	[mandatory] New name of the tag type.

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
void	Void

This method allows to retrieve details of a specific application. 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!"

Parameter	Data Type	Description
applicationId	Long
displayConsents	Boolean	[optional] when set to true candidate consents are returned for the application, null is treated as false

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
application	ApplicationDto
id	Long	Unique ID of the current application.
completionReason	String	Completion reason.
creation	Date	Creation date of the current Application.
memo	String	Miscellaneous notes attached to the current application.
srcChannelName	String	Name of the sourcing channel through which this application was obtained.
srcChannelType	String	Type of the sourcing channel through which this application was obtained.
srcMedium	String	Medium (paper, on-line, e-mail, etc) of the sourcing channel through which this application was obtained.
status	String	Current status of this application.
statusComment	String	Note on how the status of the application obtained its current value.
update	Date	Date when the current application was last updated.
applicationDate	Date	Date when the current application was created.
shortListed	Boolean	Whether this application has been marked as short-listed or not.
archived	Boolean	Is Application archived. Possible: true or false
activeApplication	Boolean	Is Application active. Possible: true or false
hasContracts	Boolean	Returns true if application has contracts, false otherwise.
document	DocumentBaseDto	List of DocumentBaseDto objects constructed from application documents
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.
candidateId	Long	ID of Candidate
positionId	Long	Job id associated with the current application
applicationHistory	List	This is a history of applications made by the candidate *
applicationFollowup	ApplicationFollowupDto	Returns set of application follow-up objects which correspond to the application statuses changed during the life of application.
id	Long	Unique ID of the current application followup.
applicationStatus	String	Application status
updateDate	Date	Last update date
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	List of candidate data privacy consents
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.

This method allows to retrieve details of all applications available for the 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!"

Parameter	Data Type	Description
page	Integer	Number of the results page
filter	String	Expression to be used to filter results
displayConsents	Boolean	[optional] when set to true candidate consents are returned for each application, null is treated as false

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
application	List
id	Long	Unique ID of the current application.
completionReason	String	Completion reason.
creation	Date	Creation date of the current Application.
memo	String	Miscellaneous notes attached to the current application.
srcChannelName	String	Name of the sourcing channel through which this application was obtained.
srcChannelType	String	Type of the sourcing channel through which this application was obtained.
srcMedium	String	Medium (paper, on-line, e-mail, etc) of the sourcing channel through which this application was obtained.
status	String	Current status of this application.
statusComment	String	Note on how the status of the application obtained its current value.
update	Date	Date when the current application was last updated.
applicationDate	Date	Date when the current application was created.
shortListed	Boolean	Whether this application has been marked as short-listed or not.
archived	Boolean	Is Application archived. Possible: true or false
activeApplication	Boolean	Is Application active. Possible: true or false
hasContracts	Boolean	Returns true if application has contracts, false otherwise.
document	DocumentBaseDto	List of DocumentBaseDto objects constructed from application documents
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.
candidateId	Long	ID of Candidate
positionId	Long	Job id associated with the current application
applicationHistory	List	This is a history of applications made by the candidate *
applicationFollowup	ApplicationFollowupDto	Returns set of application follow-up objects which correspond to the application statuses changed during the life of application.
id	Long	Unique ID of the current application followup.
applicationStatus	String	Application status
updateDate	Date	Last update date
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	List of candidate data privacy consents
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.

The method getApplicationsByCandidateId to retrieve details of applications for a specific candidate using the candidate 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!"

Parameter	Data Type	Description
candidateId	Long	[mandatory] ID of Candidate
displayConsents	Boolean	[optional] when set to true candidate consents are returned for each application, null is treated as false

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
application	List
id	Long	Unique ID of the current application.
completionReason	String	Completion reason.
creation	Date	Creation date of the current Application.
memo	String	Miscellaneous notes attached to the current application.
srcChannelName	String	Name of the sourcing channel through which this application was obtained.
srcChannelType	String	Type of the sourcing channel through which this application was obtained.
srcMedium	String	Medium (paper, on-line, e-mail, etc) of the sourcing channel through which this application was obtained.
status	String	Current status of this application.
statusComment	String	Note on how the status of the application obtained its current value.
update	Date	Date when the current application was last updated.
applicationDate	Date	Date when the current application was created.
shortListed	Boolean	Whether this application has been marked as short-listed or not.
archived	Boolean	Is Application archived. Possible: true or false
activeApplication	Boolean	Is Application active. Possible: true or false
hasContracts	Boolean	Returns true if application has contracts, false otherwise.
document	DocumentBaseDto	List of DocumentBaseDto objects constructed from application documents
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.
candidateId	Long	ID of Candidate
positionId	Long	Job id associated with the current application
applicationHistory	List	This is a history of applications made by the candidate *
applicationFollowup	ApplicationFollowupDto	Returns set of application follow-up objects which correspond to the application statuses changed during the life of application.
id	Long	Unique ID of the current application followup.
applicationStatus	String	Application status
updateDate	Date	Last update date
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	List of candidate data privacy consents
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.

This method allows to retrieve details of all applications within the specific requisition. Results are filtered based on users rights and his access. The input parameters are either JobNumber or JobID. Additionally the method uses paging system to limit the amount of results in one response. 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!"

Parameter	Data Type	Description
jobId	Long	ID of the job
jobNumber	String	Job number
page	Integer	Number of the results page
displayConsents	Boolean	[optional] when set to true candidate consents are returned for each application, null is treated as false

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
applications	List
id	Long	Unique ID of the current application.
completionReason	String	Completion reason.
creation	Date	Creation date of the current Application.
memo	String	Miscellaneous notes attached to the current application.
srcChannelName	String	Name of the sourcing channel through which this application was obtained.
srcChannelType	String	Type of the sourcing channel through which this application was obtained.
srcMedium	String	Medium (paper, on-line, e-mail, etc) of the sourcing channel through which this application was obtained.
status	String	Current status of this application.
statusComment	String	Note on how the status of the application obtained its current value.
update	Date	Date when the current application was last updated.
applicationDate	Date	Date when the current application was created.
shortListed	Boolean	Whether this application has been marked as short-listed or not.
archived	Boolean	Is Application archived. Possible: true or false
activeApplication	Boolean	Is Application active. Possible: true or false
hasContracts	Boolean	Returns true if application has contracts, false otherwise.
document	DocumentBaseDto	List of DocumentBaseDto objects constructed from application documents
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.
candidateId	Long	ID of Candidate
positionId	Long	Job id associated with the current application
applicationHistory	List	This is a history of applications made by the candidate *
applicationFollowup	ApplicationFollowupDto	Returns set of application follow-up objects which correspond to the application statuses changed during the life of application.
id	Long	Unique ID of the current application followup.
applicationStatus	String	Application status
updateDate	Date	Last update date
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	List of candidate data privacy consents
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.

This method allows to display all applications with specified status. 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!"

Parameter	Data Type	Description
page	Integer	Number of the results page
status	String	[mandatory] Status of the applications to be displayed
updatedAt	Date	[mandatory] The latest date when applications were updated
displayConsents	Boolean	[optional] when set to true candidate consents are returned for each application, null is treated as false

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
application	List
id	Long	Unique ID of the current application.
completionReason	String	Completion reason.
creation	Date	Creation date of the current Application.
memo	String	Miscellaneous notes attached to the current application.
srcChannelName	String	Name of the sourcing channel through which this application was obtained.
srcChannelType	String	Type of the sourcing channel through which this application was obtained.
srcMedium	String	Medium (paper, on-line, e-mail, etc) of the sourcing channel through which this application was obtained.
status	String	Current status of this application.
statusComment	String	Note on how the status of the application obtained its current value.
update	Date	Date when the current application was last updated.
applicationDate	Date	Date when the current application was created.
shortListed	Boolean	Whether this application has been marked as short-listed or not.
archived	Boolean	Is Application archived. Possible: true or false
activeApplication	Boolean	Is Application active. Possible: true or false
hasContracts	Boolean	Returns true if application has contracts, false otherwise.
document	DocumentBaseDto	List of DocumentBaseDto objects constructed from application documents
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.
candidateId	Long	ID of Candidate
positionId	Long	Job id associated with the current application
applicationHistory	List	This is a history of applications made by the candidate *
applicationFollowup	ApplicationFollowupDto	Returns set of application follow-up objects which correspond to the application statuses changed during the life of application.
id	Long	Unique ID of the current application followup.
applicationStatus	String	Application status
updateDate	Date	Last update date
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	List of candidate data privacy consents
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.

This method returns the full candidate information for the specified 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!"

Parameter	Data Type	Description
candidateId	Long
displayConsents	Boolean	[optional] when set to true candidate consents are returned for the candidate, null is treated as false

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
candidate	FullProfileDto
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String

This method returns candidate history splitted to two lists. First list contains automatically created history entries and the second one contains history events which were added manually. 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!"

Parameter	Data Type	Description
candidate	CandidateHistorySearchCriteriaDto	Filters to specify candidate.
candidateId	Long	Candidate ID
firstName	String	Candidate first name
lastName	String	Candidate last name
email	String	Candidate email
filters	CandidateHistoryFiltersDto	Additional filters to restrict candidate history entries.
applicationId	Long	Application ID
jobNumber	String	Job Number
openingId	Long	Opening ID
manualOnly	Boolean	Flag to filter only events which were created manually

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
candidateHistory	CandidateHistoryDto
candidateHistoryEntries	List	List of automatically created history events
candidateHistoryEntry	CandidateHistoryEntryDto	Describes automatically generated history event
date	Date	Event creation date
jobTitle	String	Job title
author	String	Author of entry
log	String	Event message
openingId	Long	Event opening Id
subject	String	Event subject
manualCandidateHistoryEntries	List	List of manually created history events
candidateHistoryEntry	CandidateHistoryEntryDto	Describes manually added history event

This method returns the Structured Documents linked with candidate. 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!"

Parameter	Data Type	Description
candidateId	Long

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
type	StructuredDocumentDto
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

This method returns a list of candidates' IDs meeting a given criteria. If no criteria is given returns IDs of all candidates that the user has access to. Result is displayed in pages (limited by the 1000 value per page). 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!"

Parameter	Data Type	Description
page	Integer	Page number. When missing first page will be returned.
candidate	CandidateSearchCriteriaDTO	Candidate search criteria.
firstName	String	Filter candidate by First Name
lastName	String	Filter candidate by Last Name
email	String	Filter candidate by Email
phoneNumber	String	Filter candidate by Phone Number. It will be filtered by Home or Work or Mobile candidate phone number.
status	String	Filter candidate by Status
departmentId	Long	Filter candidate by Internal TLK Department ID
source	String	Filter candidate by source channel name
fromCreatedDate	Date	Filter candidate by creation date
fromLastUpdateDate	Date	Filter candidate by last update date or creation date
displayNumberOfPages	Boolean	If set information about number of pages will be returned.
location	LocationSearchCriteriaDto	Location of the current position.
city	String	City/location.
country	String	Country name.
region	String	Country region.
address1	String	Street name part1
address2	String	Street name part2
zip	String	Zip code
company	String	Company where the current candidate currently works.
jobTitle	String	Name of the candidate's current position.
createTime	Date	Filter candidate by last creation date time
updateTime	Date	Filter candidate by last update date time

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
candidates	CandidateIdsDTO
result	List	List of filtered candidate IDs
candidateId	Long	Internal TLK candidate ID
numberOfPages	Integer	Information about number of all pages (one page contains 1000 results).

This method returns all contracts to which the user have access to. 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!"

Parameter	Data Type	Description
page	Integer	Number of the results page
filter	String	Expression to be used to filter results

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
contract	List
id	Long	Unique ID of the current hiring process step.
applicationId	Long	ID of application
creationUser	UserDto	User who created the current hiring process step.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
timeZoneInfo	String	Possible Values: Click here to see some examples
vendorName	String	Vendor name
communicationLang	String	Language used in candidate communication
typeOfUser	String	Represents type of user
probationaryPeriod	String	Period of time that the candidate was on probation after hiring
comments	String	Additional comments
reason	String	Reason of contract
contractComment	String	Comments for the contract
vendorDetails	String	Additional information about the vendor
updateUser	UserDto	User data of last updater
approverUser	UserDto	User who is supposed to approve the current hiring process step.
approved	Boolean	Is contract approved. Possible values: true or false
accepted	Boolean	Was contract accepted. Possible values: true or false
contractor	ContractorDto	Represents additional data about contractor
id	Integer	Internal TLK Contractor id
address1	String	Current contractor's main address.
address2	String	Current contractor's secondary address.
address3	String	Current contractor's additional address.
address4	String	Current contractor's additional address.
bankAccountName	String	Bank account name
bankAccountNumber	String	Bank account number
bankCityName	String	City where Bank is placed
bankContactName	String	Name of contact in the Bank
bankContactPhone	String	Contact phone to the Bank
bankName	String	Name of the bank
bankShortCode	String	Short code for the bank
city	String	The current contractor's city.
contactName	String	The current contractor's name.
groupName	String	Name of the group assigned to contractor
iban	String	IBAN bank account number
legalId	String	Legal ID for contractor
name	String	Name of the contractor
paymentTerms	String	Contractor payment terms
phone	String	Contractor phone
swiftCode	String	Swift code
taxId	String	Tax code
zipCode	String	Contractor Zip code
country	SimpleLovDto	Contractor country
value	String	Internal TLK LOV value
current	Boolean	Is Contract current. Possible values: true or false
taskNotification	Boolean	Is Task Notification available for this contract. Possible values: true or false
reassignTasks	Boolean	Is task reasign possible. Possible value: true or false
extension	Integer	Contract extension
candidate	ProfileDto	Candidate that is assigned to contract
id	Long	Unique ID of the current profile.
firstname	String	Candidate's first name.
lastname	String	Candidate's last name.
email	String	Candidate's email address.
tags	List	List of Tags assigned to user profile
tag	BasicTagDto	Tag assigned to user profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
middlename	String	Candidate's middle name
address	AddressFDto	Defines candidate's address
address1	String	Address part 1
address2	String	Address part 2
city	String	City
zip	String	Zip code
region	SimpleLovValueDto	Region
localizedValue	String	LOVs translated name
value	String	LOVs value
parentLovName	String	LOVs parent name
homePhone	String	Home phone number
workPhone	String	Work phone number
mobilePhone	String	Mobile phone number
fax	String	FAX number
alternateEmail	String	Alternative E-mail address
personalWebSite	String	Personal web site
country	SimpleLovValueDto	Country
personalData	PersonalDataDto	Candidates personal data
academicTitle	String	Candidate's academic title
dateOfBirth	Date	Candidate's date of birth
numberOfChildren	Integer	Number of candidate's children
citizenship	SimpleLovValueDto	Candidates citizenship
language	SimpleLovValueDto	Candidates language
maritalStatus	SimpleLovValueDto	Candidates marital status
sex	SimpleLovValueDto	Candidates sex
legacyId	String	Internal TLK candidate's legacy ID
revision	Boolean	Is Contract a revision. Possible value: true or false
expenseReimbursed	Boolean	Are Expenses reimbursed in contract. Possible values: true or false
taskOverdue	Long	Task overdue days
schedule	ScheduleDto	Represents contract schedule
type	SimpleLovDto	Type of the current work schedule.
workAmount	Float	Quantity of working time-units covered by the current schedule.
workPeriod	SimpleLovDto	Period in which the quantity of work is expressed in this schedule.
workUnit	SimpleLovDto	Time unit in which the quantity of work is expressed in this schedule.
status	String	Status of application, for example: Submitted
type	String	Contract type
version	Integer	Version of the contract this record represents.
creation	Date	Date when the current version of the contract was created.
update	Date	Date when the current version of the contract was last updated.
approval	Date	Date of contract approval
dueDate	Date	Due date of contract
reminderDate	Date	Date of reminder
offerSentOn	Date	Date when offer were send out
contractSentOn	Date	Date when contract were send on
contractSignedOn	Date	Date when contract was signed on
submitted	Date	Date when contract was submitted
acceptedDate	Date	Date when contract was accepted
bonusCondition	String	Condition(s) under which additional money bonuses may be paid.
exportReason	String	Name of the event that triggered the last export of this contract.
length	Float	Duration of the current contract in the units specified by the property lengthUnit. It isn't necessarily an integer value (eg. when lengthUnit is "month" and the contract is signed for 1 1/2 month)
lengthUnit	String	Time unit in which the length of the current contract is expressed.
plannedEndDate	Date	Planned end of contract date
plannedStartDate	Date	Planned start of contract
contractorContract	ContractorContractDto	Additional data about contractor contract
contractorType	SimpleLovDto	Represents Contractor Contract type
additionalInfo	String	Additional Information about Contractor contract
flexibilityMaxDate	Date	Contractors contract flexibility max date
flexibilityMinDate	Date	Contractors contract flexibility min date
benchmarkRate	BigDecimal	Benchmark rate for contractor contract
gainShareRate	BigDecimal	Gain share reate for contractor contract
totalClientRate	BigDecimal	Total client rate for caontractor contract
standardCurrency	SimpleLovDto	Currency used in contractor contract
standardPeriod	SimpleLovDto	Standard contract period in contractor contract
totalCost	BigDecimal	Total cost of contract
totalCostCurrency	SimpleLovDto	Currency used to calculate total cost
permanentContract	PermanentContractDto	This consists of the salary information for this contract, if not a permanentContract and is a contractor then the details will be within the contractorContract
carAllowance	Boolean	Is car allowanse possible for contractor. Possible values: TRUE or FALSE
fixedSalary	BigDecimal	This is the amount of salary for this contract, for example: 40000
fixedSalaryCurrency	SimpleLovDto	Currency for current contract possible values: Click to see possible values
fixedSalaryPeriod	SimpleLovDto	For example: Year
probationaryPeriod	String	Probation period
relocation	BigDecimal	Information about relocation
relocationCurrency	SimpleLovDto	Information about relocation currency
variableSalary	BigDecimal	Variable salary
variableSalaryCurrency	SimpleLovDto	Variable salary currency
variableSalaryPeriod	SimpleLovDto	Variable salary period
memo	String	Contract MEMO
lov	SimpleGenericLovDto	List of LOVs assigned to contract
name	String	The name by which the configurable field is known. For example: Colour
value	String	The list of selectable values associated with the configurable fields. For example: â€œRedâ€, â€œAmberâ€ and â€œGreenâ€
freeFormField	FullFreeFormFieldContractDto	List of FreeFormFields assigned to contract
name	String	Internal TLK FreeFormField name
value	String	Internal TLK FreeFormField value
field	String	Internal TLK FreeFormField field
rate	FullRateDto	List of rates assigned to contract
id	Long	Unique ID of the rate item.
rateType	SimpleLovDto	Rate type
defCondFrom	SimpleLovDto	DefCondForm
rateUnit	RateUnitDto	Describes rate unit
id	Long	Unique ID of the current rate unit item.
name	String	Name of the current rate unit.
type	SimpleLovDto	Type of the current rate unit.
chargeRate	BigDecimal	Charge rate
payRate	BigDecimal	Pay rate
paySupplier	BigDecimal	Pay supplier
supplierCharge	BigDecimal	Supplier charge
supplierRate	BigDecimal	Supplier rate
overAll	BigDecimal	Rate over all
alternativeApprovers	UserDto	List of alternative approvers for contract

The method getContractsByApplicationId to retrieve contract information to a specific application by using the applicationId. 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!"

Parameter	Data Type	Description
applicationId	Long	[mandatory] ID of Application

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
contract	List
id	Long	Unique ID of the current hiring process step.
applicationId	Long	ID of application
creationUser	UserDto	User who created the current hiring process step.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
timeZoneInfo	String	Possible Values: Click here to see some examples
vendorName	String	Vendor name
communicationLang	String	Language used in candidate communication
typeOfUser	String	Represents type of user
probationaryPeriod	String	Period of time that the candidate was on probation after hiring
comments	String	Additional comments
reason	String	Reason of contract
contractComment	String	Comments for the contract
vendorDetails	String	Additional information about the vendor
updateUser	UserDto	User data of last updater
approverUser	UserDto	User who is supposed to approve the current hiring process step.
approved	Boolean	Is contract approved. Possible values: true or false
accepted	Boolean	Was contract accepted. Possible values: true or false
contractor	ContractorDto	Represents additional data about contractor
id	Integer	Internal TLK Contractor id
address1	String	Current contractor's main address.
address2	String	Current contractor's secondary address.
address3	String	Current contractor's additional address.
address4	String	Current contractor's additional address.
bankAccountName	String	Bank account name
bankAccountNumber	String	Bank account number
bankCityName	String	City where Bank is placed
bankContactName	String	Name of contact in the Bank
bankContactPhone	String	Contact phone to the Bank
bankName	String	Name of the bank
bankShortCode	String	Short code for the bank
city	String	The current contractor's city.
contactName	String	The current contractor's name.
groupName	String	Name of the group assigned to contractor
iban	String	IBAN bank account number
legalId	String	Legal ID for contractor
name	String	Name of the contractor
paymentTerms	String	Contractor payment terms
phone	String	Contractor phone
swiftCode	String	Swift code
taxId	String	Tax code
zipCode	String	Contractor Zip code
country	SimpleLovDto	Contractor country
value	String	Internal TLK LOV value
current	Boolean	Is Contract current. Possible values: true or false
taskNotification	Boolean	Is Task Notification available for this contract. Possible values: true or false
reassignTasks	Boolean	Is task reasign possible. Possible value: true or false
extension	Integer	Contract extension
candidate	ProfileDto	Candidate that is assigned to contract
id	Long	Unique ID of the current profile.
firstname	String	Candidate's first name.
lastname	String	Candidate's last name.
email	String	Candidate's email address.
tags	List	List of Tags assigned to user profile
tag	BasicTagDto	Tag assigned to user profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
middlename	String	Candidate's middle name
address	AddressFDto	Defines candidate's address
address1	String	Address part 1
address2	String	Address part 2
city	String	City
zip	String	Zip code
region	SimpleLovValueDto	Region
localizedValue	String	LOVs translated name
value	String	LOVs value
parentLovName	String	LOVs parent name
homePhone	String	Home phone number
workPhone	String	Work phone number
mobilePhone	String	Mobile phone number
fax	String	FAX number
alternateEmail	String	Alternative E-mail address
personalWebSite	String	Personal web site
country	SimpleLovValueDto	Country
personalData	PersonalDataDto	Candidates personal data
academicTitle	String	Candidate's academic title
dateOfBirth	Date	Candidate's date of birth
numberOfChildren	Integer	Number of candidate's children
citizenship	SimpleLovValueDto	Candidates citizenship
language	SimpleLovValueDto	Candidates language
maritalStatus	SimpleLovValueDto	Candidates marital status
sex	SimpleLovValueDto	Candidates sex
legacyId	String	Internal TLK candidate's legacy ID
revision	Boolean	Is Contract a revision. Possible value: true or false
expenseReimbursed	Boolean	Are Expenses reimbursed in contract. Possible values: true or false
taskOverdue	Long	Task overdue days
schedule	ScheduleDto	Represents contract schedule
type	SimpleLovDto	Type of the current work schedule.
workAmount	Float	Quantity of working time-units covered by the current schedule.
workPeriod	SimpleLovDto	Period in which the quantity of work is expressed in this schedule.
workUnit	SimpleLovDto	Time unit in which the quantity of work is expressed in this schedule.
status	String	Status of application, for example: Submitted
type	String	Contract type
version	Integer	Version of the contract this record represents.
creation	Date	Date when the current version of the contract was created.
update	Date	Date when the current version of the contract was last updated.
approval	Date	Date of contract approval
dueDate	Date	Due date of contract
reminderDate	Date	Date of reminder
offerSentOn	Date	Date when offer were send out
contractSentOn	Date	Date when contract were send on
contractSignedOn	Date	Date when contract was signed on
submitted	Date	Date when contract was submitted
acceptedDate	Date	Date when contract was accepted
bonusCondition	String	Condition(s) under which additional money bonuses may be paid.
exportReason	String	Name of the event that triggered the last export of this contract.
length	Float	Duration of the current contract in the units specified by the property lengthUnit. It isn't necessarily an integer value (eg. when lengthUnit is "month" and the contract is signed for 1 1/2 month)
lengthUnit	String	Time unit in which the length of the current contract is expressed.
plannedEndDate	Date	Planned end of contract date
plannedStartDate	Date	Planned start of contract
contractorContract	ContractorContractDto	Additional data about contractor contract
contractorType	SimpleLovDto	Represents Contractor Contract type
additionalInfo	String	Additional Information about Contractor contract
flexibilityMaxDate	Date	Contractors contract flexibility max date
flexibilityMinDate	Date	Contractors contract flexibility min date
benchmarkRate	BigDecimal	Benchmark rate for contractor contract
gainShareRate	BigDecimal	Gain share reate for contractor contract
totalClientRate	BigDecimal	Total client rate for caontractor contract
standardCurrency	SimpleLovDto	Currency used in contractor contract
standardPeriod	SimpleLovDto	Standard contract period in contractor contract
totalCost	BigDecimal	Total cost of contract
totalCostCurrency	SimpleLovDto	Currency used to calculate total cost
permanentContract	PermanentContractDto	This consists of the salary information for this contract, if not a permanentContract and is a contractor then the details will be within the contractorContract
carAllowance	Boolean	Is car allowanse possible for contractor. Possible values: TRUE or FALSE
fixedSalary	BigDecimal	This is the amount of salary for this contract, for example: 40000
fixedSalaryCurrency	SimpleLovDto	Currency for current contract possible values: Click to see possible values
fixedSalaryPeriod	SimpleLovDto	For example: Year
probationaryPeriod	String	Probation period
relocation	BigDecimal	Information about relocation
relocationCurrency	SimpleLovDto	Information about relocation currency
variableSalary	BigDecimal	Variable salary
variableSalaryCurrency	SimpleLovDto	Variable salary currency
variableSalaryPeriod	SimpleLovDto	Variable salary period
memo	String	Contract MEMO
lov	SimpleGenericLovDto	List of LOVs assigned to contract
name	String	The name by which the configurable field is known. For example: Colour
value	String	The list of selectable values associated with the configurable fields. For example: â€œRedâ€, â€œAmberâ€ and â€œGreenâ€
freeFormField	FullFreeFormFieldContractDto	List of FreeFormFields assigned to contract
name	String	Internal TLK FreeFormField name
value	String	Internal TLK FreeFormField value
field	String	Internal TLK FreeFormField field
rate	FullRateDto	List of rates assigned to contract
id	Long	Unique ID of the rate item.
rateType	SimpleLovDto	Rate type
defCondFrom	SimpleLovDto	DefCondForm
rateUnit	RateUnitDto	Describes rate unit
id	Long	Unique ID of the current rate unit item.
name	String	Name of the current rate unit.
type	SimpleLovDto	Type of the current rate unit.
chargeRate	BigDecimal	Charge rate
payRate	BigDecimal	Pay rate
paySupplier	BigDecimal	Pay supplier
supplierCharge	BigDecimal	Supplier charge
supplierRate	BigDecimal	Supplier rate
overAll	BigDecimal	Rate over all
alternativeApprovers	UserDto	List of alternative approvers for contract

This method returns the structure of the current Candidate Profile Templates (PIF) for given template 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!"

Parameter	Data Type	Description
templateType	String	[mandatory] Name of candidate profile template type

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
type	FormDto
formDivider	Long	Divider for document scoring
archive	Boolean	Indicates if form is active or was archived
formId	Long	ID of the form
name	String	Name of the template
assignedQuestions	List	List of questions assigned to the template
assignedQuestions	AssignedQuestionDto
children	List	List of dependent questions
children	AssignedQuestionDto
assignedOptions	List	List of assigned options.
assignedOptions	AssignedOptionDto
assignedOptionId	Long	ID of assigned option.
dependingQuestionIds	List	List of depending questions
assignedQuestionId	Long	ID of depending questions
optionId	Long	ID of the option
order	Long	Order of the displayed options
optionScore	Long	Score of the selected option.
hasScore	Boolean	Indication whether the scoring is present for the candidate.
default	Boolean	Indication wehether the question is default.
unlocalValue	String	Unlocalized value of the option name
localizedLabel	String	Localized label of the option name
assignedQuestionId	Long	ID of the assigned question.
documentType	String	Type of the candidate profile document
scoreMultiplier	Long	Score multiplier (if defined in BO).
tempImagePath	String	URL path to a image used in 'Image Questions'
questionCategory	String	Category of the question
privateQuestion	Boolean	Indication whether the question is private.
mapped	Boolean	Indication whether the question is mapped.
mappingDescription	String	Description of the mapping done.
questionLabel	String	Value of the question label.
display	Boolean	Indication whether to display the document.
unlocalValue	String	Unlocalized value of the question
questionId	Long	ID of the question
label	String	Question label value
order	Long	Order of the displayed questions
type	String	Type of question
localizedLabel	String	Localized value of the question
lovName	String	Name of the LOV
repeatable	Boolean	Indication whether the question can be repeatable
answerValidation	AnswerValidationDto	Validation options
answerType	AnswerType	Type of answer
required	Boolean	Information whether the answer is required
otherAvailable	Boolean	Info whether other answers are available
atLeast	Integer	Minimum value of the required answer gap
atMost	Integer	Maximum value of the required answer gap
maximumLength	Integer	Maximum length of the answer
minimumLength	Integer	Minimum value of the answer
maximumValue	Double	Maximum value of the provided answer
minimumValue	Double	Minimum value of the required answer
earlierThanDate	String	Condition of the date
laterThanDate	String	Condition of the date
dateFormat	String	Format of the date
answerValidationExtended	AnswerValidationExtendedDto	Additional validation options
defaultCountryCode	String	Default country code
dateGapsRestricted	Boolean	Indication whether date gaps are restricted
maximumDateGaps	Integer	Maximum date range
maximumDateGapsUnit	EmploymentHistoryUnit	Maximum date range unit (DAYS, MONTHS, YEARS)
minWorkHistoryRequired	Boolean	Information whether an entry of Work History is required
minWorkHistory	Integer	Value of the minimum Work History entries required
minWorkHistoryUnit	EmploymentHistoryUnit	Minimum Work History unit (DAYS, MONTHS, YEARS)
answerType	AnswerType	Type of answer
required	Boolean	Information whether the answer is required
otherAvailable	Boolean	Info whether other answers are available
atLeast	Integer	Minimum value of the required answer gap
atMost	Integer	Maximum value of the required answer gap
maximumLength	Integer	Maximum length of the answer
minimumLength	Integer	Minimum value of the answer
maximumValue	Double	Maximum value of the provided answer
minimumValue	Double	Minimum value of the required answer
earlierThanDate	String	Condition of the date
laterThanDate	String	Condition of the date
dateFormat	String	Format of the date
competencyCategoryName	String	Name of the category of competence
questionLayout	QuestionLayoutDto	Formatting of the questions setup
answerInline	String	Inline value of the answer
answerSize	Integer	Value of the displayed field for answer
indentation	String	Value of indentation of an answer
fontFamily	String	Font to be used in the displayed form
fontSize	String	Font size to be used
fontWeight	String	Font weight to be used
presentation	String	Presentation to be used
questionInline	String	Inline value of the question
textDecoration	String	Value of the Text Decoration
pleaseSelect	Boolean	Indication whether various options can be selected
fontStyle	String	Info on what font style is to be used
fontColor	String	Info on what font color is to be used
description	String	Image description
imageWidth	Integer	Width of the image used
imageHeight	Integer	Height of the image used
hasTitle	Boolean	Indication whether the image has title
alphasort	String	Sort options alphabetically
hasBorder	Boolean	Border flag
lovs	List	List of LOVs used
lovs	ListOfValuesDto
values	List	List of available values
values	LovValueDto
id	Long	ID of the LOV
value	String	Value of the field
localizedLabel	String	Localized value of the LOV
order	Integer	Order of displayed values
lovName	String	Name of the LOV
competencyCategories	List	List of available competency categories
competencyCategory	QuestionCompetencyCategoryDto	Data transfer object for competency questions related data.
id	Long	ID of the competency
name	String	Name of the competency
nameLabel	String	Name of the competency label
description	String	Description of the competency
descriptionLabel	String	Label name of the description
options	List	List of options available for competencies
option	QuestionCompetencyCategoryDto	Data transfer object for competency questions related data.
masterLanguage	String	Master language of the form (set in BO)
formCategory	FormCategoryDto	List of form category options
name	String	Category name
id	Long	ID of local description
description	String	Description of the Candidate Profile
localDescription	KeyNameDto
id	Long	Internal Talentlink Key Name ID
labels	Map	Labels map for each language
name	String	Default name of key
localName	KeyNameDto
templateType	String	Type of template used
isdisplayActions	Boolean	Indication whether category is to be used
description	String
comment	String	Comments for the Candidate Profile
formContexts	FormContextDto	Options related to Form Contexts
id	Long	ID of the form context
contextType	FormContextType	Type of context
linkedId	Long	ID of the linked context
displayType	String	Type of displayed form
departmentId	Long	ID of the departmen in which the Candidate Profile is available
answerableManyTimes	Boolean	Indication whether the form can be abswered many times
translatedLanguage	String	Information of which languages the Candidate Profile has been translated to
hasAccessToViewForm	Boolean	Information whether the form can be viewed
creationUser	UserDto	Information about the user who created the Candidate Profile form
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
updationuser	UserDto
dataPrivacy	String	Value of selected data privacy statement

This method allows to retrieve details of all applications available for the user and general information. 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!"

Parameter	Data Type	Description
detailedSearchCriteriaDto	DetailedApplicantsSearchCriteriaDto	Search criteria
jobId	Long	JobId ID of the job.
jobNumber	String	JobNumber of the job.
internalJobNumber	String	InternalJobNumber of the job.
firstName	String	FirstName of the Applicant.
lastName	String	LastName of the Applicant.
email	String	Email of the Applicant.
applicationStatus	String	Application status of the Applicant.
pageNumber	Int	Page number of result.

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
detailedApplicationDto	DetailedApplicationDto	DetailedApplicationDto
amountOfPages	Integer	Number of pages.
applicantsTotal	Integer	Number of all applications.
newApplicants	Integer	Number of "New" applications.
inProcess	Integer	Number of "InProcess" applications.
offered	Integer	Number of "Offered" applications.
hired	Integer	Number of "Hired" applications.
closed	Integer	Number of "Closed" applications.
applicant	ShortApplicationDto	List of Applicants.
name	String	Name of Applicant.
email	String	Email of Applicant.
applicantId	Long	Id of Applicant.
currentPosition	String	Current position of Applicant.
location	Location	Location of Applicant.
city	String	City where Applicant resides.
country	String	Country where Applicant resides.
region	String	Region where Applicant resides.
address1	String	First part of address where Applicant resides.
address2	String	Second part of address where Applicant resides.
zip	String	Zip-code where Applicant resides.
currentCompany	String	Current company of Applicant.
lastModified	Date	Last Modified date.
status	String	Application status of Applicant.
link	String	Link to the Applicant.

The method getGFCandidateProfile to retrieve details for a specific candidate using the candidate 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!"

Parameter	Data Type	Description
candidateId	Long

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
type	CandidateProfileDto
creationDate	Date	Creation date of the current candidate profile
lastModified	Date	The date of the last modified entry for the candidate profile
profile	FullProfileDto	Candidate Profile object
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String

This method allows to display the structured document of the specified candidate. 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!"

Parameter	Data Type	Description
candidateId	Long

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
type	FullStructuredDocumentDto
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.
questionId	Long	Question id of Assigned Question.
localizedValues	List	Localized values assigned to answer.
localizedValue	LocalizedValueDto	Localized value
lang	String
value	String
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

This method returns available tag types. 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!"

Parameter	Data Type	Description

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
type	Collection
labelKey	String	[optional] Tag type label
name	String	Tag type name

This method returns the candidate profiles which have been tagged (for given tag name & 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!"

Parameter	Data Type	Description
tagName	String	[mandatory] Name of the tag
tagTypeName	String	[mandatory] Name of the tag type

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
candidate	Collection
id	Long	Talentlink auto generated Internal Candidate id
type	String	Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
initialType	String	Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
firstname	String	Candidate's firstname
lastname	String	Candidate's lastname
middlename	String	Candidate's middlename
email	String	Candidate's email address
academicTitle	String	Academic title / university degree e.g. PhD
srcChannelName	String	Sourcing channel through which the current candidate was acquired
creation	Date	Date when the record was registered
update	Date	Date when this record was last updated
socialSecurityNumber	String	Candidate's social security number
anonymous	Boolean	Whether the current profile is anonymous or not
address	FullAddressDto	Candidate's address data
address1	String	Address line 1/ Main Address
address2	String	Address line 2/ Secondary Address
alternateEmail	String	Alternative e-mail address
city	String	Candidate's city
countryName	String	Click to see possible values
fax	String	Candidate's fax number
homePhone	String	Candidate's home phone number
mobilePhone	String	Candidate's cell phone number
personalWebSite	String	Candidate's personal web site address
preferredComChannel	String	Candidate's preferred communication channel (Email, SMS)
latCoordinate	Double	Latitude coordinate
lngCoordinate	Double	Longitude coordinate
regionName	String	The region would be within the country selected for for the country parameter
workPhone	String	Candidate's work phone number
zip	String	Candidate's ZIP code
position	FullPositionDto	Candidate's current position data (name, since when, wages, etc)
company	String	Company where the current candidate currently works
companyStartDate	Date	Start date for the currently hold position
compensation	String	Compensation received by the candidate in the current position
employeeCode	String	Employee code of the candidate in the current position
managerName	String	Name and surname of the current candidate's manager
positionStartDate	Date	Date since when the candidate holds the current position
positionEndDate	Date	Date until when the candidate holds the current position
position	String	Name of the candidate's current position
location	String	Assigned location of the current position
reference	FullReferenceDto	Candidate's reference info
company	String	Company this reference comes from
email	String	E-mail to write to in order to verify this reference
employeeCode	String	Employee code to use for reference verification
referredFrom	String	Name of the person to ask for confirmation of this reference
personalData	FullPersonalDataDto	Candidate's personal data
citizenship	SimpleLovDto	Current candidate's citizenship
value	String	Internal TLK LOV value
dateOfBirth	Date	Candidate's date of birth
dateOfBirthString	String	Candidate's date of birth in ISO format
language	SimpleLovDto	Candidate's language. Click to see possible values
maritalStatus	SimpleLovDto	Candidate's marital status
numberOfChildren	Integer	Candidate's number of children
sex	SimpleLovDto	Candidate's sex
srcChannelType	SimpleLovDto	Candidate's type of sourcing channel
status	SimpleLovDto	Candidate's current status
sourcingMedium	SimpleLovDto	Candidate's sourcing medium (newspaper, on-line, spot, etc)
uiLanguage	SimpleLovDto	Candidate's preferred UI language - Click to see possible values
dataPrivacy	SimpleLovDto	Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
tags	List	List of tags assigned to candidate's profile
tag	BasicTagDto	Tag assigned to candidate's profile
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name
foldersName	String	Candidate's pools
memo	String	Additional comments
legacyId	String	Candidate's legacy Id
candidateConsents	List	List of candidate data privacy consents.
candidateConsent	CandidateConsentDto	DTO representing candidate consent with status, comment and changes data. It contains concrete consent object that represents on what candidate has agreed/not agreed on including all data (text, lang code etc.)
consentDto	ConsentDto	Object representing consent data.
id	Long	Database ID of Consent
type	ConsentType	Type of Candidate consent. Indicates what type of consent. Can be one of possible values: - TALENT_POOL - consent for Talent Pools and General Applications - APPLICATION - consent for Applications - LINKEDIN_RSC - consent releated to LinkedIn
language	LangCode	Language represented as Talentlink LangCode standard, ie: UK, EN, DE. Determines the language of provided consent text.
introductionText	String	The headline of consent
fullText	String	Full text of consent. This is exactly what candidate has seen when accepting / rejecting consent.
department	DepartmentDto	Represents the first level department of consent.
id	String
name	String
level	Integer
shortName	String
parentDept	DepartmentDto
defaultConsent	Boolean	True / false determining if consent is default
current	Boolean	True / false determing if the consent is current version Current version will be presented to new candidates. Candidate can have assiged not current version if it has changes since agreement.
version	Long	Number specifying version of the consent.
user	UserDto	UserDto determines who has created the consent.
id	Long	ID is the internal auto generated user of the Talentlink BackOffice system
firstName	String	First name of user for in BackOffice, for example, Saif
lastName	String	Last name of user, for example, Anjary
login	String	Login username to access the Lumesse BackOffice
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
type	String	ADVANCED = HR recruiter MSS = line manager
active	Boolean	IF true user is active
createdDate	Date	Date of creation of the consent.
uniqueIdentifier	String	String unique identifier for consent.
status	CandidateConsentStatus	Status of candidate consent. Can be one of the following values: - REQUESTED - communication has been sent to candidate asking for consent agreement - GRANTED - permission is given - REVOKED_BY_USER - permission is refused by TLK user - WITHDRAWN_BY_CANDIDATE - permission is refused by candidate
lastGrantedDate	Date	Date of last grant action. Is null when grant has been never invoked.
lastRevokedDate	Date	Date of last revoke action. Is null when revoke has been never invoked.
lastRequestedDate	Date	Date of last request action. Is null when request has been never invoked.
lastRequestedUser	UserDto	User invoking last request action. Is null when request has been never invoked.
lastGrantedUser	UserDto	User invoking last grant action. Is null when grant has been never invoked.
lastRevokedUser	UserDto	User invoking last revoke action. Is null when revoke has been never invoked.
comment	String	Additional comment for consent. Can be null.
linkedInId	String	Unique Cross System Awareness LinkedIn identifier
applicationId	Long	Internal TLK ID of application created for opening
formOfAddress	String

This method returns all candidate tags for given 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!"

Parameter	Data Type	Description
tagTypeName	String	[mandatory] Name of the tag type

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
tag	Collection
labelKey	String	[optional] Tag label
name	String	Tag name
type	TagTypeDto	Tag type
labelKey	String	[optional] Tag type label
name	String	Tag type name

This method allows to remove the tag from the specified candidate. 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!"

Parameter	Data Type	Description
candidateId	Long	[mandatory] ID of Candidate
tagName	String	[mandatory] Name of the tag
tagTypeName	String	[mandatory] Name of the tag type

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
void	Void

This method revokes candidate consent 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!"

Parameter	Data Type	Description
consentId	Long	[mandatory] id of consent to revoke
candidateId	Long	Id of candidate
applicationId	Long	Id of application
comment	String	Comment

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
void	Void

This method allows to update the candidate PIF. 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!"

Parameter	Data Type	Description
formAnsweredDto	FormAnsweredDto
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
candidateId	Long

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
void	Void

The method uploadAttachedFile to upload a file for a specific candidate and for a specific application. This method returns an ID for the file attached. 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!"

Parameter	Data Type	Description
attachedFile	AttachedFileDto
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
candidateId	Long	[mandatory] Candidate internal ID
applicationId	Long	[mandatory] ID of the application

Parameter	Data Type	Description
APi Key	Alphanumeric	Will be provided by Lumesse

Parameter	Data Type	Description
attachedFileId	Long	ID of the attached file

Exporting Candidates using Queue

(See also our Queues services)

A queue represents a collection of TalentLink elements including candidatess.

Criteria is defined for each queue (e.g. candidate.status="Approved"), so that whenever an element is changed to match the criteria, the element is added to the queue. Optionally the queue can be configured to send a message to a specified URL whenever a new element (candidate) has been added to it.

The Queue web service has separate methods for the retrieval and removal of each element type. E.g. methods exist for getCandidateFromQueue and removeCandidateFromQueue.

Only one element can be retrieved or removed from the queue at a time. For example a call to getCandidateFromQueue will return the candidate that was added to the queue earliest. A call to removeCandidateFromQueue will remove the candidate that was added to the queue earliest. This ensures that the client application consuming the web service only removes an element from the queue once it confirms that the element has been processed successfully.

Typical Work Flow for Queue Candidate

version 85 as of 2 months ago by Lukasz Krzywicki

Candidates

Typical workflow Candidates

Use Case

Scenario

Response Format

acceptCandidateConsent

Post Parameter

Request Parameter

Response Parameter

addTag

Post Parameter

Request Parameter

Response Parameter

createCandidateViaFolder

Post Parameter

Request Parameter

Response Parameter

createCandidateViaJobNumber

Post Parameter

Request Parameter

Response Parameter

createCandidateViaOpening

Post Parameter

Request Parameter

Response Parameter

downloadAttachedFile

Post Parameter

Request Parameter

Response Parameter

editTagByCandidateID

Post Parameter

Request Parameter

Response Parameter

getApplicationById

Post Parameter

Request Parameter

Response Parameter

getApplications

Post Parameter

Request Parameter

Response Parameter

getApplicationsByCandidateId

Post Parameter

Request Parameter

Response Parameter

getApplicationsByJob

Post Parameter

Request Parameter

Response Parameter

getApplicationsByStatus

Post Parameter

Request Parameter

Response Parameter

getCandidateById

Post Parameter

Request Parameter

Response Parameter

getCandidateHistory

Post Parameter

Request Parameter

Response Parameter

getCandidateStructuredDocumentById

Post Parameter

Request Parameter

Response Parameter

getCandidates

Post Parameter

Request Parameter

Response Parameter

getContracts

Post Parameter

Request Parameter

Response Parameter

getContractsByApplicationId

Post Parameter

Request Parameter

Response Parameter

getCurrentBoCpTemplateByType

Post Parameter

Request Parameter