Returns normalized professions that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.
To minimize the number of requests, it is recommended to set a delay between each keystroke before sending a new request.
Scope of use
The purpose of this endpoint is to provide real-time autocompletions for user input based on our Taxonomy. 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
Prefixrequiredstring
The job title prefix to be completed. Must contain at least 1 character.
Languagesstring[]
The language(s) used to search for matching professions (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
Limitint
The maximum number of returned professions. The default is 10 and the maximum is 100.
OutputLanguagestring
The language to ouput the found professions in (default is en). Must be one of the supported ISO codes.
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.
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 professions that match the given Prefix.