Not logged in : Login

About: EntryPoint - user_checkAvailability     Goto   Sponge   NotDistinct   Permalink

An Entity of Type : schema:EntryPoint, within Data Space : www.openlinksw.com associated with source document(s)
QRcode icon
http://www.openlinksw.com/describe/?url=http%3A%2F%2Fwww.openlinksw.com%2FDAV%2FVAD%2Fwa%2FAPI_user.ttl%23action_user.checkAvailability

AttributesValues
description
  • 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://www.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>
 

Authentication

This function does not require any authentication.

name
  • EntryPoint - user_checkAvailability
url
type
isWebServiceOf
hasParameter
contentType
  • text/xml
httpMethod
  • GET
oplwebservices:endPointURL
schema:shortDescription
  • Check if a certain user account name is available.

is target of
Faceted Search & Find service v1.17_git63 as of Apr 23 2021


Alternative Linked Data Documents: iSPARQL | ODE     Content Formats:       RDF       ODATA       Microdata      About   
This material is Open Knowledge   W3C Semantic Web Technology [RDF Data] Valid XHTML + RDFa
OpenLink Virtuoso version 08.03.3322 as of Jun 3 2021, on Linux (x86_64-generic-linux-glibc25), Single-Server Edition (30 GB total memory)
Data on this page belongs to its respective rights holders.
Virtuoso Faceted Browser Copyright © 2009-2021 OpenLink Software