Skip to main

API Technical Specs

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

Normalize Skills

POST /v10/skills/Normalize

Normalize the given skills to the most closely-related skills in the taxonomy.

Notes

Scope of use

The purpose of this endpoint is to enrich data records using our Taxonomy. 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 Taxonomy.

Request Body

Skillsrequiredstring
The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).
Languagerequiredstring
The language of the given skills. Must be one of the supported ISO codes.
OutputLanguagestring
The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes.

Sample Request

{ ... 
[ ... 
""
],
"Language" :  "","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.Skillsobject[]
An array of skills objects.
Value.Skills.RawTextstring
The raw text that matched to a skill description in the provided language.
Value.Skills.Typestring
Type of skill. Possible values are Professional, IT, Language, or Soft.
Value.Skills.Idstring
The ID of the skill in the skills taxonomy.
Value.Skills.Confidencefloat
A value from [0 - 1] indicating the overall confidence that the input skill was normalized to the correct skill.
Value.Skills.Descriptionstring
The description of the normalized skill from the taxonomy in the desired language.
Value.Skills.IsoCodestring
The language ISO 639-1 code. This will only appear for language skills (Type = Language).

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
}
},
{ ... 
[ ... 
{
"RawText" :  "string","Type" :  "string","Id" :  "string","Confidence" :  1,"Description" :  "string","IsoCode" :  "string"
}
]
}
}