Scope of use
The purpose of this endpoint is to look up information in our Taxonomy. You must cache or store the response to limit the number of requests. When discontinuing use of our Services, you are required to delete all copies of the Taxonomy.
API Technical Specs
Learn how to configure and leverage our services to achieve your toughest recruiting needs.
Lookup Skills
POST /v10/skills/lookup
Get the details associated with given skills in the taxonomy.
Notes
- This is an add-on feature. Reach out to sales@sovren.com for more information.
Request Body
SkillIdsrequiredstring[]
The IDs of the skills to get details about. A maximum of 100 IDs can be requested.
OutputLanguagestring
The language to use for the output skill descriptions. If not provided, defaults to
en. If specified, must be one of the supported ISO codes.Sample Request
{ ...
[ ...
""],"OutputLanguage" : ""}
[ ...
""],"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
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.Skills.Idstring
The ID of the skill in the skills taxonomy.
Value.Skills.Descriptionstring
The skill description in the requested language.
Value.Skills.Typestring
Type of skill. Possible values are
Professional, IT, Language, or Soft.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}},{ ...
[ ...
{
"Id" : "string","Description" : "string","Type" : "string"}]}}
{ ...
"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}},{ ...
[ ...
{
"Id" : "string","Description" : "string","Type" : "string"}]}}