v1

latestOpenAPI 3.1.02026-07-242892032.8 MB

Endpoints

BGXML RTF Resume

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

post/parserservice/resume/rtf

Request body

binaryDatastring required

Base64-encoded document data

extensionstring

The file extension of the document (e.g., 'pdf', 'docx', 'rtf')

localestring

Locale in which to process the document (e.g., 'en_us')

instanceTypestring required

Processing engine or product instance (e.g., 'SPECTRUM')

customParametersstring

Optional custom parameters for processing

Example request

{
  "binaryData": "e1xydGYxXGFuc2lcYW5zaW.....",
  "extension": "rtf",
  "locale": "en_us",
  "instanceType": "SPECTRUM",
  "customParameters": "",
  "fieldList": {
    "field": [
      "All"
    ]
  }
}

Response

statusboolean

Indicates whether the request was successful.

statusCodestring

Status code of the response.

requestIdstring

Unique ID for tracking the request.

timeStampstring date-time

Timestamp when the response was generated.

processedWithLocalestring

The locale used for processing the resume.

Example response

{
  "status": true,
  "statusCode": "OK",
  "requestId": "bf792440-7d0d-41f7-9c36-ed6a3e533dbc",
  "responseData": {
    "ResDoc": {
      "resume": [
        {
          "contact": [
            {
              "name": [
                {
                  "givenname": [
                    "Nicola"
                  ],
                  "surname": [
                    "Berry"
                  ]
                }
              ],
              "phone": [
                {
                  "value": "020 8858 5913"
                },
                {
                  "value": "07792495565",
                  "@area": "077"
                }
              ],
              "email": [
                {
                  "value": "nicolaberry76@hotmail.com"
                }
              ],
              "address": [
                {
                  "street": [
                    "26 Rathmore Road"
                  ],
                  "city": [
                    {
                      "value": "London",
                      "@majorcity": "london"
                    }
                  ]
                }
              ],
              "#text": [
                " SE7 7QW\n\n",
                "-"
              ]
            }
          ],
          "education": [
            {
              "school": [
                {
                  "daterange": [
                    {
                      "start": [
                        {
                          "value": "Sept 1996",
                          "@days": "728905",
                          "@iso8601": "1996-09-01"
                        }
                      ],
                      "end": [
                        {
                          "value": "June 1999",
                          "@days": "729908",
                          "@iso8601": "1999-06-01"
                        }
                      ],
                      "#text": [
                        " - "
                      ]
                    }
                  ],
                  "institution": [
                    {
                      "#text": [
                        "The University of Sheffield"
                      ]
                    }
                  ],
                  "major": [
                    {
                      "value": "Sociology",
                      "@cipcode": "45.1100",
                      "@code": "2102",
                      "@std-major": "Sociology"
                    }
                  ],
                  "gpa": [
                    {
                      "value": "2:2",
                      "@max": "4"
                    }
                  ],
                  "degree": [
                    {
                      "value": "BA (Hons)",
                      "@level": "16",
                      "@name": "Bachelor of Arts"
                    }
                  ],
                  "#text": [
                    ","
                  ],
                  "@id": "10"
                }
              ]
            }
          ]
        }
      ],
      "DataElementsRollup": [
        {
          "@version": "8.16.5.18 Optic v4.14.0.0"
        }
      ],
      "rtfdoc": [
        "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fswiss\\fcharset0 Arial;}..."
      ]
    }
  },
  "timeStamp": "2023-08-02 01:44:53.199",
  "processedWithLocale": "en_us"
}