|
|
|
Description
The function allows to get the following information about all modules installed in SiteBuilder: module name, module status (active/not active), module version, module type, and module description.
Synopsis
Name of the script to call
[SideWinder]/remote_admin/modules.php
Login:password for accessing the directory
Login: Root
Password: Reseller
Parameters
cmd=get_modules
Result
The result string has the following format:<RESULT_ACTION><RESULT NAME="Name">Result</RESULT><STATUS CODE="Status Code">Status string</STATUS></RESULT_ACTION>
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.
Name - the name of the returning value. If no errors have occurred during execution of the function, then Name = 'modules', else Name is empty.
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.
Result - the returning value. If some errors have occurred during execution of the function, then Result is empty, else if the function has been completed successfully Result contains an XML-format string, where each module is described with a tag: <MODULE NAME="mod_name" ACTIVE="act_val" VERSION="version" TYPE="type" DESCRIPTION="description" /> mod_name - module name;
act_val - 1 | 0 (1 - active, 0 - not active);
version - module version;
type - module type;
description - module description.
Example
Command
[SiteBuilderHost]/remote_admin/modules.php?cmd=get_modules
Result<RESULT_ACTION><RESULT NAME="modules"><MODULE NAME="blogger" ACTIVE="1" VERSION="1.0.0" TYPE="block" DESCRIPTION="Blogger Editor" /><MODULE NAME="counter" ACTIVE="1" VERSION="1.0.0" TYPE="block" DESCRIPTION="Counter" /></RESULT><STATUS CODE="090007">OK</STATUS></RESULT_ACTION>
Description
The function allows to activate one or several modules.
Synopsis
Name of the script to call
[SiteBuilderHost]/remote_admin/modules.php
Login:password for accessing the directory
Login: Root
Password: Reseller
Parameters
cmd=activate
modules=mod_name[,mod_name]mod_name - module name
Result
The result string has the following format:<RESULT_ACTION><RESULT NAME="Name">Result</RESULT><STATUS CODE="Status Code">Status string</STATUS></RESULT_ACTION>
In the case of the Activate function, the result string doesn't contain any values. It returns only status message.
Example
Command[SiteBuilderHost]/remote_admin/modules.php?cmd=activate&modules=blogger,counter
Result<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="090007">OK</STATUS></RESULT_ACTION>
Description
The function allows to deactivate one or several modules.
Synopsis
Name of the script to call
[SiteBuilderHost]/remote_admin/modules.php
Login:password for accessing the directory
Login: Root
Password: Reseller
Parameters
cmd=deactivate
modules=mod_name[,mod_name]mod_name - module name
Result
The result string has the following format:<RESULT_ACTION><RESULT NAME="Name">Result</RESULT><STATUS CODE="Status Code">Status string</STATUS></RESULT_ACTION>
In the case of the Deactivate function, the result string doesn't contain any values. It returns only status message.
Example
Command[SiteBuilderHost]/remote_admin/modules.php?cmd=deactivate&modules=blogger,counter
Result<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="090007">OK</STATUS></RESULT_ACTION>
Description
The function allows to delete one or several modules.
Synopsis
Name of the script to call
[SiteBuilderHost]/remote_admin/modules.php
Login:password for accessing the directory
Login: Root
Password: Reseller
Parameters
cmd=delete
modules=mod_name[,mod_name]mod_name - module name
Result
The result string has the following format:<RESULT_ACTION><RESULT NAME="Name">Result</RESULT><STATUS CODE="Status Code">Status string</STATUS></RESULT_ACTION>
In the case of the Delete function, the result string doesn't contain any values. It returns only status message.
Example
Command[SiteBuilderHost]/remote_admin/modules.php?cmd=delete&modules=blogger,counter
Result<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="090007">OK</STATUS></RESULT_ACTION>