Skip to main

API Technical Specs

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

Normalize Professions

POST /v10/professions/Normalize

Normalize the given job titles to the most closely-related professions 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

JobTitlesrequiredstring[]
The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).
Languagerequiredstring
The language of the input job titles. Must be one of the supported ISO codes.
OutputLanguagestring
The language to use for descriptions of the returned normalized professions. 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.Professionsobject[]
A list of returned professions.
Value.Professions.Confidencefloat
A value from [0 - 1] indicating how well the input job title matched to the normalized profession.
Value.Professions.CodeIdint
The unique code ID of the profession in the Sovren Professions Taxonomy.
Value.Professions.Descriptionstring
The description of the profession in the desired language.
Value.Professions.Classobject
The class which this profession belongs to.
Value.Professions.Class.CodeIdint
The code ID of the parent class in the Sovren Professions Taxonomy.
Value.Professions.Class.Descriptionstring
The description of the class in the desired language.
Value.Professions.Groupobject
The group which this profession belongs to.
Value.Professions.Group.CodeIdint
The code ID of the parent group in the Sovren Professions Taxonomy.
Value.Professions.Group.Descriptionstring
The description of the group in the desired language.
Value.Professions.Iscoobject
The ISCO-2008 details of this profession.
Value.Professions.Isco.CodeIdstring
The ISCO code/ID.
Value.Professions.Isco.Descriptionstring
The ISCO description.
Value.Professions.Onet2019object
The O*NET 2019 details of this profession.
Value.Professions.Onet2019.CodeIdstring
The O*NET code/ID.
Value.Professions.Onet2019.Descriptionstring
The O*NET description.
Value.Professions.Onetobject
The O*NET 2010 (deprecated) details of this profession.
Value.Professions.Onet.CodeIdstring
The O*NET code/ID.
Value.Professions.Onet.Descriptionstring
The O*NET description.
Value.Professions.Kldb2020object
The KLDB-2020 details of this profession.
Value.Professions.Kldb2020.CodeIdstring
The KLDB code/ID.
Value.Professions.Kldb2020.Descriptionstring
The KLDB description.
Value.Professions.UkSoc2010object
The UK-SOC-2010 details of this profession.
Value.Professions.UkSoc2010.CodeIdstring
The UK-SOC-2010 code/ID.
Value.Professions.UkSoc2010.Descriptionstring
The UK-SOC-2010 description.
Value.Professions.UwvBocobject
The UWV-BOC details of this profession.
Value.Professions.UwvBoc.CodeIdstring
The UWV-BOC code/ID.
Value.Professions.UwvBoc.Descriptionstring
The UWV-BOC description (Dutch only).

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