AFaffinda
Search & Match

Get search result of specific resume

Changed on

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

post/v3/resume_search/details/{identifier}

Request

Path parameters

identifierstring required
Example:ELglqBbT

Resume identifier

Request body

indicesstring[] required
jobDescriptionstring

A random string that uniquely identify the resource.

resumestring

A random string that uniquely identify the resource.

jobTitlesstring[]
jobTitlesCurrentOnlyboolean

Search only through the canditate's current job

jobTitlesRequiredboolean
jobTitlesWeightnumber
yearsExperienceMininteger nullable

Minimum years of total work experience

yearsExperienceMaxinteger nullable

Maximum years of total work experience

yearsExperienceRequiredboolean
yearsExperienceWeightnumber
locationsWeightnumber
locationsRequiredboolean
skillsWeightnumber
languagesWeightnumber
institutionsstring[]
institutionsRequiredboolean
degreesstring[]
degreesRequiredboolean
highestDegreeTypesEducationLevel[]
highestDegreeTypesRequiredboolean
isCurrentStudentboolean

Search for student canditates

isCurrentStudentRequiredboolean
isRecentGraduateboolean

Search for canditates that graduated less than a year ago

isRecentGraduateRequiredboolean
educationWeightnumber
searchExpressionstring nullable

Search through resumes' raw text

searchExpressionRequiredboolean
searchExpressionWeightnumber
socCodesinteger[]
socCodesWeightnumber
socCodesRequiredboolean
managementLevel'None' | 'Low' | 'Mid' | 'Upper' nullable
managementLevelRequiredboolean
managementLevelWeightnumber

Example request

{
  "indices": [
    "all-resumes"
  ],
  "highestDegreeTypes": [
    "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",
        "startDate": "2021-06-16",
        "endDate": "2022-05-01",
        "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": [
      {
        "organization": "Virginia Polytechnic Institute and State University (Virginia Tech)",
        "accreditation": {
          "education": "Bachelor of Science",
          "inputStr": "Bachelor of Science, Mechanical Engineering, expected",
          "matchStr": "Bachelor of Science",
          "educationLevel": "bachelors"
        },
        "grade": {
          "raw": "GPA : 3.35",
          "metric": "GPA",
          "value": "3.35"
        },
        "location": {
          "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"
        },
        "dates": {
          "completionDate": "2021-05-01",
          "startDate": "2019-05-01",
          "rawText": "May-Aug '18"
        },
        "match": true
      }
    ]
  },
  "skills": {
    "value": [
      {
        "lastUsed": "2022-05-16",
        "match": true
      }
    ]
  },
  "experience": {
    "match": true
  },
  "occupationGroup": {
    "value": [
      {
        "match": true
      }
    ]
  },
  "languages": {
    "value": [
      {
        "lastUsed": "2022-05-16",
        "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

    • warning

      the request property's min was set to 0.00

    • warning

      the request property's min was set to 0.00

    • info

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

    • info

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

    • info

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

    • info

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