Validate alias or email

Description

Validates alias and/or email to be use later in the create account endpoint.

HTTP Method

GET

Path

/account/validate

Authentication

Does not require user authentication.

Parameters

Table 3.  Parameters for " Validate alias or email "

NameTypeValue TypeDescription
aliasQUERYStringThe user alias to validate
emailQUERYStringEmail to validate.

Error Codes

10000 ( Account )

An unhandled exception has occured.

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="accountValidation">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="alias" type="xs:string" minOccurs="0"/>
        <xs:element name="email" type="xs:string" minOccurs="0"/>
        <xs:element name="accountId" type="xs:long" minOccurs="0"/>
        <xs:element name="firstName" type="xs:string" minOccurs="0"/>
        <xs:element name="lastName" type="xs:string" minOccurs="0"/>
        <xs:element name="createdDate" type="xs:dateTime" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name="ValidationEnum">
    <xs:restriction base="xs:string">
      <xs:enumeration value="OK"/>
      <xs:enumeration value="ERR_ALIAS_TAKEN"/>
      <xs:enumeration value="ERR_ALIAS_SHORT"/>
      <xs:enumeration value="ERR_ALIAS_FORBIDDEN"/>
      <xs:enumeration value="ERR_ALIAS_ONLYNUMBERS"/>
      <xs:enumeration value="ERR_EMAIL_TAKEN"/>
      <xs:enumeration value="ERR_EMAIL_INVALID"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<accountValidation xmlns="http://xsd.poken.com">
		<alias>OK</alias>
		<email>ERR_EMAIL_TAKEN</email>
</accountValidation>