verify_registration_email

 

Description REST SOAP XML

---

Description

 

This method is used to verify whether a user email is available, or already in use.

 

Input parameters:

 

Name	Type	Description
api_key	string	The API key obtained when registering a project with OpenBox.
login	string	The login username of the user for which you would like to verify registration.

 

Output parameters:

 

Name	Type	Description
status	string	Upon a successful registration, the status parameter will be 'email_ok'. If registration was not successful, the status field can be: 'email_invalid' - The login provided is not a valid email address. 'email_already_registered' - The login provided is already registered by another user. 'application_restricted'- You provided an invalid api_key, or the api_key is restricted from calling this function.

 

 

REST

 

Request

 

https://www.box.net/api/1.0/rest?action=verify_registration_email&api_key=rrc1d3ntb53tt6b2vhail6rdtrsxov3v&login=email@example.com

  

Response

 

<?xml version='1.0' encoding='UTF-8' ?>

<response>

<status>email_ok</status>

</response>

 

SOAP

 

Request

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope

xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:tns="urn:boxnet" xmlns:types="urn:boxnet/encodedTypes"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

>

<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<tns:verify_registration_email>

<api_key xsi:type="xsd:string">rrc1d3ntb53tt6b2vhail6rdtrsxov3v</api_key>

<login xsi:type="xsd:string">tapi@email.com</login>

</tns:verify_registration_email>

</soap:Body>

</soap:Envelope>

 

 

Response

 

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:ns4="urn:boxnet"

SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"

>

<SOAP-ENV:Body>

<ns4:verify_registration_emailResponse>

<status xsi:type="xsd:string">email_ok</status>

</ns4:verify_registration_emailResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

XML

 

Request

 

<?xml version='1.0' encoding='UTF-8' ?>

<request>

<action>verify_registration_email</action>

<api_key>rrc1d3ntb53tt6b2vhail6rdtrsxov3v</api_key>

<login>email@example.com</login>

</request>

 

 

Response

 

<?xml version='1.0' encoding='UTF-8' ?>

<response>

<status>email_ok</status>

</response>

 

---

 

Need additional assistance? Please feel free to Contact us