Skip to main
Group
Free TrialCTA Arrow
Why Sovren?
Products
Group 15
Resume Parser
Parse resume and job orders with control, accuracy and speed.
Group 15
+AI Matching
Match with an engine that mimics your thinking.
PricingResourcesCompany

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
Group 6
SaaS     |
Getting Started
First Steps
Sovren SDK
Code Samples
Standard Transaction Cost
Endpoints
Authentication
Versioning
HTTP Status Codes
Resume Parser Overview
Document Last Modified Date
Batch Parsing Concurrency
How Does Resume Parsing Work
Documents That Can Cause Problems
Entry Level
Australia
Config String Builder
Parser Output Settings
Additional Settings
Searching
Sort Order
Matching
Scores
Filtering
Semantic Filter
Full-text Filter
Boolean Syntax
Special Operators
Semantic Expressions
Feature Comparison
UI Overview
Authentication
UI Customization
Hooks
Getting Started
Rate Limits
Skills
Supported Languages
About the Skills Taxonomy
Professions
Supported Taxonomies
Supported Languages
Ontology
Supported Languages
API Technical SpecsPoliciesFAQsDocumentsRelease Notes

Compare Professions

POST /v10/ontology/compareprofessions

Compare two professions based on the skills associated with each.

Notes

  • 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

ProfessionCodeIdsrequiredint[]
The two profession code IDs from the Sovren Professions Taxonomy to compare. This list must have 2 values.

Sample Request

{ ... 
[ ... 
0]}

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided
Info.Messagestring
This message further describes the code providing additional detail.
Info.TransactionIdstring
The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.
Info.EngineVersionstring
The version of the parsing/matching engine running under-the-hood.
Info.ApiVersionstring
The version of the API.
Info.TotalElapsedMillisecondsinteger
How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
Info.TransactionCostdecimal
How many credits the transaction costs.How many credits the transaction costs.
Info.CustomerDetailsobject
Information about the customer who made the API call.
Value.CustomerDetails.AccountIdstring
The AccountId for the account.
Value.CustomerDetails.Namestring
The customer name on the account.
Value.CustomerDetails.IPAddressstring
The client IP Address where the API call originated.
Value.CustomerDetails.Regionstring
The region for the account, also known as the 'Data Center'.
Value.CustomerDetails.CreditsRemainingdecimal
The number of credits remaining to be used by the account.
Value.CustomerDetails.CreditsUseddecimal
The number of credits used by the account.
Value.CustomerDetails.MaximumConcurrentRequestsinteger
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.
Value.CustomerDetails.ExpirationDatedate
The date that the current credits expire.
Valueobject
Contains response data for the transaction.
Value.SimilarityScorefloat
A value from [0 - 1] indicating the similarity between the two professions.
Value.CommonSkillsobject[]
A list of common skills for both professions.
Value.CommonSkills[i].Scorefloat
A value from [0 - 1] indicating how relative this skill is to both professions.
Value.CommonSkills[i].Idstring
The ID of the skill in the skills taxonomy.
Value.ExclusiveSkillsByProfessionobject[]
A list of exclusive skills per profession. This list will have at most 2 entries (one for each profession you provided).
Value.ExclusiveSkillsByProfession[i].ProfessionCodeIdstring
The code ID of the profession in the Sovren Professions Taxonomy.
Value.ExclusiveSkillsByProfession[i].SkillsFoundOnlyInThisProfessionobject[]
A list of skills that are relative to this profession, but not the other.
Value.ExclusiveSkillsByProfession[i].SkillsFoundOnlyInThisProfession[j].Scorefloat
A value from [0 - 1] indicating how relative this skill is to the parent profession.
Value.ExclusiveSkillsByProfession[i].SkillsFoundOnlyInThisProfession[j].Idstring
The ID of the skill in the skills taxonomy.

Sample Response

{ ... 
{ ... 
"Code" :  "string","Message" :  "string","TransactionId" :  "string","EngineVersion" :  "string","ApiVersion" :  "string","TotalElapsedMilliseconds" :  0,"TransactionCost" :  0,{ ... 
"AccountId" :  "string","Name" :  "string","IPAddress" :  "string","Region" :  "string","CreditsRemaining" :  0,"CreditsUsed" :  0,"ExpirationDate" :  "2021-12-31","MaximumConcurrentRequests" :  0}},{ ... 
"SimilarityScore" :  0,[ ... 
{
"Score" :  0,"Id" :  "string"}],[ ... 
{
"ProfessionCodeId" :  0,[ ... 
{
"Score" :  0,"Id" :  "string"}]}]}}
SOC II Type 2
Compliant
Why Sovren?
Company
Pricing
Account Login
Have questions? We can help.
© 2023 Textkernel US LLC. All rights reserved.
Privacy Policy | Terms of Service | GDPR