CleanName
Cleanse a given name and identify gender
To connect to this service you'll need to use one of these endpoints:
Description
Tidy the supplied name, standardising casing and punctuation. The gender is derived from the name where possible, and standard formal and informal salutations are generated.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
name | name The name to clean, supplied in four separate fields:
If you have a name in one field, use the |
Advanced Options
The following options can be specified as part of the option
parameter. Each option is specified
as a key/value pair. The list of available names is shown below, along with a description of the allowable values
for that name.
Common Options | |
---|---|
Name | Description |
ApplicationName | ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard |
Results
This method returns an object containing the following fields:
Status |
Status Success field is true , the other results described below can be used to get the results of the method.
If Success is false , some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
|
---|---|
Name | Name A tidied version of the supplied |
Gender | Gender The gender that has been identified from the name. This can be one of the following values:
|
FormalSalutation | FormalSalutation The mode of address that should be used for this person in a formal situation. |
InformalSalutation | InformalSalutation The mode of address that should be used for this person in an informal situation. |