v1

latestOpenAPI 3.1.02026-07-242892032.8 MB

Endpoints

Structured BGT Resume

Provides a structured BGT-formatted parsed resume in XML or JSON with consistent node types (e.g., job always as a list).

post/parserservice/resume/structuredbgtxml

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

instanceTypestring required

statusboolean

statusCodestring

requestIdstring uuid

timeStampstring date-time

processedWithLocalestring

Example response

{
  "status": true,
  "statusCode": "OK",
  "requestId": "06de7384-f2f9-4b42-9444-f13106169b28",
  "timeStamp": "2023-08-02T01:40:38.179Z",
  "responseData": {
    "ResDoc": {
      "resume": [
        {
          "contact": [
            {
              "name": [
                {
                  "givenname": [
                    "SCOTT"
                  ],
                  "surname": [
                    "GRITTON"
                  ]
                }
              ],
              "email": [
                {
                  "value": "scott09@ix.netcom.com"
                },
                {
                  "value": "scott09@ix.netcom.com"
                }
              ],
              "address": [
                {
                  "street": [
                    "515 Chestnut Street"
                  ],
                  "city": [
                    {
                      "value": "Santa Cruz",
                      "@majorcity": "santa cruz"
                    }
                  ],
                  "state": [
                    {
                      "value": "CA",
                      "@abbrev": "CA"
                    }
                  ],
                  "postalcode": [
                    {
                      "value": "95060",
                      "@inferred-city": "Scotts Valley",
                      "@inferred-country": "USA",
                      "@inferred-county": "Santa Cruz"
                    }
                  ],
                  "#text": [
                    "\nSoftware Quality Assurance Engineer",
                    ", "
                  ],
                  "@inferred-city": "Santa Cruz",
                  "@inferred-country": "USA",
                  "@inferred-county": "Santa Cruz"
                }
              ],
              "#text": [
                " <mailto:",
                ">"
              ]
            }
          ],
          "education": [
            {
              "school": [
                {
                  "institution": [
                    {
                      "#text": [
                        "University of Washington"
                      ]
                    }
                  ],
                  "gpa": [
                    {
                      "value": "8.5",
                      "@max": "10"
                    }
                  ],
                  "degree": [
                    {
                      "value": "Bachelor of Arts",
                      "@level": "16",
                      "@name": "Bachelor of Arts"
                    }
                  ],
                  "completiondate": [
                    {
                      "value": "Sep-1991",
                      "@days": "727078",
                      "@iso8601": "1991-09-01"
                    }
                  ],
                  "address": [
                    {
                      "city": [
                        {
                          "value": "Seattle",
                          "@majorcity": "seattle"
                        }
                      ],
                      "state": [
                        {
                          "value": "WA",
                          "@abbrev": "WA"
                        }
                      ],
                      "#text": [
                        ", "
                      ],
                      "@inferred-city": "Seattle",
                      "@inferred-country": "USA"
                    }
                  ],
                  "description": [
                    {
                      "#text": [
                        "Reason for leaving: QA relocated to Tel Aviv."
                      ]
                    },
                    {
                      "#text": [
                        "Negotiated purchase of SilkTest licenses and instituted a training program."
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "processedWithLocale": "en_us"
}