Queues

Overview

WSDL

Queues are collections of TalentLink elements that match a given criteria. For example a queue might exist for candidates that are at a status of hired.

The Queue web service provides methods for retrieving and removing the elements in a queue. Optionally, an alert can be sent to a specified URL each time a new element is added to the queue, allowing for "real time" processing.

The available elements are : 

  • Application
  • Candidate
  • Contract
  • Position
  • Timesheet
  • ExternalSystemRequest (Used for assessment provider and background checking services)

 

Retrieval of Elements

The Queue web service has separate methods for the retrieval  of each element type. E.g. methods exists for getApplicationFromQueue, getPositionFromQueue, getCandidateFromQueue etc.  Each of the "get" methods accepts a single parameter of a queue name and returns the element which was added to the queue earliest. If the queue has no elements in it, an empty response will be returned.

If a call is made to a "get" method for a queue defined with a different element, an empty response will be returned. For example if getCandidateFromQueue is called using a queue name that has been defined for positions, an empty response will be returned.

Removal of Elements

The Queue web service has separate methods for the removal of each element type. E.g. methods exists for removeApplicationFromQueue, removePositionFromQueue, removeCandidateFromQueue etc.  Each of the "remove" methods accepts a single parameter of a queue name and removes the element which was added to the queue earliest.  Each "remove" response returns an empty response.

Workflow

As only one element can be retrieved from the queue at a time, a typical workflow is to call a "get" method, process that element, call the "remove" method and repeat those steps until the "get" call returns an empty response. To iterate through a queue, each element must be removed from the queue before the next element can be retrieved. This ensures that the calling program has the responsibility of only removing elements once it has confirmed that the previous element has been successfully processed.

Alerts

Optionally the queue can be configured to send a message to a specified URL whenever a new element has been added to it.

If a URL has been configured on the queue, then a message is posted to the URL with parameters of accountName, queueName and size. The URL will typically point to a web page or web service hosted by the client that is able to read the parameters passed and then retrieve the relevant data.

Methods

The methods of the Queue web service are :

Method Description
getCandidateFromQueue Retrieve a candidate from queue (Details)
getPositionFromQueue Retrieve a position from queue (Details)
getApplicationFromQueue Retrieve an application from queue (Details)
getContractFromQueue Retrieve a contract from queue (Details)
getTimesheetFromQueue Retrieve a timesheet from queue (Details)
getExternalSystemRequestFromQueue Retrieve an external system request from queue (Details)
removeCandidateFromQueue Remove a candidate from queue
removePositionFromQueue Remove a position from queue
removeApplicationFromQueue Remove an application from queue
removeContractFromQueue Remove a contract from queue
removeTimesheetFromQueue Remove a timesheet from queue
removeExternalSystemRequestFromQueue Remove an external system request from queue
listAllQueues Returns a list of all queue names
listAllQueuesDetailed Returns a list of all queues providing the queue name and the number of elements in the queue
createLocalQueue Creates new local (user specific) queue for currently logged user, that can contain objects of any type. Throws IllegalArgumentException if a queue with the same already exists.
createGlobalQueue Creates new local (user specific) queue for currently logged user, that can contain objects of any type. Throws IllegalArgumentException if a queue with the same already exists.
exportQueue Exports details of a queue as XML
importLocalQueue Imports a local queue from XML
importGlobalQueue Imports a global queue from XML
removeQueue Removes a queue with all it's elements.

Objects Returned By the Queue

Candidate

FieldData TypeDescription
academicTitle string
address address Complex type consisting of address1, address2,city, country, regionname, zip, home phone, mobile phone, work phone, alternate  email, personal web site, latitude coordinate, longitude coordinate. Only those fields which have been enabled will be returned.
anonymous boolean
creation dateTime Date the record was created.
dataPrivacy dataPrivacy Complex type consisting of two values. Represents a period of time that the candidate is willing for their details to be stored. E.g. values may be returned of "3" and "months".
email string
firstname string
foldersName string A collection of pools that the candidate belongs to.
id long
initialType string
lastname string
legacyId string
memo string
middlename string
personalData personalData
position position Collection of previous employment the candidate has held. Consists of start date, end date, position, location, company, manager name, compensation and employee code.
reference reference
socialSecurityNumber string
sourcingMedium sourcingMedium
srcChannelName string
srcChannelType applicationSrcType
status candidateStatus
tag tag
type string
uiLanguage language
update dateTime

Date that the record was last updated

 

Position 

Property Type Description
areaOfResponsibility string

authorizedRecruitment

authorizedRecruitment

A complex type containing 2 booleans to indicate if employees and/or external candidates can apply.

company

string

Company name entered by recruiter.

compensation

compensationDto

Represents the salary or rate on the position. A complex type consisting of currency, minimum, maximum and period. E.g. £20,000 to £30,000 per year.

configurableFields

configurableFieldsDto

A collection of fields defined by the system administrator. They are used in addition to the standard fields which make up a position.

contractComments

string

Comments added by the recruiter.

contractType

string

Fixed term, contract etc. The values are maintained by a system administrator.

costCenter string

created

dateTime

Date the position was created.

customField

customField

A collection of custom fields. The number and type of custom fields is set by a system administrator. These are typically used to hold sections of the job description.

descriptionTemplate

jobAdTemplateDto

A collection of advertisements created for that position.

dueDate

dateTime

The date the position is due.

duration

duration

Duration of position. A complex type describing count and period. E.g. 6 months.

expectedContractDates

expectedContractDates

Complex type containg start and end date of contract.

generalApplication boolean

headCount

long

Number of positions available.

id

long

The id assigned to the position by the TalentLink system.

jobNumber

string

Job number entered by recruiter.

lastUpdate

dateTime

Date the position was last updated.

location

locationDto

Location of the position. Consists of city, country and region.

onboarding onboardingTeam
openingPosition openingPositionDTO

organization

organizationDto

A collection of organizations to which the position belongs. Each organization consists of code, id, level and name.

plainText boolean
positionType string
profileDocument structuredDocumentDto

renewal

boolean

Indicates if the position is a renewal.

requisitionNumber

string

Requisition number. Used as a parameter in getPositionByReqNumber

scheduleType

string

Full Time or Part Time

standardRate

tns:standardRate

Complex type consisting of currency, minimum maximum and period.

status

string

Status of position.

team

positionTeam

Collection of teams associated to position. Teams can be recruiters or operational (e.g. hiring manager, HR etc).  Each team member consists of first name, surname, email.

teamComments string

title

string

Job title

totalCost

tns:totalCost

Total cost of position. Consists of currency, minimum and maximum.

workTime

tns:workTime

Standard working period. Consists of count, period and workunit. E.g. 40 hours per week.

Application

Property Data Type Description
activeApplication boolean
applicationDate dateTime
applicationHistory A complex type describing the statuses that the application has been through. Each element contains id, status and a date.
archived boolean
candidateId
completionReason
creation dateTime Date the application was created
documents A collection of document objects
hasContracts boolean
id
memo
positionId
shortListed boolean
srcChannelName string
srcChannelType string
srcMedium string
status string
statusComment string
update dateTime

Timesheets & Contractors

Details can be found on the "Timesheets & Contractors" page.

ExternalSystemRequest

Property Data Type Description

Creates new global (slice wide) queue, that can contain objects of any type. Throws IllegalArgumentException in the case the queue with the name specified has been already available.

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
queueName
String
Name of the queue, can't be NULL or empty String
elementsType
QueueElementType
Of elements the queue can accept. cannot be nullL. Possible values: CANDIDATE_ELEMENT, AH_REPORT_ELEMENT, APPLICATION_ELEMENT, APPLICATION_SELECTION_TASK, OPENING_ELEMENT, CONTRACT_ELEMENT, TIMESHEET_ELEMENT,EXTERNAL_SYSTEM_REQUEST_ELEMENT
uniqueElements
Boolean
Indicates if queue elements should be unique or not. Element is not unique if there exists another one with the same type and ID.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
queueName
String
Name of newly created global queue. It can be different than the name that was passed as argument
Creates new local (user specific) queue for currently logged user, that can contain objects of any type. Throws IllegalArgumentException if a queue with the same already exists.

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
queueName
String
Name of the queue, can't be NULL or empty String.
elementsType
QueueElementType
Type of elements the queue can accept. cannot be null. Possible values: CANDIDATE_ELEMENT, AH_REPORT_ELEMENT, APPLICATION_ELEMENT, APPLICATION_SELECTION_TASK, OPENING_ELEMENT, CONTRACT_ELEMENT, TIMESHEET_ELEMENT,EXTERNAL_SYSTEM_REQUEST_ELEMENT
uniqueElements
Boolean
Indicates if queue elements should be unique or not. Element is not unique if there exists another one with the same type and ID.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
queueName
String
Name of newly created local queue. It can be different than the name that was passed as argument
Exports a queue configuration to a XML document.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
queueName
String
Name of the queue to export.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
queueXMLConfig
String
XML document representing queue configuration.
Retrieves next application from a queue. When invoking this method the same object is returned until removeApplicationFromQueue is called.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
application
ApplicationDto
Application object from a queue according to FIFO strategy, null if a query doesn't contain any Application object.
  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
Retrieves next Application Step from a queue. When invoking this method the same object is returned until removeApplicationStepFromQueue is called.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
selectiontask
SelectionTaskDto
SelectionTaskDto object from a queue according to FIFO strategy, null if a query doesn't contain any SelectionTask object.
  id
Long
Unique ID of the current SelectionTask.
  candidateMessage
String
CandidateMessage of the current SelectionTask.
  endTime
String
EndTime of the current SelectionTask.
  location
String
Location of the current SelectionTask.
  participantEmail
String
ParticipantEmail of the current SelectionTask.
  startTime
String
StartTime of the current SelectionTask.
  decision
String
Decision of the current SelectionTask.
  closingDate
Date
ClosingDate of the current SelectionTask.
  creationDate
Date
CreationDate of the current SelectionTask.
  completionDate
Date
CompletionDate of the current SelectionTask.
  stepStatus
String
StepStatus of the current SelectionTask.
  taskStatus
String
TaskStatus of the current SelectionTask.
  application
ApplicationDto
Application of the current SelectionTask.
    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
  selectionTaskModelDto
SelectionTaskModelDto
SelectionTaskModel of the current SelectionTask.
    id
Long
Internal Talentlink Selection Task Model ID
    type
String
Selection Task Model Type
    stepType
String
Selection Task Model Step Type
    action
String
Action for Selection Task Model
    category
String
Selection Task Category
    duration
Integer
Step duration
    order
Integer
Selection Task order
    updateable
Boolean
Is selection task model updatable
    requestHiring
Boolean
Is request hiring possible for step. Possible value: true or false
    shareable
Boolean
Is step shareable. Possible values: true or false
    sharedValidityPeriod
Integer
Shared validity period for step shering in days
    adHoc
Boolean
Is step adHoc. Possible value: true or false
    keyName
KeyNameDto
Provides translations of step labels
      id
Long
Internal Talentlink Key Name ID
      labels
Map
Labels map for each language
      name
String
Default name of key
    expectedTaskOutput
String
Represents expected task output
    coordinatorType
String
Coordination type
    coordinator
UserDto
User Data of task coordinator
      id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
      firstName
String
First name of user for in BackOffice, for example, Saif
      lastName
String
Last name of user, for example, Anjary
      login
String
Login username to access the Lumesse BackOffice
      email
String
Email of the user in the Lumesse BackOffice.
      cellphone
String
Cellphone number of the user
      type
String
ADVANCED = HR recruiter MSS = line manager
    owner
UserDto
User data of task owner
    ownerType
String
Owner type
    emailStepOwner
String
Step owner email
    feedbackFailScore
Int
Score threshold below which automatic feedback processing will be considered a failure
    feedbackPassScore
Int
Score threshold below which automatic feedback processing will be considered a success
    dayDelay
Integer
Days delay for automatic processing
    statusComment
String
Status comments
    applicationMemo
String
Application MEMO
    automaticAppReject
Boolean
Is automatic application reject enabled for step. Possible values: true or false
    contactRejectedCand
Boolean
Is contact rejected candidate enabled for step. Possible values: true or false
    automaticStartNextStep
Boolean
Is next step automatically started after step processing. Possible value true or false
    selectionProcessModelDto
SelectionProcessModelDto
Defines selection process
      id
Long
Internal Talentlink ID of selection proces
      name
String
Name of selection process
      mandatory
Boolean
Is process mandatory. Possible value: true or false
      version
Integer
Verion of selection process
      shortListCandidate
Boolean
Is candidate short listing enabled. Possible values: true or false
      departmentId
Long
Internal Talentlink ID of organization to which selection process is assigned
      accountId
Long
Internal Talentlink ID of account in which department with this selection process exist
Retrieves next candidate from queue. When invoking this method the same object is returned until is called.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
profile
FullProfileDto
Profile object from a queue according to FIFO strategy, null if a query doesn't contain any Profile object.
  id
Long
Talentlink auto generated Internal Candidate id
  type
String
Candidate type of the current profile. Following values are used: 'Employee' 'External Candidate'
  initialType
String
Initial Candidate type of the current profile. Following values are used. One of below values returned. e.g. 'Employee' 'External Candidate'
  firstname
String
Candidate's firstname
  lastname
String
Candidate's lastname
  middlename
String
Candidate's middlename
  email
String
Candidate's email address
  academicTitle
String
Academic title / university degree e.g. PhD
  srcChannelName
String
Sourcing channel through which the current candidate was acquired
  creation
Date
Date when the record was registered
  update
Date
Date when this record was last updated
  socialSecurityNumber
String
Candidate's social security number
  anonymous
Boolean
Whether the current profile is anonymous or not
  address
FullAddressDto
Candidate's address data
    address1
String
Address line 1/ Main Address
    address2
String
Address line 2/ Secondary Address
    alternateEmail
String
Alternative e-mail address
    city
String
Candidate's city
    countryName
String
Click to see possible values
    fax
String
Candidate's fax number
    homePhone
String
Candidate's home phone number
    mobilePhone
String
Candidate's cell phone number
    personalWebSite
String
Candidate's personal web site address
    preferredComChannel
String
Candidate's preferred communication channel (Email, SMS)
    latCoordinate
Double
Latitude coordinate
    lngCoordinate
Double
Longitude coordinate
    regionName
String
The region would be within the country selected for for the country parameter
    workPhone
String
Candidate's work phone number
    zip
String
Candidate's ZIP code
  position
FullPositionDto
Candidate's current position data (name, since when, wages, etc)
    company
String
Company where the current candidate currently works
    companyStartDate
Date
Start date for the currently hold position
    compensation
String
Compensation received by the candidate in the current position
    employeeCode
String
Employee code of the candidate in the current position
    managerName
String
Name and surname of the current candidate's manager
    positionStartDate
Date
Date since when the candidate holds the current position
    positionEndDate
Date
Date until when the candidate holds the current position
    position
String
Name of the candidate's current position
    location
String
Assigned location of the current position
  reference
FullReferenceDto
Candidate's reference info
    company
String
Company this reference comes from
    email
String
E-mail to write to in order to verify this reference
    employeeCode
String
Employee code to use for reference verification
    referredFrom
String
Name of the person to ask for confirmation of this reference
  personalData
FullPersonalDataDto
Candidate's personal data
    citizenship
SimpleLovDto
Current candidate's citizenship
      value
String
Internal TLK LOV value
    dateOfBirth
Date
Candidate's date of birth
    dateOfBirthString
String
Candidate's date of birth in ISO format
    language
SimpleLovDto
Candidate's language. Click to see possible values
    maritalStatus
SimpleLovDto
Candidate's marital status
    numberOfChildren
Integer
Candidate's number of children
    sex
SimpleLovDto
Candidate's sex
  srcChannelType
SimpleLovDto
Candidate's type of sourcing channel
  status
SimpleLovDto
Candidate's current status
  sourcingMedium
SimpleLovDto
Candidate's sourcing medium (newspaper, on-line, spot, etc)
  uiLanguage
SimpleLovDto
Candidate's preferred UI language - Click to see possible values
  dataPrivacy
SimpleLovDto
Data privacy policy to adhere to. Value returned is always in periods of months. e.g. '3months, 6months, 12months, 18months, 24months, 36months, 48months, 60months, 72months, 84months'
  tags
List
List of tags assigned to candidate's profile
    tag
BasicTagDto
Tag assigned to candidate's profile
      labelKey
String
[optional] Tag label
      name
String
Tag name
      type
TagTypeDto
Tag type
        labelKey
String
[optional] Tag type label
        name
String
Tag type name
  foldersName
String
Candidate's pools
  memo
String
Additional comments
  legacyId
String
Candidate's legacy Id
  linkedInId
String
Unique Cross System Awareness LinkedIn identifier
Retrieves next contract from a queue. When invoking this method the same object is returned until removeContractFromQueue is called.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

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

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
externalSystemRequest
ExternalSystemRequestDto
Built basing on base of ExternalSystemRequestDto
  candId
Long
Profile id of candidate during that application process external system request has been dispatched.
  candidateType
String
Candidate type.
  candidateStatus
SimpleLovDto
Candidate's current status.
    value
String
Internal TLK LOV value
  tlkRequestId
String
Tlk request id (aka correlation id)
  externalServiceId
String
External service id (aka test id)
  externalClientId
String
External client id
  additionalParameters
Map
Additional parameters defined in external system configuration.
Retrieves next Position from a queue. When invoking this method the same object is returned until removePositionFromQueue is called.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
position
PositionDto
Position object from a queue according to FIFO strategy, null if a query doesn't contain any Opening object.
  areaOfResponsibility
String
Area of responsibility related to current position
  positionType
String
Position type
  costCenter
String
Cost center
  id
Long
This is the ID of the position
  jobNumber
String
Requisition number. It is internal TalentLink identifier that must be unique. If not provided it is generated.
  title
String
Job title.
  headCount
Long
[mandatory] Number of positions available.
  creationDate
Date
The date the position is due.
  lastUpdate
Date
Date the position was last updated organization
  dueDate
Date
Returns job activity/due date.
  company
String
Company name entered by recruiter.
  location
LocationDto
This is a List consisting of values for, City, Country and Region. For example: City – Luton, Country – UK, Region – East Anglia
    city
String
Free text field within TalentLink.
    region
String
This is the region within the Country.
    country
String
Returns country.
  language
String
Returns job language.
  status
String
[mandatory]Status of the position (for example Open/Closed...).
  compensation
CompensationDto
Represents the salary or rate on the position. A complex type consisting of currency, minimum, maximum and period. E.g. £20,000 to £30,000 per year.
    minimum
BigDecimal
This would be the minimum compensation which is proposed for current position.
    maximum
BigDecimal
This would be the maximum compensation which is proposed for current position.
    period
String
Compensation period for current job and proposed wages.
    currency
String
Compensation currency for current job. Click to see possible values
  configurableFields
ConfigurableFieldsDto
A collection of fields defined by the system administrator. They are used in addition to the standard fields which make up a position.
    freeFormFields
List
FreeFormField DTO object represented as a simple header/label/value. Invalid LovId specified wil be ignored whilst processing.
      freeFormField
FreeFormFieldDto
FreeFormField DTO object represented as a simple header/label/value. This is a helper object for carrying LOV translated values (FreeFormField, Lov tables ).
        header
String
This is the header of the freeFormField.
        label
String
This is the label for the freeFormField.
        value
String
Returns FFF value which was provided for current header and label.
        lovId
Long
This is the ID for the freeFormField
    lovs
List
LOVs assigned to the current job represented as custom field objects.
      lov
ConfLovDto
LOV assigned to the current job
        lovId
Long
Internal Talentlink ID of LOV
        keyname
String
Configurable LOV related keyName
        value
String
Value of configurable lov
  contractType
String
[mandatory] Fixed term, contract etc. The values are maintained by a system administrator.
  organization
OrganizationDto
A collection of organizations to which the position belongs. Each organization consists of code, id, level and name. Please use Organization webservice bundle to retreive ID
    unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
      name
String
Returns name of organization as a xml tag value.
      level
Integer
Returns organization's level.
      id
Long
Returns organization's id.
      code
String
Organization code.
      nameTranslation
String
Translation of the organization name (if defined in BO).
  workTime
WorkTime
Consists of count, period and workunit. E.g. 40 hours per week.
    workPeriod
String
One of the below values must be used: Day, Week, Month, Quarter, Year
    workUnit
String
One of the below values must be used: Hours, Day, Week, Month, Quarter
    timeCount
Float
For example : 40
  requisitionNumber
String
Internal Requisition Number that must be unique. This could be used to store indentifier from another system. Used as a parameter in getPositionByReqNumber
  duration
Duration
Duration of position. A complex type describing count and period. E.g. 6 months.
    count
Integer
Duration count
    period
String
Duration period
  expectedContractDates
ExpectedContractDates
Complex type contains start and end date of contract.
    start
Date
Expected contract start date
    end
Date
Expected contract end date
  renewal
Boolean
Indicates if the position is a renewal.
  scheduleType
String
Full Time or Part Time
  contractComments
String
Comments added by the recruiter.
  teamComments
String
Internal team comments
  authorizedRecruitment
AuthorizedRecruitment
Defines recruitment authorization rules
    externalCandidate
Boolean
Is recruitment authorized fot external candidate. Possible values: TRUE or FALSE
    employee
Boolean
Is recruitment authorized fot employee. Possible values: TRUE or FALSE
  customField
CustomField
A collection of custom fields. The number and type of custom fields is set by a system administrator. These are typically used to hold sections of the job description (max 4000 bytes per description field).
    label
String
Name of the custom field e.g.: Additional Information
    value
String
Value of the custom field e.g.: Lumesse is an ambitious, innovative and successful organisation but we are also a people-friendly business that is proud to be different - in our culture, our values and our approach to employees and customers. Our philosophy is simple: Happy employees create happy customers.
    order
Int
Returns the (optional) position order of the current CustomField, or zero if no order was set before.
    unlocalizedLabel
String
Returns unlocalized label of the current customField.
  team
PositionTeam
Collection of teams associated to position. Teams can be recruiters or operational (e.g. hiring manager, HR etc). Each team member consists of first name, surname, email etc.
    recruiter
TeamMemberDto
List of team members
      order
Int
Team Order
      lovValue
String
Team meber value as Internal TLK LOV
      id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
      firstName
String
First name of user for in BackOffice, for example, Saif
      lastName
String
Last name of user, for example, Anjary
      login
String
Login username to access the Lumesse BackOffice
      email
String
Email of the user in the Lumesse BackOffice.
      cellphone
String
Cellphone number of the user
      type
String
ADVANCED = HR recruiter MSS = line manager
    operational
TeamMemberDto
The Operational team for this position, this will be a list of details such Firstname, Lastname and email etc.
    approver
ApproverDto
List of HRs or Employers who would approve this position
      stepOrder
Int
Approver order
      order
Int
Team Order
      lovValue
String
Team meber value as Internal TLK LOV
      id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
      firstName
String
First name of user for in BackOffice, for example, Saif
      lastName
String
Last name of user, for example, Anjary
      login
String
Login username to access the Lumesse BackOffice
      email
String
Email of the user in the Lumesse BackOffice.
      cellphone
String
Cellphone number of the user
      type
String
ADVANCED = HR recruiter MSS = line manager
    recruiter2OutOfTlk
Boolean
External recruiter No. 2
    recruiter3OutOfTlk
Boolean
External recruiter No. 3
  onboarding
OnboardingTeam
Collection of Onboarding team members.
    onboardingCoordinator
OnboardingUserDTO
User Data of Onboarding data coordinator
      onboardingUserId
Long
Internal Talentlink Onbording User ID
      userType
OnboardingUserType
Onbording User type
      userName
String
Onbording User name
      userId
Long
Internal Talentlink User ID
      email
String
Contact email
      id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
      firstName
String
First name of user for in BackOffice, for example, Saif
      lastName
String
Last name of user, for example, Anjary
      login
String
Login username to access the Lumesse BackOffice
      cellphone
String
Cellphone number of the user
      type
String
ADVANCED = HR recruiter MSS = line manager
    onboardingHR
OnboardingUserDTO
User Data of Onboarding HR
    onboardingMentor
OnboardingUserDTO
User Data of Onboarding mentor
    onboardingIT
OnboardingUserDTO
User Data of Onboarding IT
    onboardingSecurity
OnboardingUserDTO
User Data of Onboarding Security
    onboardingPayroll
OnboardingUserDTO
User Data of Onboarding Payroll
    onboardingOther
OnboardingUserDTO
User Data of Other onbording agent
  standardRate
StandardRate
Complex type consisting of currency, minimum maximum and period.
    minimum
BigDecimal
Minimum rate for this position
    maximum
BigDecimal
Maximum rate for this position
    currency
String
Possible values: Click to see possible values
    period
String
Term of the position
  totalCost
TotalCost
Total cost of position. Consists of currency, minimum and maximum.
    minimum
BigDecimal
Minimum rate for this position
    maximum
BigDecimal
Maximum rate for this position
    currency
String
Possible values: Click to see possible values
  generalApplication
Boolean
Is position a general application. Possible values: true or false
  openingPosition
OpeningPositionDTO
List of opening positions
    positionId
Long
Internal Talentlink Position ID
    positionTitle
String
Internal Talentlink Position title
  profileDocument
StructuredDocumentDto
This is a collection of questions for the Form within this position
    questions
List
List of questions for document
      questions
AssignedQuestionDto
Document question
        id
Long
Assigned question ID that is specific for document, copy of the question from template, form
        label
String
Question label
        order
Long
Order of a question in the form
        type
String
Answer type
        localizedLabel
String
Question label translated to the language specified in langCode
        questionId
Long
Question ID that value does not changed for documents based on the same form
        index
Integer
Question index
    id
Long
Assigned question ID that is specific for document, copy of the question from template form
  plainText
Boolean
Are position description in plain text. Possible value: true or false
  descriptionTemplate
JobAdTemplateDto
Set template for this position which will consist of sub parameters listed below
    id
Long
Internal Talentlink job ad template ID
    title
String
Job title
    departmentId
Long
Internal Talentlink organization ID
    primaryLanguage
String
This is the overall language which should be set for the position
    confProperties
HashMap
Key-value map of configurable properties assigned to template
    jobdescFields
JobAdField
List of job description fields
      index
Integer
Field index
      label
String
Field label
      content
String
Field content
      lockAfterImport
Boolean
Is fields content editable after importing containing template.
    plainText
Boolean
Is job add template content a plain text. Possible values: true or false
    anyFieldLocked
Boolean
Is fields content editable after importing containing template? Values should be TRUE or FALSE
    allFieldsLocked
Boolean
Is fields content editable after importing containing template? Values should be TRUE or FALSE
    additionalDepartments
List
This is a list of the position if it is linked to any other departments
      additionalDepartment
Integer
    strapline
String
Strapline
    images
HashMap
Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
Retrieves next timesheet from a queue. When invoking this method the same object is returned until removeTimeSheetFromQueue is called.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
position
TimeSheetDto
TimeSheet object from a queue according to FIFO strategy, null if a query doesn't contain any TimeSheet object.
  id
Long
Internal TLK Time Sheet ID
  totalUnit
Double
Total value for Time Sheet
  totalCostUnit
Double
Total cost value for Time Sheet
  remainingBudget
Double
Time Sheet remaining budget
  status
String
Time Sheet status
  purchaseOrder
String
Time Sheet purchase order
  comments
String
[deprecated] Recently added comment to the time sheet
  startDate
Date
Time Sheet start date
  endDate
Date
Time Sheet end data
  creationDate
Date
Time Sheet creation date
  updateDate
Date
Time Sheet update date
  submitDate
Date
Time Sheet submit date
  approvedDate
Date
Time Sheet approval date
  active
Boolean
Is Time Sheet active. Possible: true or false
  type
SheetType
Time Sheet type. Possible values: Normal, DateAdjCorrection, RateAdjCorrection, DataAdjCorrection, TimeAdjCorrection, DateAdjReversal, RateAdjReversal, DataAdjReversal, TimeAdjReversal
  parent
TimeSheetDto
Time sheet parent reference
  applicationId
Long
Internal TLK Application ID related to Time Sheet
  creationUser
UserDto
Data of creator of Time Sheet
    id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
    firstName
String
First name of user for in BackOffice, for example, Saif
    lastName
String
Last name of user, for example, Anjary
    login
String
Login username to access the Lumesse BackOffice
    email
String
Email of the user in the Lumesse BackOffice.
    cellphone
String
Cellphone number of the user
    type
String
ADVANCED = HR recruiter MSS = line manager
  updateUser
UserDto
Data of last updater of Time Sheet
  approver
UserDto
Data of approver of Time Sheet
  submitter
UserDto
Data of submitter of Time Sheet
  assignedApprover
UserDto
Data of assigned approver of Time Sheet
  candidate
ProfileDto
Candidate profile assigned to Time Sheet
    id
Long
Unique ID of the current profile.
    firstname
String
Candidate's first name.
    lastname
String
Candidate's last name.
    email
String
Candidate's email address.
    tags
List
List of Tags assigned to user profile
      tag
BasicTagDto
Tag assigned to user profile
        labelKey
String
[optional] Tag label
        name
String
Tag name
        type
TagTypeDto
Tag type
          labelKey
String
[optional] Tag type label
          name
String
Tag type name
    middlename
String
Candidate's middle name
    address
AddressFDto
Defines candidate's address
      address1
String
Address part 1
      address2
String
Address part 2
      city
String
City
      zip
String
Zip code
      region
SimpleLovValueDto
Region
        localizedValue
String
LOVs translated name
        value
String
LOVs value
        parentLovName
String
LOVs parent name
      homePhone
String
Home phone number
      workPhone
String
Work phone number
      mobilePhone
String
Mobile phone number
      fax
String
FAX number
      alternateEmail
String
Alternative E-mail address
      personalWebSite
String
Personal web site
      country
SimpleLovValueDto
Country
    personalData
PersonalDataDto
Candidates personal data
      academicTitle
String
Candidate's academic title
      dateOfBirth
Date
Candidate's date of birth
      numberOfChildren
Integer
Number of candidate's children
      citizenship
SimpleLovValueDto
Candidates citizenship
      language
SimpleLovValueDto
Candidates language
      maritalStatus
SimpleLovValueDto
Candidates marital status
      sex
SimpleLovValueDto
Candidates sex
    legacyId
String
Internal TLK candidate's legacy ID
  contractId
Long
Internal TLK Contract ID
  units
TimeSheetUnitDto
List of Time Sheet Units
    order
Long
Order of Time sheet Units
    comment
String
Unit comments
    unit
Double
Unit
    rate
RateDto
Describes rate of the unit
      id
Long
Unique ID of the current hiring process step.
      chargeRate
Double
Contract charge rate
      payRate
Double
Contract pay rate
      overAll
Double
Contract over all cost
      rateUnit
SimpleLovValueDto
Internal TLK LOV describing rate unit
      rateType
SimpleLovValueDto
Internal TLK LOV describing rate type
      hoursInUnit
Double
Hours in unit
    creationDate
Date
Creation date of Unit
    orderBreakDown
Long
Order break down of Unit
    startDate
Date
Start date of Unit
    endDate
Date
End date of Unit
    id
Long
Internal TLK ID of Unit
  expenses
TimeSheetExpenseDto
List of Time Sheet Expenses
    description
String
Description of time sheet expenses
    amount
BigDecimal
Amount of expenses
    category
SimpleLovDto
Time Sheet expense category
      value
String
Internal TLK LOV value
    currency
String
Expense currency
    creationDate
Date
Date of creation
    updateDate
Date
Date of last update
    id
Long
Internal TLK Expense ID
    attachedFileName
String
File names of attachement to the expense
  contract
ContractDto
Contract assigned to current Time Sheet
    id
Long
Unique ID of the current hiring process step.
    applicationId
Long
ID of application
    creationUser
UserDto
User who created the current hiring process step.
    timeZoneInfo
String
Possible Values: Click here to see some examples
    vendorName
String
Vendor name
    communicationLang
String
Language used in candidate communication
    typeOfUser
String
Represents type of user
    probationaryPeriod
String
Period of time that the candidate was on probation after hiring
    comments
String
Additional comments
    reason
String
Reason of contract
    contractComment
String
Comments for the contract
    vendorDetails
String
Additional information about the vendor
    updateUser
UserDto
User data of last updater
    approverUser
UserDto
User who is supposed to approve the current hiring process step.
    approved
Boolean
Is contract approved. Possible values: true or false
    accepted
Boolean
Was contract accepted. Possible values: true or false
    contractor
ContractorDto
Represents additional data about contractor
      id
Integer
Internal TLK Contractor id
      address1
String
Current contractor's main address.
      address2
String
Current contractor's secondary address.
      address3
String
Current contractor's additional address.
      address4
String
Current contractor's additional address.
      bankAccountName
String
Bank account name
      bankAccountNumber
String
Bank account number
      bankCityName
String
City where Bank is placed
      bankContactName
String
Name of contact in the Bank
      bankContactPhone
String
Contact phone to the Bank
      bankName
String
Name of the bank
      bankShortCode
String
Short code for the bank
      city
String
The current contractor's city.
      contactName
String
The current contractor's name.
      groupName
String
Name of the group assigned to contractor
      iban
String
IBAN bank account number
      legalId
String
Legal ID for contractor
      name
String
Name of the contractor
      paymentTerms
String
Contractor payment terms
      phone
String
Contractor phone
      swiftCode
String
Swift code
      taxId
String
Tax code
      zipCode
String
Contractor Zip code
      country
SimpleLovDto
Contractor country
    current
Boolean
Is Contract current. Possible values: true or false
    taskNotification
Boolean
Is Task Notification available for this contract. Possible values: true or false
    reassignTasks
Boolean
Is task reasign possible. Possible value: true or false
    extension
Integer
Contract extension
    candidate
ProfileDto
Candidate that is assigned to contract
    revision
Boolean
Is Contract a revision. Possible value: true or false
    expenseReimbursed
Boolean
Are Expenses reimbursed in contract. Possible values: true or false
    taskOverdue
Long
Task overdue days
    schedule
ScheduleDto
Represents contract schedule
      type
SimpleLovDto
Type of the current work schedule.
      workAmount
Float
Quantity of working time-units covered by the current schedule.
      workPeriod
SimpleLovDto
Period in which the quantity of work is expressed in this schedule.
      workUnit
SimpleLovDto
Time unit in which the quantity of work is expressed in this schedule.
    status
String
Status of application, for example: Submitted
    type
String
Contract type
    version
Integer
Version of the contract this record represents.
    creation
Date
Date when the current version of the contract was created.
    update
Date
Date when the current version of the contract was last updated.
    approval
Date
Date of contract approval
    dueDate
Date
Due date of contract
    reminderDate
Date
Date of reminder
    offerSentOn
Date
Date when offer were send out
    contractSentOn
Date
Date when contract were send on
    contractSignedOn
Date
Date when contract was signed on
    submitted
Date
Date when contract was submitted
    acceptedDate
Date
Date when contract was accepted
    bonusCondition
String
Condition(s) under which additional money bonuses may be paid.
    exportReason
String
Name of the event that triggered the last export of this contract.
    length
Float
Duration of the current contract in the units specified by the property lengthUnit. It isn't necessarily an integer value (eg. when lengthUnit is "month" and the contract is signed for 1 1/2 month)
    lengthUnit
String
Time unit in which the length of the current contract is expressed.
    plannedEndDate
Date
Planned end of contract date
    plannedStartDate
Date
Planned start of contract
    contractorContract
ContractorContractDto
Additional data about contractor contract
      contractorType
SimpleLovDto
Represents Contractor Contract type
      additionalInfo
String
Additional Information about Contractor contract
      flexibilityMaxDate
Date
Contractors contract flexibility max date
      flexibilityMinDate
Date
Contractors contract flexibility min date
      benchmarkRate
BigDecimal
Benchmark rate for contractor contract
      gainShareRate
BigDecimal
Gain share reate for contractor contract
      totalClientRate
BigDecimal
Total client rate for caontractor contract
      standardCurrency
SimpleLovDto
Currency used in contractor contract
      standardPeriod
SimpleLovDto
Standard contract period in contractor contract
      totalCost
BigDecimal
Total cost of contract
      totalCostCurrency
SimpleLovDto
Currency used to calculate total cost
    permanentContract
PermanentContractDto
This consists of the salary information for this contract, if not a permanentContract and is a contractor then the details will be within the contractorContract
      carAllowance
Boolean
Is car allowanse possible for contractor. Possible values: TRUE or FALSE
      fixedSalary
BigDecimal
This is the amount of salary for this contract, for example: 40000
      fixedSalaryCurrency
SimpleLovDto
Currency for current contract possible values: Click to see possible values
      fixedSalaryPeriod
SimpleLovDto
For example: Year
      probationaryPeriod
String
Probation period
      relocation
BigDecimal
Information about relocation
      relocationCurrency
SimpleLovDto
Information about relocation currency
      variableSalary
BigDecimal
Variable salary
      variableSalaryCurrency
SimpleLovDto
Variable salary currency
      variableSalaryPeriod
SimpleLovDto
Variable salary period
      memo
String
Contract MEMO
    lov
SimpleGenericLovDto
List of LOVs assigned to contract
      name
String
The name by which the configurable field is known. For example: Colour
      value
String
The list of selectable values associated with the configurable fields. For example: “Red”, “Amber” and “Green”
    freeFormField
FullFreeFormFieldContractDto
List of FreeFormFields assigned to contract
      name
String
Internal TLK FreeFormField name
      value
String
Internal TLK FreeFormField value
      field
String
Internal TLK FreeFormField field
    rate
FullRateDto
List of rates assigned to contract
      id
Long
Unique ID of the rate item.
      rateType
SimpleLovDto
Rate type
      defCondFrom
SimpleLovDto
DefCondForm
      rateUnit
RateUnitDto
Describes rate unit
        id
Long
Unique ID of the current rate unit item.
        name
String
Name of the current rate unit.
        type
SimpleLovDto
Type of the current rate unit.
      chargeRate
BigDecimal
Charge rate
      payRate
BigDecimal
Pay rate
      paySupplier
BigDecimal
Pay supplier
      supplierCharge
BigDecimal
Supplier charge
      supplierRate
BigDecimal
Supplier rate
      overAll
BigDecimal
Rate over all
    alternativeApprovers
UserDto
List of alternative approvers for contract
  jobTitle
String
Name of job assigned to Time Sheet
  costCenter
String
Cost center
  actionAvailability
TimeSheetActionsAvailability
Describes available actions for current Time Sheet
    canApprove
Boolean
Defines if Time Sheet can be approved. Possible values: true or false
    canReject
Boolean
Defines if Time Sheet can be rejected. Possible values: true or false
    canSave
Boolean
Defines if Time Sheet can be saved. Possible values: true or false
    canSubmit
Boolean
Defines if Time Sheet can be submitted. Possible values: true or false
    showChronologyAlert
Boolean
Defines if Time Sheet has show chronology alert enabled. Possible values: true or false
  availableApprovers
UserDto
List of data of available approvers for Time Sheet
  costCenterLovName
String
Internal TLK LOV name for cost center
  costCenterTranslated
String
Translated value of Cost Center
  reasonOfAdjustment
String
Reason of Time Sheet adjustment
  firstStep
StepDto
First step assigned to Time Sheet
    id
Long
Internal Talentlink Step DTO
    nextStep
StepDto
Represents next step
    status
String
Represents step status
    startDate
Date
Date when step was started
    endDate
Date
Date when step processing ended
    stepMembers
StepMemberDto
List of users that are assigned to step preocessing
      id
Long
Internal Talentlink User ID of user assigned to Step
      user
UserDto
Represents user data
      status
String
Status of member within process
      order
Long
Order of step member
    stepType
String
[deprecated] Step type
Imports a global queue configuration from a XML file.

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
queueXMLConfig
String
Representation of a queue configuration. cannot be null.
queueName
String
Optional name of imported queue. If not specified queue name from XML document is used.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
Imports a local queue configuration from a XML file.

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
queueXMLConfig
String
Representation of a queue configuration. cannot be null.
queueName
String
Optional name of imported queue. If not specified queue name from XML document is used.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
Provides a list of all queues available in the system for currently logged 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

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
queueNames
List
A list of queue names sorted alphabetically.
Provides a list of all queues available in the system for currently logged user. It returns more detailed data than listAllQueues.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
queues
TlkQueuesDto
A list of queue names sorted alphabetically.
  queue
TlkQueueDto
List of queues
    name
String
Talentlink queue name
    elementsCount
Long
Number of elements in queue
Removes next Application from a queue.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
Removes next Application Step from a queue.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
Removes next Candidate object from a queue.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
Removes next Contract from a queue.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
Removes next External System Request from a queue.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
Removes next Position from a queue.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
Removes a queue with all it's elements.

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
queueName
String
Name of the queue that should be removed. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void
True if a queue was successfully removed, false if it didn't exist.
Removes next Time Sheet from a queue.

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
queueName
String
Name of the queue. Can't be null.

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
void
Void