FoAdvert

The Lumesse FoAdvert web service provides methods for developers to build career websites based on published positions from TalentLink.

The FoAdvert service is used to retrieve adverts based on supplied search criteria.

Typical workflow

 

Use Case

Clients can build a custom career site based on postings exported from TalentLink as an alternative to integrating front end components. Clients may then build their career site on the technology, including lay-out and style with no constraints.

Pre-condition - All advertisements must be created within TalentLink. The client calls the FoAdvert web service to get the advertisements from TalentLink.

Scenario

  1. A search page will typically consist of a form where a candidate can select search criteria. You can set the filters to the searchCriteriaDTO and call the method getAdvertisements.
  2. The methods getAdvertisements and getAdvertisementsByPage both return full details of each advertisement that matches the search criteria supplied.
  3. The method getAdvertisements takes parameters of "firstResult" and "maxResults". maxResults is the number of results to return (i.e. records per page) and firstResult is the number of the starting record (starting at 0). To return 8 records per page, maxResults would always be set to 8 and firstResult would be set to (PageNo - 1) * 8. For example, to display page 3, firstResult would be set to (3 - 1) * 8 = 16. SortingDetails should be provided to ensure that the results are returned in the same order as you move between the pages.
  4. If getSimpleAdvertisements or getSimpleAdvertisementsByPage are called, the posting target ID can be passed as a parameter to getAdvertisementsByID to retrieve the full details.
  5. The method getAdvertisementsByID can be used to retrieve the full details of a single FoAdvert.
  6. Pagination can be achieved by calling either getAdvertisements or getAdvertisementsByPage. If calling getAdvertisementsByPage the number of results per page is configured in TalentLink.

Additional Information

Entity Description
Channel A channel represents a source to which a position can be published. For example it may be a job board or a web site. Each channel is made up of an ID, name, description and unique technical ID.
Posting A posting can be thought of an advert. A posting is created in a single language and is made up of a title, language, location and description.
Each position can have multiple postings, perhaps in different languages or different wording in the same language.
Posting Target A posting target represents a posting being posted to a single channel. For example a position may have a posting in French. The French posting may be posted to a French job board and to a French career site. In that case there would be two posting targets. Each posting target has it’s own start and end date along with the URL to apply for the position and the URL to see the position description.

Response Format

XML

The method getAdvertisementById is used to get full details of a single advertisement, langCode is used to return any configurable values in the selected language.

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

Post Parameter

 
Parameter Data Type Description
postingTargetId
Long PostingTargetId of the job
langCode
LangCode Language code Used for translation of labels and error messages If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
advertisement
AdvertisementDto
  categoryLists
List Group containing list of categories
    categoryList
CategoryListCriterion
      label
String Name of the field
      criteria
List List of criteria
        criterion
Criterion List of criteria
          label
String Name of the field
          value
String Value of the field
      categoryNo
Long Name of the field
      value
String Value of the field
  compensationMaxValue
Double max salary e.g.: 70000.00
  customLovs
List Group containing list of customLov
    customLov
LovCriterion
      label
String Name of the field
      criteria
List Group containing list of criterion
        criterion
LovWithActivatorsCriterion
          label
String Name of the field
          value
String Value of the field
          activators
Collection List of activator criteria
      order
Long Order of elements
      parents
List Parents of LOV
        parent
Criterion List of criteria
      value
String Value of the field
  location
String Location/city of the Job advert e.g.: London
  configurableFields
List Group containing list of configurableField
    configurableField
LovCriterion
  postingStartDate
Date Posting Start Date e.g.: 2013-09-13T00:00:00+02:00
  recruiters
List Group containing list of recruiters Team user(s) Note: this will not be made available if flagged during posting in the system.
    recruiter
SimpleUserDto Class represents simple user data. It is used for operationalteamuser and recruiter.
      order
Long Order e.g.: 1
      value
String Full name of the user e.g.: John Wright
  externalJobNumber
String Optional job number referenced to external application
  expectedEndDate
Date Expected end date
  duration
String Duration
  keyword
String Keywords specified for the Advert job e.g.: Team leader, Accounts
  status
String Status of the job advert e.g.: Open
  customFields
List Group containing list of customFields. This includes the different sections of the job description.
    customField
CustomField Contain customized label-value pairs.
      label
String name of the custom field e.g.: Additional Information
      unlocalizedLabel
String Returns unlocalized label of the current customField.
      order
int Returns the (optional) position order of the current CustomField, or zero if no order was set before.
      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.
  id
Long TLK specific Posting target id e.g.: false Note: this is not the Opening Id
  postingEndDate
Date Posting End Date e.g.: 2013-12-13T23:59:59+02:00
  dueDate
Date Posting Due Date e.g.: 2013-12-13T23:59:59+02:00
  recruitingCompany
String Recruiting Company e.g.: Lumesse
  jobTitle
String Advert job title e.g.: Accounts Receivable Team Leader Note: this is not the Opening job title
  comment
String Additional text comment for advertisement
  jobNumber
String TLK Unique opening reference number e.g.: LUM00038
  showCompensation
boolean Flag to indicate whether to display salary or not. e.g.: true
  language
String Language code of the job advertisement e.g.: UK
  applicationUrl
String The URL used to make an application for the position. (Please note in some cases the URL will need to be decoded)
  compensationMinValue
Double min salary e.g.: 50000.00
  organizations
List Group which wraps the organization details to which the job belongs to
    organization
OrganizationCriterion
      label
String Name of the field
      subOrganizations
OrganizationCriterion Sub organizations hierarchy criteria
      level
Long Level of the organization e.g.: 2
      value
String Value of the field
  postingTargetStatus
String Posting Target Status e.g.: Published
  expectedStartDate
Date Expected start date
  standardLovs
List Group containing list of standard LOVs
    standardLov
LovCriterion
  siteLanguage
String Language code of the job advertisement e.g.: UK
  generalApplication
boolean Is application general e.g.: false
  operationals
List Group containing list of Operational Team user(s)
    operational
SimpleUserDto Class represents simple user data. It is used for operationalteamuser and recruiter.
  showRecruiter
boolean Flag to indicate whether to display recruiter details or not. e.g.: true
The method getAdvertisementImages is used to get images linked to the advertisement so it can be properly rendered including branding, maps and other graphical content.

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

Post Parameter

 
Parameter Data Type Description
postingTargetId
Long [mandatory if token is not provided] Id of the posting to the channel - posting target Id
tokenString
String [mandatory if id is not provided] Token of advertisement draft

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
advertisementImage
List
  position
Lov.ImagePosition.Values This is the defined position of where the image appears. Possible values are listed below. - Header1 - Header2 - TopOfJobDescription - Bottom
  url
String URL of the image
  id
String Internal TalentLink id of the Image.
The method getAdvertisementPreviewByToken is used to preview advertisement data basing.

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

Post Parameter

 
Parameter Data Type Description
tokenString
String [mandatory] Token of advertisement draft
langCode
LangCode Language code Used for translation of labels and error messages If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
advertisement
AdvertisementDto
  categoryLists
List Group containing list of categories
    categoryList
CategoryListCriterion
      label
String Name of the field
      criteria
List List of criteria
        criterion
Criterion List of criteria
          label
String Name of the field
          value
String Value of the field
      categoryNo
Long Name of the field
      value
String Value of the field
  compensationMaxValue
Double max salary e.g.: 70000.00
  customLovs
List Group containing list of customLov
    customLov
LovCriterion
      label
String Name of the field
      criteria
List Group containing list of criterion
        criterion
LovWithActivatorsCriterion
          label
String Name of the field
          value
String Value of the field
          activators
Collection List of activator criteria
      order
Long Order of elements
      parents
List Parents of LOV
        parent
Criterion List of criteria
      value
String Value of the field
  location
String Location/city of the Job advert e.g.: London
  configurableFields
List Group containing list of configurableField
    configurableField
LovCriterion
  postingStartDate
Date Posting Start Date e.g.: 2013-09-13T00:00:00+02:00
  recruiters
List Group containing list of recruiters Team user(s) Note: this will not be made available if flagged during posting in the system.
    recruiter
SimpleUserDto Class represents simple user data. It is used for operationalteamuser and recruiter.
      order
Long Order e.g.: 1
      value
String Full name of the user e.g.: John Wright
  externalJobNumber
String Optional job number referenced to external application
  expectedEndDate
Date Expected end date
  duration
String Duration
  keyword
String Keywords specified for the Advert job e.g.: Team leader, Accounts
  status
String Status of the job advert e.g.: Open
  customFields
List Group containing list of customFields. This includes the different sections of the job description.
    customField
CustomField Contain customized label-value pairs.
      label
String name of the custom field e.g.: Additional Information
      unlocalizedLabel
String Returns unlocalized label of the current customField.
      order
int Returns the (optional) position order of the current CustomField, or zero if no order was set before.
      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.
  id
Long TLK specific Posting target id e.g.: false Note: this is not the Opening Id
  postingEndDate
Date Posting End Date e.g.: 2013-12-13T23:59:59+02:00
  dueDate
Date Posting Due Date e.g.: 2013-12-13T23:59:59+02:00
  recruitingCompany
String Recruiting Company e.g.: Lumesse
  jobTitle
String Advert job title e.g.: Accounts Receivable Team Leader Note: this is not the Opening job title
  comment
String Additional text comment for advertisement
  jobNumber
String TLK Unique opening reference number e.g.: LUM00038
  showCompensation
boolean Flag to indicate whether to display salary or not. e.g.: true
  language
String Language code of the job advertisement e.g.: UK
  applicationUrl
String The URL used to make an application for the position. (Please note in some cases the URL will need to be decoded)
  compensationMinValue
Double min salary e.g.: 50000.00
  organizations
List Group which wraps the organization details to which the job belongs to
    organization
OrganizationCriterion
      label
String Name of the field
      subOrganizations
OrganizationCriterion Sub organizations hierarchy criteria
      level
Long Level of the organization e.g.: 2
      value
String Value of the field
  postingTargetStatus
String Posting Target Status e.g.: Published
  expectedStartDate
Date Expected start date
  standardLovs
List Group containing list of standard LOVs
    standardLov
LovCriterion
  siteLanguage
String Language code of the job advertisement e.g.: UK
  generalApplication
boolean Is application general e.g.: false
  operationals
List Group containing list of Operational Team user(s)
    operational
SimpleUserDto Class represents simple user data. It is used for operationalteamuser and recruiter.
  showRecruiter
boolean Flag to indicate whether to display recruiter details or not. e.g.: true
The method getAdvertisements returns a maximum of 100 job advertisements for site; that match given search criteria per request. The order of the returned results is set by the sortingDetails parameter.

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

Post Parameter

 
Parameter Data Type Description
firstResult
int This represents the page for instance: ‘1’ would represent the first page from the list of job advertisements. If you would to select another page or range you could try many combinations e.g: 3 -1 = from page 3 to page 1 Vice versa would do the opposite as from page 1 to page 3
maxResults
int To display the maximum number of job advertisements (maximum allowed upto 100)
searchCriteriaDto
SearchCriteriaDto
  categoryLists
List Specifies list of categoryLists. This can be used to filter applications by category criterion. e.g. <categoryLists> <categoryList> <categoryIds> <categoryId>41</categoryId> <categoryId>42</categoryId> </categoryIds> </categoryList> <categoryList> <categoryIds> <categoryId>89</categoryId> </categoryIds> </categoryList> </categoryLists>
    categoryList
CategoryNameDto
      categoryIds
List Specifies list of category criterion IDs. More than one category criterion ID can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped.
        categoryId
Long ID of the category
      order
Integer Order of Category to be returned
  contractTypes
List Specifies list of contractType IDs. This can be used to filter applications by contractType. More than one contractType can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <contractTypes> <contractType>107</contractType> <contractType>107</contractType> </contractTypes>
    contractType
Long ID of the contract
  regions
List Specifies list of region IDs. This can be used to filter applications by region. More than one region id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <regions> <region>251</region> <region>252</region> </regions>
    region
Long ID of the region
  postedSince
Integer Specifies days since application post date search criterion. For example: 7
  generalApplication
Boolean Specifies is application a General Application search criterion. Values to be used "TRUE" or "FALSE"
  customLovs
List Specifies list of Custom LOV groups. This can be used to filter applications by Custom LOV. More than one Custom LOV group can be added. Depending on how the payload is formed, search logic applied will change. e.g. e.g.: Logic applied: 123 OR 124 <customLovs> <customLovGroup> <customLov>123</customLov> <customLov>124</customLov> </customLovGroup> </customLovs> e.g.: Logic applied: 123 AND 124 <customLovs> <customLovGroup> <customLov>123</customLov> </customLovGroup> <customLovGroup> <customLov>124</customLov> </customLovGroup> </customLovs>
    customLovGroup
CustomLovGroup Group containing list of custom LOV(s) Note: This could be zero or more
      customLov
Long Custom LOV's ID. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped.
  scheduleTypes
List Specifies list of scheduleType IDs. This can be used to filter applications by scheduleType. More than one scheduleType id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <scheduleTypes> <scheduleType>341</scheduleType> <scheduleType>342</scheduleType> </scheduleTypes>
    scheduleType
Long ID of the schedule type
  jobNumber
String Specifies position ref number search criterion. For example: TEST00032
  organizationIds
List Specifies list of Organization IDs. This can be used to filter applications by organization. More than one organization id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <organizationIds> <organizationId>102</organizationId> <organizationId>103</organizationId> </organizationIds>
    organizationId
Long ID of the organization
  countries
List Specifies list of country IDs. This can be used to filter applications by country. More than one country can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <countries> <country>1121</country> <country>1122</country> </countries>
    country
Long ID of the country
  keywords
String Specifies keywords to be found in advertisement.
  adLanguages
List Specifies list of languages of advertisements. e.g.: <adLanguages> <language>UK</language> <language>DE</language> </adLanguages> Possible values: Click to see possible values
    language
String Language of the advert
sortingDetailsDto
SortingDetailsDto
  sortType
SortType Sorting type e.g. NONE, ASCENDING, DESCENDING.
  columnName
String Name of column to perform sort on.
langCode
LangCode Language code Used for translation of labels and error messages If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
advertisementResult
AdvertisementResultDto Group containing list of advertisement(s)
  advertisement
AdvertisementDto Collection of advertisement.
    categoryLists
List Group containing list of categories
      categoryList
CategoryListCriterion
        label
String Name of the field
        criteria
List List of criteria
          criterion
Criterion List of criteria
            label
String Name of the field
            value
String Value of the field
        categoryNo
Long Name of the field
        value
String Value of the field
    compensationMaxValue
Double max salary e.g.: 70000.00
    customLovs
List Group containing list of customLov
      customLov
LovCriterion
        label
String Name of the field
        criteria
List Group containing list of criterion
          criterion
LovWithActivatorsCriterion
            label
String Name of the field
            value
String Value of the field
            activators
Collection List of activator criteria
        order
Long Order of elements
        parents
List Parents of LOV
          parent
Criterion List of criteria
        value
String Value of the field
    location
String Location/city of the Job advert e.g.: London
    configurableFields
List Group containing list of configurableField
      configurableField
LovCriterion
    postingStartDate
Date Posting Start Date e.g.: 2013-09-13T00:00:00+02:00
    recruiters
List Group containing list of recruiters Team user(s) Note: this will not be made available if flagged during posting in the system.
      recruiter
SimpleUserDto Class represents simple user data. It is used for operationalteamuser and recruiter.
        order
Long Order e.g.: 1
        value
String Full name of the user e.g.: John Wright
    externalJobNumber
String Optional job number referenced to external application
    expectedEndDate
Date Expected end date
    duration
String Duration
    keyword
String Keywords specified for the Advert job e.g.: Team leader, Accounts
    status
String Status of the job advert e.g.: Open
    customFields
List Group containing list of customFields. This includes the different sections of the job description.
      customField
CustomField Contain customized label-value pairs.
        label
String name of the custom field e.g.: Additional Information
        unlocalizedLabel
String Returns unlocalized label of the current customField.
        order
int Returns the (optional) position order of the current CustomField, or zero if no order was set before.
        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.
    id
Long TLK specific Posting target id e.g.: false Note: this is not the Opening Id
    postingEndDate
Date Posting End Date e.g.: 2013-12-13T23:59:59+02:00
    dueDate
Date Posting Due Date e.g.: 2013-12-13T23:59:59+02:00
    recruitingCompany
String Recruiting Company e.g.: Lumesse
    jobTitle
String Advert job title e.g.: Accounts Receivable Team Leader Note: this is not the Opening job title
    comment
String Additional text comment for advertisement
    jobNumber
String TLK Unique opening reference number e.g.: LUM00038
    showCompensation
boolean Flag to indicate whether to display salary or not. e.g.: true
    language
String Language code of the job advertisement e.g.: UK
    applicationUrl
String The URL used to make an application for the position. (Please note in some cases the URL will need to be decoded)
    compensationMinValue
Double min salary e.g.: 50000.00
    organizations
List Group which wraps the organization details to which the job belongs to
      organization
OrganizationCriterion
        label
String Name of the field
        subOrganizations
OrganizationCriterion Sub organizations hierarchy criteria
        level
Long Level of the organization e.g.: 2
        value
String Value of the field
    postingTargetStatus
String Posting Target Status e.g.: Published
    expectedStartDate
Date Expected start date
    standardLovs
List Group containing list of standard LOVs
      standardLov
LovCriterion
    siteLanguage
String Language code of the job advertisement e.g.: UK
    generalApplication
boolean Is application general e.g.: false
    operationals
List Group containing list of Operational Team user(s)
      operational
SimpleUserDto Class represents simple user data. It is used for operationalteamuser and recruiter.
    showRecruiter
boolean Flag to indicate whether to display recruiter details or not. e.g.: true
  totalResults
Integer Total number of search results returned
The method getAdvertisementsByPage is similar to getAdvertisements. The "pageNumber" parameter can be used to return a specified page of results. The number of results per page is set in the TalentLink system; which is 100.

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

Post Parameter

 
Parameter Data Type Description
pageNumber
int Number of the page of the results (number of item on the page is defined in the code)
searchCriteriaDto
SearchCriteriaDto
  categoryLists
List Specifies list of categoryLists. This can be used to filter applications by category criterion. e.g. <categoryLists> <categoryList> <categoryIds> <categoryId>41</categoryId> <categoryId>42</categoryId> </categoryIds> </categoryList> <categoryList> <categoryIds> <categoryId>89</categoryId> </categoryIds> </categoryList> </categoryLists>
    categoryList
CategoryNameDto
      categoryIds
List Specifies list of category criterion IDs. More than one category criterion ID can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped.
        categoryId
Long ID of the category
      order
Integer Order of Category to be returned
  contractTypes
List Specifies list of contractType IDs. This can be used to filter applications by contractType. More than one contractType can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <contractTypes> <contractType>107</contractType> <contractType>107</contractType> </contractTypes>
    contractType
Long ID of the contract
  regions
List Specifies list of region IDs. This can be used to filter applications by region. More than one region id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <regions> <region>251</region> <region>252</region> </regions>
    region
Long ID of the region
  postedSince
Integer Specifies days since application post date search criterion. For example: 7
  generalApplication
Boolean Specifies is application a General Application search criterion. Values to be used "TRUE" or "FALSE"
  customLovs
List Specifies list of Custom LOV groups. This can be used to filter applications by Custom LOV. More than one Custom LOV group can be added. Depending on how the payload is formed, search logic applied will change. e.g. e.g.: Logic applied: 123 OR 124 <customLovs> <customLovGroup> <customLov>123</customLov> <customLov>124</customLov> </customLovGroup> </customLovs> e.g.: Logic applied: 123 AND 124 <customLovs> <customLovGroup> <customLov>123</customLov> </customLovGroup> <customLovGroup> <customLov>124</customLov> </customLovGroup> </customLovs>
    customLovGroup
CustomLovGroup Group containing list of custom LOV(s) Note: This could be zero or more
      customLov
Long Custom LOV's ID. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped.
  scheduleTypes
List Specifies list of scheduleType IDs. This can be used to filter applications by scheduleType. More than one scheduleType id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <scheduleTypes> <scheduleType>341</scheduleType> <scheduleType>342</scheduleType> </scheduleTypes>
    scheduleType
Long ID of the schedule type
  jobNumber
String Specifies position ref number search criterion. For example: TEST00032
  organizationIds
List Specifies list of Organization IDs. This can be used to filter applications by organization. More than one organization id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <organizationIds> <organizationId>102</organizationId> <organizationId>103</organizationId> </organizationIds>
    organizationId
Long ID of the organization
  countries
List Specifies list of country IDs. This can be used to filter applications by country. More than one country can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <countries> <country>1121</country> <country>1122</country> </countries>
    country
Long ID of the country
  keywords
String Specifies keywords to be found in advertisement.
  adLanguages
List Specifies list of languages of advertisements. e.g.: <adLanguages> <language>UK</language> <language>DE</language> </adLanguages> Possible values: Click to see possible values
    language
String Language of the advert
sortingDetailsDto
SortingDetailsDto
  sortType
SortType Sorting type e.g. NONE, ASCENDING, DESCENDING.
  columnName
String Name of column to perform sort on.
langCode
LangCode Language code Used for translation of labels and error messages If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
advertisementResult
AdvertisementResultDto
  advertisement
AdvertisementDto Collection of advertisement.
    categoryLists
List Group containing list of categories
      categoryList
CategoryListCriterion
        label
String Name of the field
        criteria
List List of criteria
          criterion
Criterion List of criteria
            label
String Name of the field
            value
String Value of the field
        categoryNo
Long Name of the field
        value
String Value of the field
    compensationMaxValue
Double max salary e.g.: 70000.00
    customLovs
List Group containing list of customLov
      customLov
LovCriterion
        label
String Name of the field
        criteria
List Group containing list of criterion
          criterion
LovWithActivatorsCriterion
            label
String Name of the field
            value
String Value of the field
            activators
Collection List of activator criteria
        order
Long Order of elements
        parents
List Parents of LOV
          parent
Criterion List of criteria
        value
String Value of the field
    location
String Location/city of the Job advert e.g.: London
    configurableFields
List Group containing list of configurableField
      configurableField
LovCriterion
    postingStartDate
Date Posting Start Date e.g.: 2013-09-13T00:00:00+02:00
    recruiters
List Group containing list of recruiters Team user(s) Note: this will not be made available if flagged during posting in the system.
      recruiter
SimpleUserDto Class represents simple user data. It is used for operationalteamuser and recruiter.
        order
Long Order e.g.: 1
        value
String Full name of the user e.g.: John Wright
    externalJobNumber
String Optional job number referenced to external application
    expectedEndDate
Date Expected end date
    duration
String Duration
    keyword
String Keywords specified for the Advert job e.g.: Team leader, Accounts
    status
String Status of the job advert e.g.: Open
    customFields
List Group containing list of customFields. This includes the different sections of the job description.
      customField
CustomField Contain customized label-value pairs.
        label
String name of the custom field e.g.: Additional Information
        unlocalizedLabel
String Returns unlocalized label of the current customField.
        order
int Returns the (optional) position order of the current CustomField, or zero if no order was set before.
        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.
    id
Long TLK specific Posting target id e.g.: false Note: this is not the Opening Id
    postingEndDate
Date Posting End Date e.g.: 2013-12-13T23:59:59+02:00
    dueDate
Date Posting Due Date e.g.: 2013-12-13T23:59:59+02:00
    recruitingCompany
String Recruiting Company e.g.: Lumesse
    jobTitle
String Advert job title e.g.: Accounts Receivable Team Leader Note: this is not the Opening job title
    comment
String Additional text comment for advertisement
    jobNumber
String TLK Unique opening reference number e.g.: LUM00038
    showCompensation
boolean Flag to indicate whether to display salary or not. e.g.: true
    language
String Language code of the job advertisement e.g.: UK
    applicationUrl
String The URL used to make an application for the position. (Please note in some cases the URL will need to be decoded)
    compensationMinValue
Double min salary e.g.: 50000.00
    organizations
List Group which wraps the organization details to which the job belongs to
      organization
OrganizationCriterion
        label
String Name of the field
        subOrganizations
OrganizationCriterion Sub organizations hierarchy criteria
        level
Long Level of the organization e.g.: 2
        value
String Value of the field
    postingTargetStatus
String Posting Target Status e.g.: Published
    expectedStartDate
Date Expected start date
    standardLovs
List Group containing list of standard LOVs
      standardLov
LovCriterion
    siteLanguage
String Language code of the job advertisement e.g.: UK
    generalApplication
boolean Is application general e.g.: false
    operationals
List Group containing list of Operational Team user(s)
      operational
SimpleUserDto Class represents simple user data. It is used for operationalteamuser and recruiter.
    showRecruiter
boolean Flag to indicate whether to display recruiter details or not. e.g.: true
  totalResults
Integer Total number of search results returned
The method getAdvertisementsSortingColumns is used to return column names which can be used for sorting advertisements.

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

Post Parameter

 
Parameter Data Type Description

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
advertisementSortingColumns
AdvertisementSortingColumns
  column
KeyValueDTO Columns that can be sorted
    key
String Key of the field.
    value
String Value of the field.
The method getAttachments is used to get attachments (files) linked to the advertisement. This allows to broadcast additional content.

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

Post Parameter

 
Parameter Data Type Description
postingTargetId
Long [mandatory] Id of the posting to the channel

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
attachment
List Group of all attachments
  mimeType
String
  content
byte
  id
Long
  fileName
String
The method getAttachmentsFromToken is used to get attachments (files) linked to the advertisement. This allows to broadcast additional content.

Post Parameter

 
Parameter Data Type Description
tokenString
String [mandatory] Token of advertisement

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
attachment
List
  mimeType
String
  content
byte
  id
Long
  fileName
String
The method getCriteria is used to return the standard criteria as well as all Custom LOVs (and its LOV hierarchy information) that match given order. Custom LOVs criteria are sorted by the values order defined by the user in TLK Back Office. The method returns the criteria in a specified language.

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

Post Parameter

 
Parameter Data Type Description
langCode
LangCode Language code Used for translation of labels and error messages If not provided then site master language is used. Click to see possible values
searchCriteriaSorting
SearchCriteriaSorting Provides possibility to set custom sort options for search criteria. If not set default order will be used. e.g.: <getCriteria> <searchCriteriaSorting> <categoryListsSorting>LABEL</categoryListsSorting> <customLovsSorting>ORDER</customLovsSorting> <standardLovsSorting>LABEL</standardLovsSorting> </searchCriteriaSorting> </getCriteria>
  categoryListsSorting
CriteriaSortType Represents sort order of Category List's criteria Possible values: LABEL, ORDER If not set ORDER sort is used
  customLovsSorting
CriteriaSortType Represents sort order of Custom LOV's criteria Possible values: LABEL, ORDER If not set ORDER sort is used
  standardLovsSorting
CriteriaSortType Represents sort order of Standard LOV's criteria Possible values: LABEL, ORDER If not set ORDER sort is used
lovOrders
String Represents Custom LOVs available for search. Should be a comma separated list (without any white signs). If not set no Custom LOV search criteria will be returned. e.g.: <getCriteria> <lovOrders>1,2,6</lovOrders> </getCriteria>

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
standardCriteriaWithLovs
AvailableSearchCriteriaDto
  categoryLists
List A collection of category lists. A category list is a list of selectable values associated with a channel.
    categoryList
CategoryListCriterion
      label
String Name of the field
      criteria
List List of criteria
        criterion
Criterion List of criteria
      categoryNo
Long Name of the field
      value
String Value of the field
  standardLovs
List A collection of standard LOVs that are used on all positions. Typically they are used for contract type and schedule type.
    standardLov
LovCriterion
  postedSince
Integer Specifies days since application post date search criterion. For example: 7
  customlovs
List Search criteria Lov used can have many customLov
    customLov
LovCriterion
      label
String Name of the field
      criteria
List Group containing list of criterion
        criterion
LovWithActivatorsCriterion
          label
String Name of the field
          value
String Value of the field
          activators
Collection List of activator criteria
      order
Long Order of elements
      parents
List Parents of LOV
        parent
Criterion List of criteria
      value
String Value of the field
  jobNumber
String ID of the job for which the advert was posted
  countries
List List of different countries, can be many grouped country values
    country
CountryCriterion A list of customFields with different country criterias
      label
String Name of the field
      regions
List Can have many regions listed within the country
        region
Criterion List of criteria
          label
String Name of the field
          value
String Value of the field
      value
String Value of the field
  adLanguages
List Is a group of a languages used, can be more than one within this list. Click to see possible values
    language
Criterion List of criteria
  keywords
String Specifies keywords to be found in advertisement.
  organizations
List A collection of organizations that have posted positions.
    organization
OrganizationCriterion
      label
String Name of the field
      subOrganizations
OrganizationCriterion Sub organizations hierarchy criteria
      level
Long Level of the organization e.g.: 2
      value
String Value of the field
The method getSimpleAdvertisements is used to return all Posting Target ID's for site that are matching given search criteria. The ID can be passed to getAdvertisementsById to retrieve the full details of an advertisement.

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

Post Parameter

 
Parameter Data Type Description
firstResult
int This represents the page for instance: ‘1’ would represent the first page from the list of job advertisements. If you would to select another page or range you could try many combinations e.g: 3 -1 = from page 3 to page 1 Vice versa would do the opposite as from page 1 to page 3
maxResults
int To display the maximum number of job advertisements
searchCriteriaDto
SearchCriteriaDto
  categoryLists
List Specifies list of categoryLists. This can be used to filter applications by category criterion. e.g. <categoryLists> <categoryList> <categoryIds> <categoryId>41</categoryId> <categoryId>42</categoryId> </categoryIds> </categoryList> <categoryList> <categoryIds> <categoryId>89</categoryId> </categoryIds> </categoryList> </categoryLists>
    categoryList
CategoryNameDto
      categoryIds
List Specifies list of category criterion IDs. More than one category criterion ID can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped.
        categoryId
Long ID of the category
      order
Integer Order of Category to be returned
  contractTypes
List Specifies list of contractType IDs. This can be used to filter applications by contractType. More than one contractType can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <contractTypes> <contractType>107</contractType> <contractType>107</contractType> </contractTypes>
    contractType
Long ID of the contract
  regions
List Specifies list of region IDs. This can be used to filter applications by region. More than one region id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <regions> <region>251</region> <region>252</region> </regions>
    region
Long ID of the region
  postedSince
Integer Specifies days since application post date search criterion. For example: 7
  generalApplication
Boolean Specifies is application a General Application search criterion. Values to be used "TRUE" or "FALSE"
  customLovs
List Specifies list of Custom LOV groups. This can be used to filter applications by Custom LOV. More than one Custom LOV group can be added. Depending on how the payload is formed, search logic applied will change. e.g. e.g.: Logic applied: 123 OR 124 <customLovs> <customLovGroup> <customLov>123</customLov> <customLov>124</customLov> </customLovGroup> </customLovs> e.g.: Logic applied: 123 AND 124 <customLovs> <customLovGroup> <customLov>123</customLov> </customLovGroup> <customLovGroup> <customLov>124</customLov> </customLovGroup> </customLovs>
    customLovGroup
CustomLovGroup Group containing list of custom LOV(s) Note: This could be zero or more
      customLov
Long Custom LOV's ID. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped.
  scheduleTypes
List Specifies list of scheduleType IDs. This can be used to filter applications by scheduleType. More than one scheduleType id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <scheduleTypes> <scheduleType>341</scheduleType> <scheduleType>342</scheduleType> </scheduleTypes>
    scheduleType
Long ID of the schedule type
  jobNumber
String Specifies position ref number search criterion. For example: TEST00032
  organizationIds
List Specifies list of Organization IDs. This can be used to filter applications by organization. More than one organization id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <organizationIds> <organizationId>102</organizationId> <organizationId>103</organizationId> </organizationIds>
    organizationId
Long ID of the organization
  countries
List Specifies list of country IDs. This can be used to filter applications by country. More than one country can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <countries> <country>1121</country> <country>1122</country> </countries>
    country
Long ID of the country
  keywords
String Specifies keywords to be found in advertisement.
  adLanguages
List Specifies list of languages of advertisements. e.g.: <adLanguages> <language>UK</language> <language>DE</language> </adLanguages> Possible values: Click to see possible values
    language
String Language of the advert
sortingDetailsDto
SortingDetailsDto
  sortType
SortType Sorting type e.g. NONE, ASCENDING, DESCENDING.
  columnName
String Name of column to perform sort on.
langCode
LangCode Language code Used for translation of labels and error messages If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
simpleAdvertisementResult
SimpleAdvertisementResultDto List of Job advertisements
  totalResults
Integer Number of results displayed from "0" upwards
  simpleAdvertisement
SimpleAdvertisementDto
    jobTitle
String The Job title how it appears
    id
Long ID of the Job Advertisement in the BackOffice
The method getSimpleAdvertisementsByPage is the same as getAdvertisementsByPage, but the response only includes the ID and the jobTitle of each advert. The ID can be passed to getAdvertisementsById to retrieve the full details of an advertisement.

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

Post Parameter

 
Parameter Data Type Description
pageNumber
int Number of the page of the results (number of item on the page is defined in the code)
searchCriteriaDto
SearchCriteriaDto
  categoryLists
List Specifies list of categoryLists. This can be used to filter applications by category criterion. e.g. <categoryLists> <categoryList> <categoryIds> <categoryId>41</categoryId> <categoryId>42</categoryId> </categoryIds> </categoryList> <categoryList> <categoryIds> <categoryId>89</categoryId> </categoryIds> </categoryList> </categoryLists>
    categoryList
CategoryNameDto
      categoryIds
List Specifies list of category criterion IDs. More than one category criterion ID can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped.
        categoryId
Long ID of the category
      order
Integer Order of Category to be returned
  contractTypes
List Specifies list of contractType IDs. This can be used to filter applications by contractType. More than one contractType can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <contractTypes> <contractType>107</contractType> <contractType>107</contractType> </contractTypes>
    contractType
Long ID of the contract
  regions
List Specifies list of region IDs. This can be used to filter applications by region. More than one region id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <regions> <region>251</region> <region>252</region> </regions>
    region
Long ID of the region
  postedSince
Integer Specifies days since application post date search criterion. For example: 7
  generalApplication
Boolean Specifies is application a General Application search criterion. Values to be used "TRUE" or "FALSE"
  customLovs
List Specifies list of Custom LOV groups. This can be used to filter applications by Custom LOV. More than one Custom LOV group can be added. Depending on how the payload is formed, search logic applied will change. e.g. e.g.: Logic applied: 123 OR 124 <customLovs> <customLovGroup> <customLov>123</customLov> <customLov>124</customLov> </customLovGroup> </customLovs> e.g.: Logic applied: 123 AND 124 <customLovs> <customLovGroup> <customLov>123</customLov> </customLovGroup> <customLovGroup> <customLov>124</customLov> </customLovGroup> </customLovs>
    customLovGroup
CustomLovGroup Group containing list of custom LOV(s) Note: This could be zero or more
      customLov
Long Custom LOV's ID. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped.
  scheduleTypes
List Specifies list of scheduleType IDs. This can be used to filter applications by scheduleType. More than one scheduleType id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <scheduleTypes> <scheduleType>341</scheduleType> <scheduleType>342</scheduleType> </scheduleTypes>
    scheduleType
Long ID of the schedule type
  jobNumber
String Specifies position ref number search criterion. For example: TEST00032
  organizationIds
List Specifies list of Organization IDs. This can be used to filter applications by organization. More than one organization id can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <organizationIds> <organizationId>102</organizationId> <organizationId>103</organizationId> </organizationIds>
    organizationId
Long ID of the organization
  countries
List Specifies list of country IDs. This can be used to filter applications by country. More than one country can be added. To obtain possible IDs use FoAdvert.getCriteria or FoAdvert.getStandardCriteria. Invalid values will be skipped. e.g. <countries> <country>1121</country> <country>1122</country> </countries>
    country
Long ID of the country
  keywords
String Specifies keywords to be found in advertisement.
  adLanguages
List Specifies list of languages of advertisements. e.g.: <adLanguages> <language>UK</language> <language>DE</language> </adLanguages> Possible values: Click to see possible values
    language
String Language of the advert
sortingDetailsDto
SortingDetailsDto
  sortType
SortType Sorting type e.g. NONE, ASCENDING, DESCENDING.
  columnName
String Name of column to perform sort on.
langCode
LangCode Language code Used for translation of labels and error messages If not provided then site master language is used. Click to see possible values

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
simpleAdvertisementResult
SimpleAdvertisementResultDto
  totalResults
Integer Number of results displayed from "0" upwards
  simpleAdvertisement
SimpleAdvertisementDto
    jobTitle
String The Job title how it appears
    id
Long ID of the Job Advertisement in the BackOffice
The method getStandardCriteria returns the following standard criteria: Countries - that have jobs posted, Regions - for previously returned countries, Contract Type, Schedule Type, Site Category List 1, Site Category List 2, Job ad languages - list of languages for which there are posted jobs, Organizations Level 1 that have access to this site.
The method returns criteria in a specified TLK supported language.

Returns available search criteria for currently logged site.

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

Post Parameter

 
Parameter Data Type Description
langCode
LangCode Language code Used for translation of labels and error messages If not provided then site master language is used. Click to see possible values
searchCriteriaSorting
SearchCriteriaSorting
  categoryListsSorting
CriteriaSortType Represents sort order of Category List's criteria Possible values: LABEL, ORDER If not set ORDER sort is used
  customLovsSorting
CriteriaSortType Represents sort order of Custom LOV's criteria Possible values: LABEL, ORDER If not set ORDER sort is used
  standardLovsSorting
CriteriaSortType Represents sort order of Standard LOV's criteria Possible values: LABEL, ORDER If not set ORDER sort is used

Request Parameter

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

Response Parameter

 
Parameter Data Type Description
standardCriteria
AvailableSearchCriteriaDto
  categoryLists
List A collection of category lists. A category list is a list of selectable values associated with a channel.
    categoryList
CategoryListCriterion
      label
String Name of the field
      criteria
List List of criteria
        criterion
Criterion List of criteria
      categoryNo
Long Name of the field
      value
String Value of the field
  standardLovs
List A collection of standard LOVs that are used on all positions. Typically they are used for contract type and schedule type.
    standardLov
LovCriterion
  postedSince
Integer Specifies days since application post date search criterion. For example: 7
  customlovs
List Search criteria Lov used can have many customLov
    customLov
LovCriterion
      label
String Name of the field
      criteria
List Group containing list of criterion
        criterion
LovWithActivatorsCriterion
          label
String Name of the field
          value
String Value of the field
          activators
Collection List of activator criteria
      order
Long Order of elements
      parents
List Parents of LOV
        parent
Criterion List of criteria
      value
String Value of the field
  jobNumber
String ID of the job for which the advert was posted
  countries
List List of different countries, can be many grouped country values
    country
CountryCriterion A list of customFields with different country criterias
      label
String Name of the field
      regions
List Can have many regions listed within the country
        region
Criterion List of criteria
          label
String Name of the field
          value
String Value of the field
      value
String Value of the field
  adLanguages
List Is a group of a languages used, can be more than one within this list. Click to see possible values
    language
Criterion List of criteria
  keywords
String Specifies keywords to be found in advertisement.
  organizations
List A collection of organizations that have posted positions.
    organization
OrganizationCriterion
      label
String Name of the field
      subOrganizations
OrganizationCriterion Sub organizations hierarchy criteria
      level
Long Level of the organization e.g.: 2
      value
String Value of the field