Generate the Matching UI Details View

This feature has been deprecated.

HTTP Verb	Path
POST	/ui/v9/details

Generate an HTML user interface for reviewing a single result from Search & Match or Bimetric Scoring that can be consumed in your client application.

Request Body

UIOptions 🔗︎ object

UIOptions

Object representing various options for generating the UI.

---

UIOptions properties

Username 🔗︎ string

Username

The username of the current user. *If you do not provide this, the user will be required to login when they view the page.

Style 🔗︎ object

Style

Specifies custom style options for this session.

---

Style properties

PrimaryColor 🔗︎ string

PrimaryColor

An HTML color used to generate several related colors for various UI elements. For example: #077799.

HeaderColor 🔗︎ string

HeaderColor

An HTML color used for the background of the section/accordian headers. For example: #077799.

SquareCorners 🔗︎ boolean

SquareCorners

true to use square corners for UI elements. Default is false for rounded corners.

FontFamily 🔗︎ string

FontFamily

A CSS font-family to use for all UI elements. For example: Arial.

FontUrl 🔗︎ string

FontUrl

If you'd like to use a non-standard font, specify the URL where that font can be downloaded here. For example: https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap. Note that you also need to define the FontFamily if you use this option.

MatchDetails 🔗︎ object required

MatchDetails

The information about the match result for this session. These properties should be filled from an Search & Match or Bimetric Score API response.

---

MatchDetails properties

Result 🔗︎ object required

Result

A single entry from one of the following result lists:

• 'Match by Document' Results (Search & Match)
• 'Match by Document Id' Results (Search & Match)
• 'Score a Set of Documents' Results (Bimetric Score)

AppliedCategoryWeights 🔗︎ object required

AppliedCategoryWeights

The AppliedCategoryWeights list from the API call that generated the above Result. One of:

• Match by Document (Search & Match)
• Match by Document Id (Search & Match)
• Score a Set of Documents (Bimetric Score)

SourceDocumentType 🔗︎ string required

SourceDocumentType

The type of document the result was scored against. Either Resume or Job.

ParsedDocument 🔗︎ string

ParsedDocument

The Textkernel parsed document string. This is only required if you are viewing details for a Bimetric Score result. For Search & Match results, this value will be set automatically from the indexed document (using the DocumentId/IndexId pair in the match result). If set, should be one of:

• Parsed Resume
• Parsed Job

HtmlDocument 🔗︎ string

HtmlDocument

The HTML document to be displayed in the details view. If you do not provide this, only the plain text for the document is shown. The only allowed HTML string is the one generated by Textkernel in a Parse API when you set OutputHtml to true. One of:

• Parsed Resume HTML
• Parsed Job HTML

Sample JSON

{
  "UIOptions": {
    "Username": "",
    "Style": {
      "PrimaryColor": "",
      "HeaderColor": "",
      "SquareCorners": false,
      "FontFamily": "",
      "FontUrl": ""
    }
  },
  "MatchDetails": {
    "Result": {
      "SovScore": 0.0,
      "*": "..."
    },
    "AppliedCategoryWeights": {
      "Skills": 0.0,
      "*": "..."
    },
    "SourceDocumentType": "",
    "ParsedDocument": "",
    "HtmlDocument": ""
  }
}

Response Body

url 🔗︎ string

url

The endpoint to hit to get the generated Matching UI. The first request to this endpoint will automatically authenticate the user. Subsequent requests (who are not already authenticated) will require a login. This url will be valid for at least 24 hours.

expires_in 🔗︎ integer

expires_in

The number of seconds until the url auto-authentication expires.

Sample JSON

{
  "url": "",
  "expires_in": 0
}