Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Suggest Skills From Professions

POST /v10/ontology/suggest-skills-from-professions

Returns skills related to a given profession(s). The service returns salient skills that are strongly associated with the profession, but not too generic either.

Notes

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 profession code IDs from the Professions Taxonomy for which the service should return related skills. The list can contain up to 10 profession codes.
Limitint
The maximum amount of suggested skills returned. If not specified this parameter defaults to 10. This value cannot exceed 10.
OutputLanguagestring
The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Sample Request

{ ... 
[ ... 
0
],
"Limit" :  10,"OutputLanguage" :  ""
}

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.SuggestedSkillsobject[]
A list of skills related to the given professions.
Value.SuggestedSkills[i].Scorefloat
A value from [0 - 1] indicating how relative this skill is to all of the given professions.
Value.SuggestedSkills[i].Idstring
The ID of the skill in the skills taxonomy.
Value.SuggestedSkills[i].Descriptionstring
The description of the normalized skill concept in the Skills Taxonomy. Will only be returned if OutputLanguage is specified.

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
}
},
{ ... 
[ ... 
{
"Score" :  0,"Id" :  "string","Description" :  "string"
}
]
}
}