URI
<users_uri>/nickname/isregistered[.<format>]
Supported Methods
Parent Resource
Introduction
The isNickRegistered resource is used to verify whether a specified nickname has already been taken.
Supported Methods:
- GET: Check whether a nickname has already been taken.
- HEAD: Check whether the isNickRegistered resource exists, or whether the permission can access the isNickRegistered resource.
Supported output formats: RJSON, JSON, XML.
Resource hierarchy
HTTP Request Method
Perform an HTTP request on the following URI. The rjson output format is used as an example, where supermapiportal is the server name.
http://supermapiportal:8190/iportal/web/users/nickname/isregistered.rjson
GET Request
Verify whether a specified nickname has already been taken.
Request Parameters
When sending a request, you need to include the following parameters in the request body. Request parameters must be included in the URI.
| Name | Type | Description |
| nickname | String | The nickname to be verified. |
Response Structure
Returns a boolean value. true indicates that the nickname is already used by an iPortal user, and false indicates that the nickname is not yet in use.
Response Example
Perform a GET request on the isNickRegistered resource: http://localhost:8190/iportal/web/users/nickname/isregistered.htm?nickname=test to check whether "test" has already been taken as a nickname by an iPortal user. The returned rjson representation is as follows:
true
HEAD Request
Returns the same HTTP response headers as a GET request, but without a response entity. You can obtain the metadata information contained in the response message headers without transferring the entire response content. The metadata information includes media type, character encoding, compression encoding, entity content length, etc.
A HEAD request can be used to determine whether the isNickRegistered resource exists, or whether the client has permission to access the isNickRegistered resource. By performing a HEAD request on a URI with .<format> appended, you can also quickly determine whether the isNickRegistered resource supports the <format> representation.
See