v1

latestOpenAPI 3.1.02026-07-242892032.8 MB

Endpoints

BGXML RTF Posting

Returns a BGXML with RTF-formatted posting document from the job parser.

post/parserservice/job/rtf

Request body

binaryDatastring required

The binary resume data.

instanceTypestring required

Instance type to be used to parse. For example, use "XRAY" to process with LENS xray.

extensionstring

The document extension (e.g. txt, doc, docx, rtf). Default is "txt".

localestring

Locale to be used to parse (e.g. en_us).

Example request

{
  "binaryData": "JVBERi0xLjUNJeLjz9MNCjEw....",
  "extension": "pdf",
  "locale": "en_us",
  "instanceType": "TM"
}

Response

statusboolean

Indicates whether the request was successful.

statusCodestring

Status code of the response.

requestIdstring uuid

Unique identifier for the request.

timeStampstring date-time

processedWithLocalestring

Example response

{
  "status": true,
  "statusCode": "OK",
  "requestId": "dfa64e19-6517-4acf-a2b4-2e73975f8e85",
  "responseData": {
    "JobDoc": {
      "posting": {
        "qualifications": [],
        "duties": [],
        "background": [],
        "contact": [],
        "@canon-cardinality": "3",
        "@canon-content-cardinality": "3",
        "@canonversion": "2",
        "@cardinality": "multiple",
        "@content-cardinality": "multiple",
        "@dateversion": "2",
        "@green-bls": "false",
        "@green-industry": "false",
        "@inferred-naics": "484",
        "@iso8601": "2023-08-02",
        "@minyrsexp": "21",
        "@present": "738736"
      },
      "skillrollup": [
        {
          "@version": "4.00.1"
        }
      ],
      "DataElementsRollup": {
        "CanonJobTitle": {
          "value": "Truck Driver"
        },
        "CleanJobTitle": "Truck Driver",
        "StandardTitle": "Truck Driver",
        "ConsolidatedInferredNAICS": "484",
        "InternshipFlag": "false",
        "HealthCareBenefits": "false",
        "CanonJobType": {
          "wfh": [
            {
              "value": "0"
            }
          ]
        },
        "RootTitle": "driver",
        "Blacklist": "1",
        "ConsolidatedONET": {
          "value": "53-3032.00"
        },
        "ConsolidatedONETRank": "1",
        "BGTOcc": {
          "value": "53-3032.00"
        },
        "SubOcc": {
          "value": "Tractor-Trailer Truck Driver (General)",
          "@id": "1971"
        },
        "CanonCertification": {
          "certification": [
            {
              "@name": "CDL Class A",
              "@type": "Certification"
            },
            {
              "@name": "Driver's License",
              "@type": "License"
            }
          ]
        },
        "@version": "8.16.6.27 Optic v4.17.0.0"
      },
      "rtfdoc": [
        "{\\rtf1\\ansi\\ansicpg1252\\uc0\\...}"
      ]
    }
  },
  "timeStamp": "2023-08-02 01:51:09.138",
  "processedWithLocale": "en_us"
}