Create List - Rest API v10 - API Technical Specs

API Technical Specs Policies FAQs Documents Release Notes

Create a Normalizations List

POST /v10/normalizations

Upload a custom data list to be optionally used during parsing.

This feature is not recommended and only available in special cases. Reach out to support@sovren.com for more information.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
For custom normalization implementation, we recommend using the Sovren Normalization Editor utility, which provides a rich GUI for normalization management. You can download the utility from My Sovren Portal.

Request Body

Namerequiredstring

A name for the data being uploaded. Names must consist of only letters, digits, and ASCII hyphens. If the combination of Name and Culture already exists, it is overwritten.

Culturerequiredstring

The culture or language of the data, formatted as an ISO 639-1 two letter language code. Click here for a list of supported languages currently supported by the parser.

ContentBytesrequiredstring

The byte content of the normalization lists in .zip file format. Archive the normalization lists into a .zip file and pass them within this field as a Base64-encoded string of bytes.

Sample Request

{ ...
"Name" : "","Culture" : "","ContentBytes" : ""}

Response Body

Infoobject

Information explaining the outcome of the transaction.

›Show Child Properties

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.

›Show Child Properties

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.

›Show Child Properties

Value.Keystring

The unique Key for the data list.

Value.Namestring

The Name of the data list.

Sample Response

{ ...
+-"Info" :  { ...
"Code" :  "string","Message" :  "string","TransactionId" :  "string","EngineVersion" :  "string","ApiVersion" :  "string","TotalElapsedMilliseconds" :  0,"TransactionCost" :  0,+-"CustomerDetails" :  { ...
"AccountId" :  "string","Name" :  "string","IPAddress" :  "string","Region" :  "string","CreditsRemaining" :  0,"CreditsUsed" :  0,"ExpirationDate" :  "2021-12-31","MaximumConcurrentRequests" :  0}},+-"Value" :  { ...
"Key" :  "","Name" :  ""}}