v1

latestOpenAPI 3.1.02026-07-242892032.8 MB
Endpoints

Resume Search

Searches stored resumes using various filters and matching criteria.

post/searchservice/resumesearch

Request body

Example request

{
  "searchCriteria": {
    "resume": {
      "binaryData": "JVBERi0xLjUNJeLjz9MNCjEwNyAwIG9PnN0cmVhbQ0....",
      "extension": "pdf"
    },
    "additionalFilters": {
      "maximumDocumentCount": 30
    },
    "instanceType": "SPECTRUM",
    "locale": "en_us",
    "vendor": "testresume"
  }
}

Response

OK

statusboolean
statusCodestring
requestIdstring uuid
timeStampstring date-time

Example response

{
  "status": true,
  "statusCode": "OK",
  "requestId": "0a77a2ef-1423-494c-8bad-c02bd49cbbd7",
  "timeStamp": "2023-08-02 11:39:12.553",
  "responseData": {
    "vendorName": "testresume",
    "locale": "en_us",
    "instanceType": "SPECTRUM",
    "resultsCount": 20,
    "offset": 1,
    "maxDocumentCount": 30,
    "minimumScore": 0,
    "orderBy": "score",
    "sortDirection": "DESC",
    "candidates": [
      {
        "resumeId": "Resumepdfpdf",
        "name": "Jane Doe",
        "score": 1000,
        "yrsExp": 26,
        "employmentHistory": [
          {
            "jobTitle": "Contracts Manager",
            "employer": "CSU Office of the Chancellor",
            "start": "2002",
            "end": "present"
          },
          {
            "jobTitle": "Systems Management Specialist",
            "employer": "Inc",
            "start": "1997",
            "end": "2002"
          },
          {
            "jobTitle": "Purchasing Agent"
          }
        ],
        "educationHistory": [
          {
            "degree": "Bachelor of Arts (BA)",
            "major": "Business Administration",
            "end": "2011"
          }
        ],
        "locationHistory": [
          {
            "city": "Long Beach",
            "state": "CA"
          }
        ],
        "matchExplanation": {
          "matched": "37",
          "total": "37",
          "models": [
            {
              "name": [
                "skills",
                "bgtocc",
                "canon_title",
                "skills"
              ],
              "value": [
                "Microsoft SharePoint",
                "Commodities",
                "Purchasing Agent",
                "Contract Manager"
              ]
            }
          ]
        }
      },
      {
        "resumeId": "Resumetxttxt",
        "name": "SCOTT GRITTON",
        "score": 6,
        "yrsExp": 31,
        "employmentHistory": [
          {
            "jobTitle": "Automation SQA Engineer and Test Tools Developer",
            "employer": "RICOH SILICON VALLEY",
            "start": "2011",
            "end": "present"
          },
          {
            "jobTitle": "Lead Automation SQA Engineer",
            "employer": "CLICKSOFTWARE.COM",
            "start": "2000",
            "end": "2000"
          },
          {
            "jobTitle": "Lead Automation SQA Engineer",
            "employer": "CAERE CORPORATION",
            "start": "1998",
            "end": "2000"
          }
        ],
        "educationHistory": [
          {
            "degree": "Bachelor of Arts",
            "end": "Sep-1991"
          }
        ],
        "locationHistory": [
          {
            "city": "Santa Cruz",
            "state": "CA"
          }
        ],
        "matchExplanation": {
          "matched": "3",
          "total": "37",
          "models": [
            {
              "name": [
                "skills",
                "yrsexp",
                "degree_level"
              ],
              "value": [
                "Training",
                "25",
                "16"
              ]
            }
          ]
        }
      }
    ],
    "totalFound": 2
  }
}