API Reference

Users.verifyUserEmail

Verifies if a username or email already exists in a specific vhost.

When they don't exist this method will return 1, if the user already exists it will return -1, if the email already exists it will return -2.


Syntax

int users.verifyUserEmail ( int vhost, string username, string email )

Arguments

NameTypeRequiredDefault valueDescription
vhostintRequirednoneThe id of the vhost.
usernamestringRequirednoneThe username of the user you are attempting to verify.
emailstringRequirednoneAn email address of the user you are attempting to verify.

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/users/verifyUserEmail?vhost=[VHOST_ID]&id=[USER_ID]&username=[USERNAME]&email=[USER_EMAIL]&APIKEY=[APIKEY]
<?xml version="1.0" encoding="UTF-8"?>
<result>USER_STATUS</result>
Sample JSON Response
{
    "status": true,
    "result": USER_STATUS
}

Code examples

0 comments

Be the first to comment on verifyUserEmail.

Add a Comment

  • captcha