Checks the availability of a username.
| Client Servlet |
Server Servlet |
HTTP Methods Supported |
Requires Authentication |
|
CRConsAPI
|
SRConsAPI
|
POST
|
Server.
|
Client API Syntax
https://secure2.convio.net/organization/site/CRConsAPI?method=isUserNameAvailable
&api_key=value
&v=value
[
¢er_id=value
]
[
&error_redirect=value
]
[
&redirect=value
]
[
&response_format=xml
| json
]
[
&sign_redirects=value
]
[
&source=value
]
[
&sub_source=value
]
[
&success_redirect=value
]
[
&suppress_response_codes=value
]
&user_name=value
Server API Syntax
https://secure2.convio.net/organization/site/SRConsAPI?method=isUserNameAvailable
&
api_key
=value
&
login_name
=value
&
login_password
=value
&
v
=value
[
&
center_id
=value
]
[
&
response_format
=xml
|json
]
[
&
source
=value
]
[
&
sub_source
=value
]
[
&
suppress_response_codes
=value
]
&
user_name
=value
Usage Notes
The isUserNameAvailable method checks the availability of a username.
A username is available if it has not already been taken by another user.
The user_name parameter must be a syntactically valid in order for the method to
return a valid response.
A valid username can only be composed of letters, digits, '-', '_', '@', '.', '%', and ':'.
By default, a username must be between 5 and 60 characters long.
However, these values may be adjusted using the USER_MIN_LOGIN_LEN and USER_MAX_LOGIN_LEN SDPs.
If the username is not valid, an error response containing one of the following error codes will be issued:
- Error Code 9 - Request did not contain a required parameter. Missing parameter was: user_name
- Error Code 23 - Invalid length of User Name. User name must be between [minimum length] and [maximum length]
- Error Code 35 - Invalid characters in User Name (valid characters are letters, digits, '-', '_', '@', '.', '%', and ':')
In addition, this API will not check the availability of the
user_name parameter if it is an email address.
Instead, the following error code will be issued:
- Error Code 36 - Usernames that are email addresses are not checked.
Client API Parameters
- Common Client Parameters
-
See topic Common Parameters.
- user_name
-
Required. The username that uniquely identifies a constituent
Type xsd:string.
Server API Parameters
- Common Server Parameters
-
See topic Common Parameters.
- user_name
-
Required. The username that uniquely identifies a constituent
Type xsd:string.
Response
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<isUserNameAvailableResponse xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<available xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd">false</available>
</isUserNameAvailableResponse>
JSON response
{"isUserNameAvailableResponse":{"available":{"content":"false"}}}