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

  1. START. A candidate is created in an ERP system or an HRIS by a recruiter or Hiring Manager.
  2. The ERP system or HRIS calls the TalentLink Exchange web service.
  3. To retrieve Candidate information by a candidate ID within an ERP system or by an HRIS recruiter calls the TalentLink Exchange service getCandidateById webservice.
  4. To check applications made by a single candidate within TalentLink use getApplicationsByCandidateId
  5. 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.
  6. 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).
  7. 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!"

Post Parameter

 
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

Request Parameter

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

Response Parameter

 
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!"

Post Parameter

 
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.

Request Parameter

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

Response Parameter

 
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!"

Post Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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]

Request Parameter

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

Response Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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!"

Post Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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

Request Parameter

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

Response Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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!"

Post Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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

Request Parameter

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

Response Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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!"

Post Parameter

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

Request Parameter

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

Response Parameter

 
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!"

Post Parameter

 
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.

Request Parameter

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

Response Parameter

 
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!"

Post Parameter

 
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

Request Parameter

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

Response Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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!"

Post Parameter

 
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

Request Parameter

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

Response Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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!"

Post Parameter

 
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

Request Parameter

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

Response Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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!"

Post Parameter

 
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

Request Parameter

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

Response Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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!"

Post Parameter

 
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

Request Parameter

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

Response Parameter

 
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 Talentlink BackOffice
          email
String
Email of the user in the Talentlink 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!"

Post Parameter

 
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

Request Parameter

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

Response Parameter

 
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