Positions

Positions Web service is used to managed TalentLink BackOffice positions

There are two methods of retrieving positions. The first is by using the position web service to get either a single position or all positions for an organization at a particular status. The second method is to define a queue of all positions that match a given criteria and to use the Queue web service to retrieve the positions one at a time.

Typical workflow Position

Use Case

Positions can be raised in ERP system or an HRIS before being managed by the recruitment team in TalentLink. Positions can be approved before or after export to TalentLink. TalentLink can be configured to do both.

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

Scenario

START. A job position is created in an ERP system or an HRIS by a recruiter or Hiring Manager.
The ERP system or HRIS calls the TalentLink Exchange createPosition web service.
If updating a position within an ERP system or by an HRIS recruiter calls the TalentLink Exchange service to use updatePosition webservice.
To check a single position within TalentLink use, getPostionById (this will be using the ID for the postion) or getPositionByReqNumber webservice (For this service you will need to use Requisition number)
To get all positions the ERP System or HRIS recruiter calls the TalentLink Exchange to use getPositions webservice, this will return all positions within an organization.
If TalentLink Exchange returns an error, an appropriate SOAP response is sent to the web service client (for SOAP web services).

Response Format

XML

The method createPosition is used to create a new position (requisition). This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
position	PositionDto
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

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

Parameter	Data Type	Description
position	PositionDto	The Position is returned with the parameter value added.
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

The method getOrganizations is used to retrieve the basic Organization Breakdown Structure. It provides the names, IDs of departments and amount of Requisitions created in each OBS. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
organizationLevel	Integer	Represents level of organization to which hierarchy should be returned. E.g. if 1 will be passed only level 1 organization will be returned, for 2 organizations level 1 and 2 will be returned. If not set all organization will be returned.

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

Parameter	Data Type	Description
organizationStructure	OrganizationStructureDto	Returns all organizations for a client and this includes all levels within the hierarchy
department	OrganizationStructureItemDto	Represents department
name	String	Department name (not translated)
departmentId	Long	Department id
parentDepartmentId	Long	Parent department id
subDepartments	List	List of sub departments
department	OrganizationStructureItemDto	Represents department
level	Integer	Department level
numberOfJobs	Long	Number of jobs in department. For first level department it is sum of jobs from all sub departments. For other levels it is number of jobs from this department (sub departments are not included)

The method getPositionByExternalJobNumber is used to retrieve a single position by its field "Requisition number" that exists on the requisition. Have in mind that this is NOT a similar field: "Internal Requisition Number". Note: Archived positions will be excluded from the search. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
jobNumber	String

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

Parameter	Data Type	Description
position	PositionDto	Details of the specified requisition.
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

The method getPositionById is used to retrieve a single position details by its ID. Note: Archived positions will be excluded from the search results. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
id	Long	ID of the position

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

Parameter	Data Type	Description
position	PositionDto	Details of the position.
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

The method getPositionByTeamMember allow to obtain all of the positions available for a specific user based on his email address or user Id. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
requestbyteammember	RequestByTeamMemberDto
teamType	String	Type of team where user is member
email	String	Email of the user
userId	Long	Id of the user
fromDate	Date	The earliest date when position was created
toDate	Date	The latest date when position was created
departmentLevel	Integer	The highest department level where position was created
page	Integer	Number of the results page

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

Parameter	Data Type	Description
position	List	Details of the specified requisition.
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

The method getPositions is used to retrieve all positions for a given organization and status. Note: Archived positions will be excluded from the search. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
orgId	Long	ID of the organization to which the position belongs
status	String	Status of the postions that will be included in result.
pageNumber	Int	Each page contains 100 results.

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

Parameter	Data Type	Description
position	List	List of postions for given cirteria.
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

The method getPositionsByObsId retrieves requisitions from indicated department's id and all of its sub-departments. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
requestbyobsid	RequestByObsIdDto
status	String	Status of Position.
includeSubLevels	Boolean	If set to true positions will be returned also for all sub-departments of the provided orgId.
pageNumber	Int	Each page contains 100 results.
fromCreatedDate	Date	The earliest date when position was created.
fromLastUpdate	Date	The earliest date when position was updated.
toCreatedDate	Date	The latest date when position was created.
toLastUpdate	Date	The latest date when position was updated.
organizationId	Long	ID of the organization.
requisitionType	String	Type of Requisition.
displayNumberOfPages	Boolean	If set information about number of pages will be returned.

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

Parameter	Data Type	Description
positionsByObsIdResponseDto	PositionsByObsIdResponseDto	List of postions for given cirteria.
position	PositionDto	List of positions.
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.
numberOfPages	Integer	Information about number of all pages.

The method getPositionByReqNumber is used to retrieve a single position by its Internal requisition number and NOT for a similar field "Requisition number" that exists on the requisition. Note: Archived positions will be excluded from the search. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
reqNumber	String	This is the requisition number of the position within TalentLink.

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

Parameter	Data Type	Description
position	List	Details of the specified requisition.
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

The method getPositionsByUser allow to obtain all of the positions available for a specific user based on his email address or user Id. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Parameter	Data Type	Description
requestparam	RequestParamsDto
email	String	Email of the user
userId	Long	Id of the user
fromDate	Date	The earliest date when position was created
toDate	Date	The latest date when position was created
departmentLevel	Integer	The highest department level where position was created
page	Integer	Number of the results page

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

Parameter	Data Type	Description
position	List	Details of the specified requisition.
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

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

Parameter	Data Type	Description
position	PositionDto
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

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

Parameter	Data Type	Description
position	Void

This method works similar to {@link #updatePosition(PositionDto)} but it is called from rest methods from UI and should not restore team and company fields like in WS. TLK-86649 and TLK-85585

Parameter	Data Type	Description
position	PositionDto
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.
title	String	Job title.
headCount	Long	[mandatory] Number of positions available.
creationDate	Date	The date the position was created
lastUpdate	Date	Date the position was last updated
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 counter, 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 counter
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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
email	String	Email of the user in the Lumesse BackOffice.
cellphone	String	Cellphone number of the user
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
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	Map	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	ID of the department
strapline	String	Strapline
images	Map	Key-value map of Image Positions with Images. Possible key values: Header1, Header2, TopOfJobDescription, Bottom
encryptApplicants	Boolean	Are applicants encrypted or not.

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

Parameter	Data Type	Description
position	Void

version 77 as of 4 weeks ago by Lukasz Krzywicki

Positions

Typical workflow Position

Use Case

Scenario

Response Format

createPosition

Post Parameter

Request Parameter

Response Parameter

getOrganizationStructure

Post Parameter

Request Parameter

Response Parameter

getPositionByExternalJobNumber

Post Parameter

Request Parameter

Response Parameter

getPositionById

Post Parameter

Request Parameter

Response Parameter

getPositionByTeamMember

Post Parameter

Request Parameter

Response Parameter

getPositions

Post Parameter

Request Parameter

Response Parameter

getPositionsByObsId

Post Parameter

Request Parameter

Response Parameter

getPositionsByReqNumber

Post Parameter

Request Parameter

Response Parameter

getPositionsByUser

Post Parameter

Request Parameter

Response Parameter

updatePosition

Post Parameter

Request Parameter

Response Parameter

updatePositionWithoutRestoringFields

Post Parameter

Request Parameter

Response Parameter

Docs Navigation

Useful Information