TalentPortal Account

Response Format

XML


SOAP METHODS

The method createTalentPortal will create TalentPortal account.
The method will return an activation token which can be passed to the activateTalentPortal method.
The candidate will not be able to login to their CHP unless their account has been activated.

This method must be called with anonymous access.
The user name must be set to the following format: TechnicalID:guest:FO.
The password must be set to "guest".

Post Parameter

 
Parameter Data Type Description
talentPortalDto
TalentPortalAccountDto
    firstName
String [mandatory] First name of candidate
    lastName
String [mandatory] Last name of candidate
    email
String [mandatory] Email for the candidate
    login
String Username created to access the Talentportal, if not provided then e-mail will be used as login
    password
String [mandatory] Password for the TalentPortal account
    department
Long Department ID for which TalentPortal account is connected. Important for multi-tenant customers.
langCode
LangCode Language code If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
activationToken
String activationToken This will be the unique activation code which is needed to activate this account
The method activateTalentPortal is used to activate TalentPortal based on the provided parameters.
Activation token is valid only till activation time, afterwards it is deleted.

This method must be called with anonymous access.
The user name must be set to the following format for example: TechnicalID:guest:FO
The password must be set to "guest".

Post Parameter

 
Parameter Data Type Description
activationToken
String [mandatory] Unique activation code which is needed to activate this account and is produced when creating a candidate in the method createTalentPortal.
login
String [mandatory] Login to the Talent Portal
langCode
LangCode Language code If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
void
The method deleteTalentPortal deletes TalentPortal of currently logged in front office candidate.

This method must be called with candidate credentials.
The user name must be set to the following format for example: TechnicalID:saif:FO
The password must be the candidates password used for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
langCode
LangCode Language code If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
void
The method changePassword allows to changed password, the rules that have been set up regarding password format can be retrieved by calling the TalentPortalConfiguration listPasswordRules method.
If password validation fails then method throws an exception with detailed information about the cause of the error.
Error contains error code and message is localized according to the language specified.
List of possible errors, format code - message:

- ChangeSystemPassword - User has to change password
- BlockLogin - Blocked login after a series of invalid attempts
- BlockLoginUnused - Blocked account in case it has not been used for more than a number of days
- ExpirationPeriod - Password has expire after a number of days
- MinimumLength - Password minimum length
- MixedCase - Password has to contain mixed case
- Numbers - Password has to contain numbers
- SpecialChars - Password has to contain special characters
- History - Password has to be different than last passwords
- PersonalAttributes - Password cannot contain LoginId, LastName, FirstName, Email, Telephone and Social Security Number
- WrongSecurityAnswer - Wrong security answer

This method must be called with candidate credentials.
The user name must be set to the following format for example: TechnicalID:saif:FO
The password must be the candidates password used for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
password
String [mandatory] New password.
langCode
LangCode Language code If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
void
The method getSecurityQuestion method returns a security question for candidate. It is possible to use only login or combination firstname, lastname and e-mail. If all parameters provided then only login is used.

This method must be called with anonymous access.
The user name must be set to the following format: TechnicalID:guest:FO.
The password must be set to "guest".

Post Parameter

 
Parameter Data Type Description
credentials
FoCredentialsDto
    firstName
String First name of candidate
    lastName
String Last name of candidate
    email
String Email for the candidate
    login
String Username created to access the Talentportal
    departmentId
Long Department ID for which TalentPortal account is connected. Important for multi-tenant customers.
langCode
LangCode Language code If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
securityQuestionDto
SecurityQuestionDto
    value
String Code standard security question or custom security question
    label
String Translated standard security question or custom security question
The method changeSecurityQuestion sets or updates security question and/or answer.

This method must be called with candidate credentials.
The user name must be set to the following format for example: TechnicalID:saif:FO
The password must be the candidates password used for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
question
String [mandatory] It can be code for standard security question or text of custom question.
answer
String [mandatory] Security question answer that will be used if secured password is switched on. Otherwise forgot password will result sending new password to candidate e-mail without asking for answer.
langCode
LangCode Language code If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
void
The method getTemporaryPassword gets temporary password. This value can be used to "jump" from TalentPortal to application process (hosted by Lumesse) in case continue application.

This method must be called with candidate credentials.
The user name must be set to the following format for example: TechnicalID:saif:FO
The password must be the candidates password used for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
langCode
LangCode Language code If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
temporaryPassword
String
The method sendPasswordReminder results in sending new password to the e-mail registered for account. It is possible to use only login or combination firstname, lastname and e-mail. If all parameters provided then only login is used.

This method must be called with anonymous access.
The user name must be set to the following format: TechnicalID:guest:FO.
The password must be set to "guest".

Post Parameter

 
Parameter Data Type Description
credentials
FoCredentialsDto
    firstName
String First name of candidate
    lastName
String Last name of candidate
    email
String Email for the candidate
    login
String Username created to access the Talentportal
    departmentId
Long Department ID for which TalentPortal account is connected. Important for multi-tenant customers.
langCode
LangCode Language code If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
void
This method allows to change login, first name, last name and email. Empty values are not considered when account is updated.

This method must be called with candidate credentials.
The user name must be set to the following format for example: TechnicalID:saif:FO
The password must be the candidates password used for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
login
String - New login
firstName
String - New first name
lastName
String - New last name
email
String New email

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
void