AFaffinda
Search & Match

Get search result of specific job description

Changed on

This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this job description. The identifier is the unique ID returned via the /job_description_search endpoint.

post/v3/job_description_search/details/{identifier}

Request

Path parameters

identifierstring required
Example:ELgrnBbM

Job Description identifier

Request body

indicesstring[] required
resumestring

A random string that uniquely identify the resource.

jobTitlesstring[]
jobTitlesRequiredboolean
jobTitlesWeightnumber
totalYearsExperiencenumber nullable
yearsExperienceRequiredboolean
yearsExperienceWeightnumber
locationsWeightnumber
locationsRequiredboolean
skillsWeightnumber
languagesWeightnumber
degreesstring[]
degreesRequiredboolean
degreeTypesEducationLevel[]
degreeTypesRequiredboolean
educationWeightnumber
searchExpressionstring nullable
searchExpressionRequiredboolean
searchExpressionWeightnumber
socCodesinteger[]
socCodesWeightnumber
socCodesRequiredboolean
managementLevel'None' | 'Low' | 'Mid' | 'Upper' nullable
managementLevelRequiredboolean
managementLevelWeightnumber

Example request

{
  "indices": [
    "all-job-descriptions"
  ],
  "degreeTypes": [
    "bachelors"
  ],
  "managementLevel": "Low",
  "customData": [
    {
      "filterType": "equals",
      "dataPoint": "isAvailable",
      "field": "isAvailable",
      "query": {
        "value": true
      }
    }
  ]
}

Response

Successfully retrieved detail search result.

Example response

{
  "jobTitle": {
    "value": {
      "name": "Javascript developer",
      "companyName": "Affinda",
      "match": true
    }
  },
  "location": {
    "value": {
      "formatted": "Blacksburg, VA, USA",
      "postalCode": "3124",
      "state": "Virginia",
      "stateCode": "TX",
      "country": "United States",
      "countryCode": "US",
      "rawInput": "Blacksburg, VA",
      "streetNumber": "1",
      "street": "Smith St",
      "apartmentNumber": "12",
      "city": "Blacksburg",
      "poBox": "P.O. Box 123",
      "match": true
    }
  },
  "education": {
    "value": {
      "match": true
    }
  },
  "skills": {
    "value": [
      {
        "name": "Java Programming Language",
        "match": true
      }
    ]
  },
  "experience": {
    "match": true
  },
  "occupationGroup": {
    "value": {
      "match": true
    }
  },
  "languages": {
    "value": [
      {
        "name": "English",
        "match": true
      }
    ]
  },
  "managementLevel": {
    "level": "Low",
    "match": true
  }
}

Changes

  • 978cf99a2ac0Revision changes
    • warning

      the / request property's max was set to 9999.00

    • warning

      the / request property's min was set to 1.00

    • info

      api tag Search & Match added

    • info

      api tag Search & Match API - Searching removed

    • info

      added the new optional request property //

    • info

      the request property // became nullable

    • info

      the request property // became optional

    • info

      request property // deprecated

  • c3123d7b7301Revision changes
    • warning

      the // request property's min was set to 1.00

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status