AFaffinda
Search & Match - Embedding

Get the config for the logged in user's embeddable job description search tool

Return configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.

get/v2/job_description_search/config

Request

Response

The config for the logged in user's embeddable job description search tool.

allowPdfDownloadboolean
maxResultsinteger nullable

Maximum number of results that can be returned. Setting to "null" means no limitation.

displayJobTitleboolean
displayLocationboolean
displayYearsExperienceboolean
displayOccupationGroupboolean
displayEducationboolean
displaySkillsboolean
displayLanguagesboolean
displayManagementLevelboolean
displayKeywordsboolean
weightJobTitlenumber
weightLocationnumber
weightYearsExperiencenumber
weightOccupationGroupnumber
weightEducationnumber
weightSkillsnumber
weightLanguagesnumber
weightManagementLevelnumber
weightKeywordsnumber
indicesstring[]

List of index names.

showIndexDropdownboolean nullable

Controls whether or not the index dropdown is displayed to the user

userIdinteger

ID of the logged in user.

usernamestring

Username of the logged in user.

hideToolbarboolean

Hide the reset/import toolbar.

hideSidePanelboolean

Hide the entire side panel.

distanceUnit'mi' | 'km'

The unit of distance to use for location based searches

Example response

{
  "maxResults": 10,
  "indices": [
    "all-job-descriptions",
    "my-index"
  ],
  "userId": 1234,
  "username": "big.smoke",
  "actions": [
    {
      "label": "Add to shortlist",
      "eventName": "addToShortlist"
    }
  ],
  "customFieldsConfig": [
    {
      "dataPoint": "RdNAniIH",
      "weight": 0.5
    }
  ],
  "distanceUnit": "km"
}

Changes

No recorded changes to this operation across all 1 revision of this API.