Not logged in : Login |
Before creating an account via user.register() this method can be used to check the availability of the user name and the email address.Although both parameters are marked as optional reliable results are only obtained if both parameters are given.
name
The user account name to check.
email
The corresponding email address.
An error code stating the success of the command execution as detailed in ODS Error Result Codes. If the account name and email address are available 1 is returned. Otherwise an error code and a human readable message indicating the problem are returned and the HTTP status code is set to 400.
Error Codes
invalid_username invalid_email username_in_use email_in_use
Example:
$ curl -i http://ods.openlinksw.com/ods/api/user.checkAvailability?name=demo2&email=demo2@hello.com
HTTP/1.1 200 OK
Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu
Connection: Keep-Alive
Date: Tue, 17 Apr 2012 15:44:46 GMT
Accept-Ranges: bytes
Content-Type: text/xml; charset="UTF-8"
Content-Length: 57
1
Attributes | Values |
---|---|
type | |
schema:url | |
schema:httpMethod |
|
schema:contentType |
|
http://www.openlin...es#isWebServiceOf | |
http://www.openlin...vices#endPointURL | |
schema:shortDescription |
|
http://www.openlin...ices#hasParameter | |
schema:name |
|
schema:description |
An error code stating the success of the command execution as detailed in ODS Error Result Codes. If the account name and email address are available $ curl -i http://ods.openlinksw.com/ods/api/user.checkAvailability?name=demo2&email=demo2@hello.com HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Tue, 17 Apr 2012 15:44:46 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 57 <result><code>1</code><message>Success</message></result> This function does not require any authentication. |
is schema:target of |