This HTML5 document contains 11 embedded RDF statements represented using HTML+Microdata notation.

The embedded RDF content will be recognized by any processor of HTML5 Microdata.

Subject Item

n2:checkAvailability

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n3:isWebServiceOf

n6:this_ODSUserModuleAPI

n3:endPointURL

n4:checkAvailability

schema:shortDescription

<p>Check if a certain user account name is available. </p>

n3:hasParameter

n7:_name n7:_email

schema:name

EntryPoint - user_checkAvailability

schema:description

<p>Before creating an account via <ref kindref="member" refid="group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825">user.register()</ref> this method can be used to check the availability of the user name and the email address.</p><p>Although both parameters are marked as optional reliable results are only obtained if both parameters are given.</p><p><parameterlist kind="param"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The user account name to check. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> <p>The corresponding email address.</p></parameterdescription> </li> </ul> <simplesect kind="return"><p>An error code stating the success of the command execution as detailed in <ref kindref="member" refid="ods_response_format_1ods_response_format_result_code">ODS Error Result Codes</ref>. If the account name and email address are available <computeroutput>1</computeroutput> 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.</p></simplesect> <simplesect kind="par"><title>Error Codes</title><p><itemizedlist> <listitem><p><computeroutput>invalid_username</computeroutput> </p></listitem><listitem><p><computeroutput>invalid_email</computeroutput> </p></listitem><listitem><p><computeroutput>username_in_use</computeroutput> </p></listitem><listitem><p><computeroutput>email_in_use</computeroutput> </p></listitem></itemizedlist> </p></simplesect> <bold>Example:</bold> <pre> $ curl -i http://www.iodbc.org/ods/api/user.checkAvailability?name=demo2&amp;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 &lt;result&gt;&lt;code&gt;1&lt;/code&gt;&lt;message&gt;Success&lt;/message&gt;&lt;/result&gt; </pre></p><p><simplesect kind="par"><title>Authentication</title><p>This function does not require any authentication. </p></simplesect> </p>

schema:url

n4:checkAvailability