Suggest Professions🔗︎

HTTP Verb	Path
POST	/v10/ontology/suggest-professions
POST	/v10/ontology/v2/suggest-professions

Suggest professions based on a given set of skills.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )

Scope of use🔗︎

The purpose of this endpoint is to provide insights or enrich data records using our Ontology. You may store the parts of the response that are relevant to individual data records - such as candidate or employee profiles - within these records. It is not permitted to cache, store, or utilize responses from this endpoint for the purpose of limiting request volume, or to create replicas or derivatives of the Service and the Ontology.

Request Body🔗︎

Skills 🔗︎ object[] required

Skills🔗︎

The skills used to return the most relevant professions. The list can contain up to 50 skills.

Skills properties

Id 🔗︎ string required

Id🔗︎

The ID of the skill in the skills taxonomy.

Score 🔗︎ float

Score🔗︎

The weight that will be applied to the skill. Must be in the range [0 - 1]. These values are relative, so SkillA.Score = 0.2; SkillB.Score = 0.4; is equivalent to SkillA.Score = 0.5; SkillB.Score = 1.0;.

ReturnMissingSkills 🔗︎ boolean

ReturnMissingSkills🔗︎

Flag to enable returning a list of missing skills per suggested profession. These skills are missing from the skill set and need to be acquired for the suggested profession.

Limit 🔗︎ int

Limit🔗︎

The maximum amount of professions returned. If not specified this parameter defaults to 10.

OutputLanguage 🔗︎ string

OutputLanguage🔗︎

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Sample JSON

{
  "Skills": [
    {
      "Id": "",
      "Score": 0.0
    }
  ],
  "ReturnMissingSkills": true,
  "Limit": 10,
  "OutputLanguage": ""
}

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Code🔗︎

Code	Description
`Success`	Successful transaction
`MissingParameter`	A required parameter wasn't provided
`InvalidParameter`	A parameter was incorrectly specified
`AuthenticationError`	An error occurred with the credentials provided

Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

TransactionId 🔗︎ string

TransactionId🔗︎

The (GUID) id for a specific API transaction. Use this when contacting support@textkernel.com about issues.

EngineVersion 🔗︎ string

EngineVersion🔗︎

The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

TotalElapsedMilliseconds 🔗︎ integer

TotalElapsedMilliseconds🔗︎

How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

TransactionCost 🔗︎ decimal

TransactionCost🔗︎

How many credits the transaction costs.How many credits the transaction costs.

CustomerDetails 🔗︎ object

CustomerDetails🔗︎

Information about the customer who made the API call.

CustomerDetails properties

AccountId 🔗︎ string

AccountId🔗︎

The AccountId for the account.

Name 🔗︎ string

Name🔗︎

The customer name on the account.

IPAddress 🔗︎ string

IPAddress🔗︎

The client IP Address where the API call originated.

Region 🔗︎ string

Region🔗︎

The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.

ExpirationDate 🔗︎ date

ExpirationDate🔗︎

The date that the current credits expire.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

SuggestedProfessions 🔗︎ object[]

SuggestedProfessions🔗︎

A list of professions most relevant to the given skills.

SuggestedProfessions properties

Score 🔗︎ float

Score🔗︎

A value from [0 - 1] indicating how relative the given skills are to this profession.

CodeId 🔗︎ int

CodeId🔗︎

The code ID of the profession in the Professions Taxonomy.

Description 🔗︎ string

Description🔗︎

The description of the profession in the Professions Taxonomy.

MissingSkills 🔗︎ object[]

MissingSkills🔗︎

The list of skills relevant to this profession but missing from the given list of skills in the request. This will only be returned if the 'ReturnMissingSkills' flag is set to true.

MissingSkills properties

Score 🔗︎ float

Score🔗︎

A value from [0 - 1] indicating how relevant this skill is to the parent profession.

Id 🔗︎ string

Id🔗︎

The ID of the skill in the skills taxonomy.

Warnings 🔗︎ object

Warnings🔗︎

Any warnings when attempting to suggest professions from the given skills.

Warnings properties

SkillsWithoutProfessionRelation 🔗︎ string[]

SkillsWithoutProfessionRelation🔗︎

A list of warnings about provided skills that do not have a profession relation.

InvalidSkills 🔗︎ string[]

InvalidSkills🔗︎

A list of warnings about provided skills that are invalid.

Sample JSON

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "TransactionCost": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": {
    "SuggestedProfessions": [
      {
        "Score": 0.0,
        "CodeId": 0,
        "Description": "string",
        "MissingSkills": [
          {
            "Score": 0.0,
            "Id": "string"
          }
        ]
      }
    ]
  }
}