Compare Professions🔗︎

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

Compare two professions based on the skills associated with each.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
The skill set used to determine the "common skills" is a larger set than /suggestskills returns. This is done to ensure less salient skills are listed as common ones if they are related to both professions. That means that the "common skills" don't necessarily align with the suggested skills.

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🔗︎

ProfessionACodeId 🔗︎ int required

ProfessionACodeId🔗︎

A profession code ID from the Professions Taxonomy to compare.

ProfessionBCodeId 🔗︎ int required

ProfessionBCodeId🔗︎

A profession code ID from the Professions Taxonomy to compare.

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

{
  "ProfessionACodeId": 0,
  "ProfessionBCodeId": 0,
  "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

SimilarityScore 🔗︎ float

SimilarityScore🔗︎

A value from [0 - 1] indicating the similarity between the two professions.

CommonSkills 🔗︎ object[]

CommonSkills🔗︎

A list of common skills for both professions.

CommonSkills properties

Score 🔗︎ float

Score🔗︎

A value from [0 - 1] indicating how relative this skill is to both professions.

Id 🔗︎ string

Id🔗︎

The ID of the skill in the skills taxonomy.

Description 🔗︎ string

Description🔗︎

The description of the skill in the Skills Taxonomy. Will only be returned if OutputLanguage is specified.

ExclusiveSkillsByProfession 🔗︎ object[]

ExclusiveSkillsByProfession🔗︎

A list of exclusive skills per profession. This list will have at most 2 entries (one for each profession you provided).

ExclusiveSkillsByProfession properties

ProfessionCodeId 🔗︎ string

ProfessionCodeId🔗︎

The code ID of the profession in the Professions Taxonomy.

SkillsFoundOnlyInThisProfession 🔗︎ object[]

SkillsFoundOnlyInThisProfession🔗︎

A list of skills that are relative to this profession, but not the other.

SkillsFoundOnlyInThisProfession properties