IsUnusableName
Checks if a name is usable or whether it is Salacious, Random or Blank.
To connect to this service you'll need to use one of these endpoints:
Description
Checks to see if a name is usable or if it is Salacious, Random or Blank. This method returns a string indicating the status of the supplied name.
Parameters
The following parameters can be supplied to this method
| username |
username apikey-, e.g.
apikey-ABCD-1234-EFGH-5678
|
|---|---|
| password |
password |
| name | name Contains the name to check |
| options | options |
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 |
| Service-Specific Options | |
| Name | Description |
| UseRepeatedNameStatus | UseRepeatedNameStatus Indicates whether the |
| AllowInitials | AllowInitials Indicates whether names should be allowed that contain only initials, rather than a full first name. This will allow names that might otherwise be flagged as |
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
|
|---|---|
| Result | Result One of the following values indicating the detected status of the supplied
|