API - Add Account (XML)


Enables an account to be created from remote website or application. Please read the information below carefully.

XML Wrapper Structure

Your xml wrapper structure should look like the following:

<?xml version="1.0" encoding="utf-8"?>
  <api>YOUR KEY</api>
    (account tags as shown below)

Op type is "account" and must NOT be changed. API key must be same as key in settings.

Account Data

Multiple accounts are possible with each transmission. Each account should be wrapper in <account></account> tags. Inside each tag set is the data related to the account. Structure as follows:

  <name>Name or alias</name>
  <email>Email address</email>
  <password>Password in raw format</password>
  <timezone>Supported timezone</timezone>
  <ip>IP address</ip>
  <language>Supported language</language>
  <notes><![CDATA[Optional notes]]></notes> (Uses CDATA example)

Name/Email - Required. Email must be unique and valid.
Password - Must be in raw format. It will be encoded by the system. Leave blank to auto generate a password.
Timezone - Must be valid timezone as set in the "control/timezones.php" file. Example: US/Pacific
IP - Leave blank if not known. Will be updated on first login.
Language - Must be supported language (english, german etc). If not, will revert to default language.
Notes - Optional backend notes

XML Response

On successful transmission an xml response is returned:

<?xml version="1.0" encoding="utf-8"?>
  <accountID>Database ID of account created. For additional custom ops if required</accountID>

If an error occurs, the following is returned:

<?xml version="1.0" encoding="utf-8"?>
  <reason>Reason for error..</reason>

Your own application should deal with the response accordingly.

Example File

Click here to view an example xml file.

Return to API Overview