v1

latestOpenAPI 3.1.02026-07-242892032.8 MB

Endpoints

Resume Registration

Stores a resume for future search using a unique ID.

post/searchservice/resume/create

Request body

resumeIdstring required

Unique resume registration document id (max length : 100). This parameter is required.

binaryDatastring required

Base64 encoded binary resume data. This parameter is required.

extensionstring

The document extension (txt, doc, docx, rtf, etc...). The default extension would be 'txt'. This parameter is optional.

vendorstring

Vendor name (max length : 50). If not specified, default vendor would be used. This parameter is optional.

locale'en_us' required

Locale of the instance (en_us). This parameter is required.

instanceType'LENSSEARCH' | 'SPECTRUM' required

Instance type to be used to search (LENSSEARCH or SPECTRUM). This parameter is required.

registerParsedBinaryDataboolean

A flag to indicate register parsed resume (true or false). Default would be false. This parameter is optional.

errorOnDuplicateorOverwrite'Error' | 'Overwrite'

Enum value to overwrite existing resume with the specified Id (Error or Overwrite). Duplicate error would be thrown by default. This parameter is optional.

registerWithCustomFiltersboolean

A flag to indicate register resume with custom filters (true or false). Default would be false. This parameter is optional.

Example request

{
  "resumeId": "Resumepdfpdf",
  "binaryData": "JVBERi0xLjUNJeLjz9MNCjEwNyAwIG9EiwHQA.....",
  "extension": "pdf",
  "vendor": "testresume",
  "locale": "en_us",
  "instanceType": "SPECTRUM",
  "registerParsedBinaryData": false,
  "errorOnDuplicateorOverwrite": "Error"
}

Response

statusboolean required

Indicates whether the request was successful.

statusCodestring required

Status code of the response.

requestIdstring uuid required

Unique ID for tracking the request.

timeStampstring date-time required

Timestamp of the response.

Example response

{
  "status": true,
  "statusCode": "OK",
  "requestId": "f1353a5a-1ffa-4258-9b17-ab5efd20dff9",
  "timeStamp": "2023-08-02 11:29:06.670",
  "responseData": {
    "type": "resume",
    "id": "Resumepdfpdf",
    "vendor": "testresume",
    "locale": "en_us",
    "instanceType": "SPECTRUM",
    "maxDocumentCount": 1000,
    "registeredDocumentCount": 9
  }
}