Previous Topic

Next Topic

Book Contents

Remote Admin

REMOTE ADMIN enables user to administrate SiteBuilder without using visual Admin Panel and without accessing SiteBuilder. REMOTE ADMIN functions are implemented as PHP scripts. Input parameters for these scripts are POST or GET variables.

This way SiteBuilder can be managed from a command line, another program or address bar of a browser.

All scripts return data in XML format. The result string has the following form:

<RESULT_ACTION><RESULT NAME="Name">Result</RESULT><STATUS CODE="Status Code">Status string</STATUS></RESULT_ACTION>

Name - the name of the returning value;

Result - the returning value.

Variable can contain single value or XML-format string depending on its function.This variable is not empty only if the function has been completed successfully and if this function is supposed to return some value. See details in functions descriptions.

Status string - a string containing information on the result of the function including description of an error if it has occurred during execution of the function. Status string always contains a value.

Status code - a 6-digits number containing code of the result of the function, i.e. error code or code of successful completion of the function. Status code always contains a value.

In case the error occurs during execution of any script the output will contain the error code. Detailed descriptions of error codes are provided in .doc files, each of them containing the error codes and error description for particular type of operation. Below you can find the list of files along with error types of operations:

File name

Operation type

ACC_APIcodes.doc

root/reseller account

HOST_APIcodes.doc

host management

LANG_APIcodes.doc

languages

MOD_APIcodes.doc

modules management

PM_APIcodes.doc

plan management

RA_APIcodes.doc

remote admin internal error

RSS_APIcodes.doc

reseller management

SKIN_APIcodes.doc

skins

SM_APIcodes.doc

site management

TPL_APIcodes.doc

templates management