IsUnusableName - SalaciousName • Data8 Web Services API Documentation

IsUnusableName

Checks if a name is usable or whether it is Salacious, Random or Blank.

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.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/SalaciousName/IsUnusableName.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/SalaciousName/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/salaciousname.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
name	name Contains the name to check.
options	options An array of options that control further details of how this method operates. See the `Advanced Options` section below, for more information.

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.

Name	Description
Common Options
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
UseRepeatedNameStatus	UseRepeatedNameStatus Indicates whether the `RepeatedName` status code should be returned. When this option is not specified, for backwards compatibility the `SalaciousName` status code is returned instead.
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 `RandomName`.

Results

This method returns an object containing the following fields:

Name Description

Status

Name	Description
Status	Status Indicates whether the method call was successful, or if some error occurred. If the `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 `name`: `""` (empty string) - the name is not salacious `"IncompleteName"` - not enough name information has been supplied `"RandomName"` - the name appears to have been entered by hitting random keys `"SalaciousName"` - the name is flagged against our blacklist of known salacious words

Indicates whether the method call was successful, or if some error occurred. If the 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

One of the following values indicating the detected status of the supplied name:

"" (empty string) - the name is not salacious
"IncompleteName" - not enough name information has been supplied
"RandomName" - the name appears to have been entered by hitting random keys
"SalaciousName" - the name is flagged against our blacklist of known salacious words

Credit Usage

Each request to this method consumes 1 SalaciousName credit.

Sample Code

Request Format

{
  "name": {
    "Title": "Mr",
    "Forename": "John",
    "MiddleName": "",
    "Surname": "Smith"
  },
  "options": {
    "UseRepeatedNameStatus": null,
    "AllowInitials": null
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Result": null
}

Depending on your chosen authentication method you will need to modify this request slightly:

API Key

Post the request to
https://webservices.data-8.co.uk/SalaciousName/IsUnusableName.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
Name
name	Title Forename MiddleName Surname
Common Options
ApplicationName	ApplicationName
Service-Specific Options
UseRepeatedNameStatus	UseRepeatedNameStatus
AllowInitials	AllowInitials
Credits Remaining Today: 5 Try It Now!