Previous Topic

Next Topic

Book Contents

Site Management: sites.php

Description

The function allows to get information about all Sites in SiteBuilder. The information include the following: site status (activated/deactivated), publish information, i.e. whether the site is published or not, web site type (trial/regular), name of web site reseller, site creation date, and site expiration date.

Synopsis

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

cmd=get_sites

Result

<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 = 'sites', 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 Site is described with a tag:

<SITE

SITE_ALIAS="sb_siteid"
ACTIVE="sb_active"
TYPE="sb_site_type"
PUBLISH="sb_publish"
CREATION_DATE="cr_date"
CREATION_DATE_TIMESTAMP="cr_date_timestamp"
EXPIRATION_DATE="exp_date"
EXPIRATION_DATE_TIMESTAMP="exp_date_timestamp"
RESELLER="sb_owner_login"
/>

Parameter

Parameter Name in Admin Panel

Value

Description

sb_siteid

Site Alias

valid identifier

Site Alias is used for accessing the site both by administrator (in Admin Panel) and owner (in Wizard).

sb_active

Active

1 | 0

1 - the Site is active, 0 - the Site is not active.

sb_site_type

 

Trial | Regular

Site type.

sb_publish

Allow publishing sites

1 | 0 | n/a

1 - publish is allowed for the Site, 0 - publish is forbidden for the Site, n/a - the option is forbidden for the Site (for Trial Sites only)

cr_date

Creation Date

Date: mon, day, year

Creation Date

cr_date_timestamp

Creation Date

timestamp

Creation Date

exp_date

Expiration Date

Date: mon day, year or "-" (for Regular Sites only)

Supposed Date of the Site removal or "-" for Regular Sites

exp_date_timestamp

Expiration Date

timestamp or "-"

Supposed Date of the Site removal or "-" for Regular Sites

sb_owner_login

Reseller

reseller login

Login of the reseller owner of the site

Example


Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=get_sites

Result

<RESULT_ACTION><RESULT NAME="sites"><SITE SITE_ALIAS="51942848203" ACTIVE="1" TYPE="Trial" PUBLISH="n/a" CREATION_DATE="May 13, 2005" CREATION_DATE_TIMESTAMP="1115980291" EXPIRATION_DATE="June 12, 2005" EXPIRATION_DATE_TIMESTAMP="1118572291" RESELLER="root" /><SITE SITE_ALIAS="root_tr" ACTIVE="1" TYPE="Trial" PUBLISH="n/a" CREATION_DATE="May 13, 2005" CREATION_DATE_TIMESTAMP="1115974363" EXPIRATION_DATE="June 12, 2005" EXPIRATION_DATE_TIMESTAMP="1118566363" RESELLER="new" /><SITE SITE_ALIAS="rss_reg1" ACTIVE="1" TYPE="Regular" PUBLISH="0" CREATION_DATE="May 13, 2005" CREATION_DATE_TIMESTAMP="1115969123" EXPIRATION_DATE="-" EXPIRATION_DATE_TIMESTAMP="-" RESELLER="rss" /></RESULT><STATUS CODE="010081">OK</STATUS></RESULT_ACTION>

Description

The function allows to get detailed information about the Site. This information contains the following:site status (activated/deactivated), publish information, i.e. whether the site is published or not, web site type (trial/regular), the name of web site reseller, site creation date, site expiration date, site identity, site language, password protection (whether the web site is password protected), site builder Plan, applied to this particular site, site email. If the web site is published via FTP then the site information will include: FTP host, FTP login, FTP password, FTP work directory. Otherwise, if the site is published via VPS (Virtual Private Server) then information will contain: VPS domain, VPS ID, VPS work directory, SiteBuilder user, SiteBuilder group. Web site Plan information is also part of the site details: SiteBuilder plan, last plan revision date, maximum number of pages allowed for the site to contain. The site details also include: module name (the names of the modules web site contains, and template name,i.e. the names of the templates web site is using.

Synopsis

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

cmd=get_site_details
sb_siteid=site_id

site_id - Site Alias or Site Identity (Work Directory)

Result

<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 = 'site_details', 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 the Site is described with a tag:

<SITE

SITE_ALIAS="sb_siteid"
ACTIVE="sb_active"
TYPE="sb_site_type"
PUBLISH="sb_publish"
CREATION_DATE="cr_date"
CREATION_DATE_TIMESTAMP="cr_date_timestamp"
EXPIRATION_DATE="exp_date"
EXPIRATION_DATE_TIMESTAMP="exp_date_timestamp"

LAST_PUBLISH_DATE="publish_date"

LAST_PUBLISH_DATE_TIMESTAMP="publish_date_timestamp"

RESELLER="sb_owner_login"
SITE_IDENTITY="sb_site_identity"
LANGUAGE="sb_language"
PASSWORD_PROTECTED="pwd_protected"
PLAN="sb_plan"
PLAN_ALIAS="sb_plan_alias"

EMAIL="sb_email"
SITE_HOST_NAME="sb_host_name"
MODE="sb_mode"
FTP_HOST="sb_ftp_host"
FTP_LOGIN="sb_ftp_login"
FTP_PASSWORD="sb_ftp_pass"
FTP_WORK_DIRECTORY="sb_ftp_workdir"
VPS_DOMAIN="sb_domain"
VPS_SERVICE_VE_IP_ADDRESS="sb_service_ve_ip"
VPS_IDENTIFIER="sb_vps_id"
VPS_WORK_DIRECTORY="sb_vps_workdir"
VPS_OWNER_USER="sb_user"
VPS_OWNER_GROUP="sb_group"
] />

<SITE_PLAN
PLAN="sb_plan"

PLAN_ALIAS="sb_plan_alias"

LAST_REVISION_DATE="last_revision_date"
PAGES_NUMBER="sb_page_num" >

<HOSTS>

<HOST HOST_NAME="host_name" />
...
<HOST HOST_NAME="host_name" />
</HOSTS>
<MODULES>

<MODULE NAME="module_name" />
...
<MODULE NAME="module_name" />
</MODULES>
<TEMPLATES>

<TEMPLATE ID="template_name" />
...
<TEMPLATE ID="template_name" />
</TEMPLATES>
</SITE_PLAN>

</RESULT>

<STATUS CODE="010081">OK</STATUS>

Where parameters enclosed in square brackets [] can be missed.

Parameter

Parameter Name in Admin Panel

Value

Description

sb_siteid

Site Alias

valid identifier

Site Alias is used for accessing the site both by administrator (in Admin Panel) and owner (in Wizard).

sb_active

Active

1 | 0

1 - the Site is active, 0 - the Site is not active.

sb_site_type

 

Trial | Regular

Site type.

sb_publish

Allow publishing sites

1 | 0 | n/a

1 - publish is allowed for the Site, 0 - publish is forbidden for the Site, n/a - the option is forbidden for the Site (for Trial Sites only)

cr_date

Creation Date

Date: mon day, year

Creation Date

cr_date_timestamp

Creation Date

timestamp

Creation Date

exp_date

Expiration Date

Date: mon day, year or "-"

Supposed Date of the Site removal or "-" for Regular Sites

exp_date_timestamp

Expiration Date

timestamp or "-"

Supposed Date of the Site removal or "-" for Regular Sites

publish_date

Publish date

Date: mon day, year or "-"

Date of the last site publish

publish_date_timestamp

Publish date timestamp

timestamp or "-"

Date of the last site publish

sb_owner_login

Reseller

reseller login

Login of the reseller owner of the site

sb_site_identity

 

valid identifier

Site Identity (Work directory)

sb_language

Language

Language ID

Language of Wizard Interface for this Site. Can be missed.

pwd_protected

 

yes | no

'yes' - password is set, 'no' - password is not set.

sb_plan

Plan

Plan Name

Plan Name.

sb_plan_alias

 

Plan Alias

Plan Alias

sb_email

E-mail

valid e-mail

Owner e-mail. Can be missed

The following parameters are for Regular Sites only

sb_host_name

Site Host Name

DNS or IP Address

Host name. The site is accessible at this address after it is published.

sb_mode

Mode

ftp | vps

Specifies the method of publication for the Site.

Regular Sites, Mode = ftp can have following parameters

sb_ftp_host

FTP Host

DNS or IP Address

Host for publication.

sb_ftp_login

FTP Login

login

FTP Login.

sb_ftp_pass

FTP Password

password

FTP password.

sb_ftp_workdir

FTP Work Directory

directory

FTP Work Directory.

Regular Sites, Mode = vps can have following parameters

sb_domain

VPS Domain

DNS or IP Address

Host for publication.

sb_service_ve_ip

VPS Service VE IP Address

IP Address

Domain containing Virtual Machine.

sb_vps_id

VPS Identifier

 

Virtual Machine Identifier.

sb_vps_workdir

VPS Work Directory

directory

VPS Work Directory.

sb_user

VPS Owner User

directory owner

Directory owner.

sb_group

VPS Owner Group

directory owner

Directory owner group.

Plan Parameters

sb_plan

Plan

Plan Name

Plan Name.

sb_plan_alias

 

Plan Alias

Plan Alias

last_revision_date

Date of the last plan revision

date

Date of the last plan revision

sb_page_num

Pages Number

number

Limitation of total number of pages the Site can contain.

host_name

 

DNS Address, IP Address or Host Range Name

Host Name

module_name

 

identifier

Module Name

template_name

 

identifier

Template name

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=get_site_details&sb_siteid=JohnDoe

Result

<RESULT_ACTION>

<RESULT NAME="site_details">

<SITE

SITE_ALIAS="JohnDoe"
ACTIVE="1"
TYPE="Regular"
PUBLISH="1"
CREATION_DATE="March 28, 2005"
CREATION_DATE_TIMESTAMP="1111987043"
EXPIRATION_DATE="-"
EXPIRATION_DATE_TIMESTAMP="-"
LAST_PUBLISH_DATE="-"
LAST_PUBLISH_DATE_TIMESTAMP="-"
RESELLER="root"
SITE_IDENTITY="88b06667ef85111c01befb5d596f2a7b"
LANGUAGE="en_US"
PASSWORD_PROTECTED="yes"
PLAN="BasePlan, revision 0.1"
SITE_HOST_NAME="vasia.com"
MODE="vps"
VPS_DOMAIN="192.168.47.41"
VPS_SERVICE_VE_IP_ADDRESS="192.168.0.1"
VPS_IDENTIFIER="180"
VPS_WORK_DIRECTORY="www"
VPS_OWNER_USER="vasia_user"
VPS_OWNER_GROUP="vps_users"
/>
<SITE_PLAN
PLAN="BasePlan, revision 0.1"

PLAN_ALIAS="BasePlan_alias"
LAST_REVISION_DATE="2005-05-30"
PAGES_NUMBER="10" >

<HOSTS>

<HOST HOST_NAME="192.168.47.31" />

<HOST HOST_NAME="range(192.168.47.40-60)" />
</HOSTS>
<MODULES>

<MODULE NAME="blogger" />

<MODULE NAME="counter" />

<MODULE NAME="feedback" />

<MODULE NAME="forum" />
</MODULES>
<TEMPLATES>

<TEMPLATE ID="vap-45" />
</TEMPLATES>
</SITE_PLAN>
</RESULT>
<STATUS CODE="010081">OK</STATUS>
</RESULT_ACTION>

Description

The function allows to create a structure containing information about a site and parameters for its publication. The following are parameters for site publication: site status (activated/deactivated), publish information, i.e. whether the site is published or not, web site type (trial/regular), the name of web site reseller, site creation date, site expiration date, site identity, site language, password protection (whether the web site is password protected), site builder Plan, applied to this particular site, site email, FTP host, FTP login, FTP password, FTP work directory. Otherwise. If the site will be published via VPS (Virtual Private Server) then parameters will contain: VPS domain, VPS ID, VPS work directory, SiteBuilder user, SiteBuilder group. Web site Plan information is also part of the parameters: SiteBuilder plan, last plan revision date, maximum number of pages allowed for the site to contain. The site parameters also include: module name (the names of the modules web site contains, and template name,i.e. the names of the templates web site is using.

Synopsis

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameter

Parameter Name in Admin Panel

Value

Description

*cmd

 

create_site

Required parameter.Command

TRIAL Site Creation

General Properties

sb_site_type

 

TRIAL

Trial Site is created. If this parameter is missed then the site is deemed "TRIAL" by default..

sb_siteid

Site Alias

valid identifier

Site Alias is used for accessing the site by administrator (in Admin Panel) and owner (in Wizard). It is generated automatically if missed.

sb_active

Active

1 | (0 | unset)

1 - the Site is active, 0 | unset - the Site is not active.

sb_language

Language

language ID

Language of Wizard Interface for this Site. If this parameter is missed then the current system language is used.

sb_reseller

Reseller

reseller login

Login of the reseller owner of this site. This attribute is available only for Root. If this parameter is missed then the owner of this site will be the administrator whose login is used to execute operation.

sb_pswd

Password

password

If it's necessary to password protect this site editing (in Wizard), then you should specify this parameter.

sb_pswd_conf

Confirm password

value of sb_pswd

Password confirmation.

Informational E-Mail

sb_send_mail

Send site information to e-mail

1 | (0 | unset)

If it is necessary to send given information about the Site to Site owner then this parameter should be set in "1" and sb_email should be specified as well.

sb_email

E-mail

valid e-mail

Site owner's e-mail address. If sb_send_mail is equal to "1" then sb_email should be specified.

REGULAR Site Creation

General Properties

sb_site_type

 

REGULAR

Indicates that the regular Site is created. If this parameter is missed then the site is deemed "TRIAL" by default..

sb_siteid

Site Alias

valid identifier

Site Alias is used for accessing the site both by administrator (in Admin Panel) and owner (in Wizard). It is generated automatically if missed.

sb_active

Active

1 | (0 | unset)

1 - the Site is active, 0 | unset - the Site is not active.

*sb_plan

(plan_alias)

Plan

Plan Name (or Alias)

 

Required parameter. Name of registered in SiteBuilder and active Plan (or Alias)

sb_language

Language

language ID

Language of Wizard Interface for this Site. If it is missed then current system language is used by default.

sb_reseller

Reseller

reseller login

Current site owner reseller login. This attribute is available only for Root. If this parameter is missed then the owner of this site will be the administrator whose login is used to execute operation.

sb_pswd

Password

password

If you require to password protect this site editing (in WIzard) specify this parameter.

sb_pswd_conf

Confirm password

value of sb_pswd

Password confirmation.

Publish Properties

sb_publish

Allow publishing sites

1 | (0 | unset)

1 - publish is allowed, 0 or unset - publish is forbidden

sb_host_name

Site Host Name

DNS or IP Address

Host name. After publishing this site is available at this address.

sb_mode

Mode

ftp | vps

This Site publishing method. If this parameter is missed then by default it is "FTP".

If Mode = ftp then following parameters can be set

sb_ftp_host

FTP Host

DNS or IP Address

Host for publication. This host should be active and registered in Plan of the Site.

sb_ftp_login

FTP Login

login

FTP Login.

sb_ftp_pass

FTP Password

password

FTP password.

sb_ftp_workdir

FTP Work Directory

directory

FTP Work Directory.

If Mode = vps then following parameters should be set

*sb_domain

VPS Domain

DNS or IP Address

Required parameter. Host for publication. This host should be active and registered in Plan of the Site.

*sb_service_ve_ip

VPS Service VE IP Address

IP Address

Required parameter. Domain containing Virtual Machine.

*sb_vps_id

VPS Identifier

 

Required parameter. Virtual Machine Identifier.

*sb_vps_workdir

VPS Work Directory

directory

Required parameter. VPS Work Directory.

*sb_user

VPS Owner User

directory owner

Required parameter. Directory owner.

*sb_group

VPS Owner Group

directory owner group

Required parameter. Directory owner group.

Informational E-Mail

sb_send_mail

Send site information to e-mail

1 | (0 | unset)

If it is required to send given information about the Site to Site owner then this parameter should be set in "1" and sb_email should be specified as well.

sb_email

E-mail

valid e-mail

Owner e-mail. If sb_send_mail is equal to "1" then sb_email should be specified.

Plan Properties

sb_page_num

Pages Number

Number

Maximum number of pages this Site can have. Optional.
If sb_page_num is set then the difference between sb_page_num and the corresponding attribute of sb_plan (pages number) is calculated. The pages number limit from sb_plan is stored in the base part of user plan, but the difference is stored in the user's part of the user plan.

PlanHost

Hosts

host_name[,host_name]
host_name - host name (DNS name, IP address or host's range name)

List of hosts names. Optional.
If the parameter is set then all specified hosts (which are absent in sb_plan hosts list) will be added to the user's part of the user plan

PlanTempl

Templates

template_name[,template_name]
template_namee - template name

List of templates names. Optional.
If the parameter is set then all specified templates (which are absent in sb_plan templates list) will be added to the user's part of the user plan

PlanMod

Modules

module_name[,module_name]
module_name - module name

List of modules names. Optional.
If the parameter is set then all specified modules (which are absent in sb_plan modules list) will be added to user part of the user plan

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 = 'site_identity', 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 a Site Identity (Work Directory) of the just created site.

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=create_site& sb_site_type=REGULAR&sb_publish=1&sb_active=1&sb_siteid=newsid& sb_plan=BasePlan&sb_email=vas@mail.ru&sb_language=ru_RU&sb_mode=ftp

[SiteBuilderHost]/remote_admin/sites.php?cmd=create_site& sb_site_type=REGULAR&sb_publish=1&sb_active=1&sb_siteid=newsid& plan_alias=BasePlan_alias&sb_email=vas@mail.ru&sb_language=ru_RU&sb_mode=ftp

Result

<RESULT_ACTION><RESULT NAME="site_identity">e662d1e40603e2bcee8ed801517bbba2</RESULT><STATUS CODE="010048">Site has been created</STATUS></RESULT_ACTION>

Description

The function enables administrator to edit the following site parameters: site status (activated/deactivated), publish information, i.e. whether the site is published or not, web site type (trial/regular), the name of web site reseller, site creation date, site expiration date, site identity, site language, password protection (whether the web site is password protected), site builder Plan, applied to this particular site, site email, FTP host, FTP login, FTP password, FTP work directory. Otherwise. If the site will be published via VPS (Virtual Private Server) then parameters will contain: VPS domain, VPS ID, VPS work directory, SiteBuilder user, SiteBuilder group. Web site Plan information is also part of the parameters: SiteBuilder plan, last plan revision date, maximum number of pages allowed for the site to contain. The site parameters also include: module name (the names of the modules web site contains, and template name,i.e. the names of the templates web site is using.

Synopsis

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

All parameters are optional except cmd and sb_old_siteid. You should specify only those parameters that you are going to change; previous values will be saved for all other parameters.

Parameter

Parameter Name in Admin Panel

Value

Description

*cmd

 

update_site

Required parameter. Command

General Properties

*sb_old_siteid

 

Site Alias or Site Identity

Required parameter. Site Alias or Site Identity. This parameter indicates the site to work with.

sb_siteid

Site Alias

valid identifier

Site Alias is used for accessing the site both by administrator (in Admin Panel) and owner (in Wizard).

sb_active

Active

1 | 0

1 - the Site is active, 0 - the Site is not active.

sb_plan

Plan

Plan Name

Name of Plan registered in SiteBuilder and active.

plan_alias

 

 

Plan Alias

Name of Plan (or Alias) registered in SiteBuilder and active.

sb_language

Language

language ID

Language of Wizard Interface for this Site.

sb_reseller

Reseller

reseller login

This site owner reseller login. This attribute is available only for Root. If this parameter is missed then the owner of this site by default will be the administrator whose login is used to execute operation.

sb_pswd

Password

password

If editing of this site (in Wizard) is required to be password protected then you should specify the parameter

sb_pswd_conf

Confirm password

value of sb_pswd

Password confirmation.

Publish Properties

sb_publish

Allow publishing sites

1 | 0

1 - publish is allowed, 0 - publish is forbidden

sb_host_name

Site Host Name

DNS or IP Address

Host name. The site is accessible via this address after its publishing.

sb_mode

Mode

ftp | vps

Specifies the method of Site publication.

If Mode = ftp then following parameters can be set

sb_ftp_host

FTP Host

DNS or IP Address

Host for publication. This host should be active and registered in Plan of the Site.

sb_ftp_login

FTP Login

login

FTP Login.

sb_ftp_pass

FTP Password

password

FTP password.

sb_ftp_workdir

FTP Work Directory

directory

FTP Work Directory.

If Mode = vps then following parameters can be set

sb_domain

VPS Domain

DNS or IP Address

Host for publication. This host should be active and registered in Plan of the Site.

sb_service_ve_ip

VPS Service VE IP Address

IP Address

Domain containing Virtual Machine is.

sb_vps_id

VPS Identifier

 

Virtual Machine Identifier.

sb_vps_workdir

VPS Work Directory

directory

VPS Work Directory.

sb_user

VPS Owner User

directory owner

Directory owner.

sb_group

VPS Owner Group

directory owner group

Directory owner group.

Informational E-Mail

sb_send_mail

Send site information to e-mail

1 | (0 | unset)

If it is required to send specified information about the Site to the Site owner then this parameter should be set at "1" and sb_email should be specified as well.

sb_email

Email

valid e-mail

Site owner's e-mail. If sb_send_mail is equal to "1" then sb_email should be given.

Plan Properties

sb_page_num

Pages Number

Number

Maximum number of web pages located on Site.
If sb_page_num is set then the difference between sb_page_num and the corresponding limit from the base part of the user plan is calculated. The difference is stored in the user's part of the user plan.
If sb_page_num is not set then the corresponding limit from user part of the user plan will not be changed.

PlanHost

Hosts

host_name[,host_name]
where host_name - host name (DNS name, IP address or host's range name)

List of hosts names.
If this parameter is set then hosts list from the user's part of the user plan will be replaced with a new one (even if the new one is empty). Hosts list from the base part of the user's plan will not be changed.
If the parameter is not set then the hosts list from the user's part will not be changed.

PlanTempl

Templates

template_name[,template_name]
where template_name - template name

List of templates names.
If the parameter is set then templates list from user part of the user plan will be replaced with a new one (even if the new one is empty). Templates list from the base part of the user plan will not be changed.
If the parameter is not set then the templates list from the user's part will not be changed.

PlanMod

Modules

module_name[,module_name]
where module_name - module name

List of modules names.
If the parameter is set then modules list from the user's part of the user plan will be replaced with a new one (even if the new one is empty). Modules list from the base part of the user plan will not be changed.
If the parameter is not set then the modules list from the user's part will not be changed.

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 = 'site_identity', 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 a Site Identity (Work Directory) of the just updated site.

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=update_site&sb_old_siteid=newsid& sb_siteid=SiteOfVasia

Result

<RESULT_ACTION><RESULT NAME="site_identity">e662d1e40603e2bcee8ed801517bbba2</RESULT><STATUS CODE="010051">Site has been updated</STATUS></RESULT_ACTION>

Description

The function allows to delete one or several sites.

Synopsis

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

cmd=delete
ids=site_id[,site_id]

site_id - Site Alias or Site Identity (Work Directory)

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 site function, the result string doesn't contain any values. It returns only status message.

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=delete&ids=SiteOfVasia,af3424789e1

Result

<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="010056">Site(s) have been deleted</STATUS></RESULT_ACTION>

Description.

The function allows to upgrade one or several TRIAL sites to REGULAR sites. Unlike trial sites regular sites can be published.

Synopsis.

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters.

cmd=trial2regular
ids=site_id[,site_id]

site_id - Site Alias or Site Identity (Work Directory)

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 Upgrade TRIAL site to REGULAR site function, the result string doesn't contain any values. It returns only status message.

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=trial2regular&ids=Tr1,Tr2

Result

<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="010076">Type has been changed successfully. You can add publishing parameters for these sites</STATUS></RESULT_ACTION>

Description.

The function allows to activate one or several sites.

Synopsis.

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

cmd=activate
ids=site_id[,site_id]

site_id - Site Alias or Site Identity (Work Directory)

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 site function, the result string doesn't contain any values. It returns only status message.

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=activate&ids=JohnDoe,Piter

Result

<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="010079">Site(s) have been activated.</STATUS></RESULT_ACTION>

Description

The function allows to deactivate one or several sites.

Synopsis.

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

cmd=deactivate
ids=site_id[,site_id]

site_id - Site Alias or Site Identity (Work Directory)

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 site function, the result string doesn't contain any values. It returns only status message.

Example.

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=deactivate&ids=VasiaPupkin,Piter

Result

<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="010078">Site(s) have been deactivated</STATUS></RESULT_ACTION>

Description

The function allows to allow publish for one or several sites.

Synopsis

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

cmd=allow_publish
ids=site_id[,site_id]

site_id - Site Alias or Site Identity (Work Directory)

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 Allow publishing function, the result string doesn't contain any values. It returns only status message.

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=allow_publish&ids=VasiaPupkin,Piter

Result

<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="010054">Site(s) has been updated</STATUS></RESULT_ACTION>

Description

The function allows to deny publish for one or several sites.

Synopsis

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

cmd=deny_publish
ids=site_id[,site_id]

site_id - Site Alias or Site Identity (Work Directory)

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 site function, the result string doesn't contain any values. It returns only status message.

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=deny_publish&ids=VasiaPupkin,Piter

Result

<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="010054">Site(s) has been updated</STATUS></RESULT_ACTION>

Description

The function allows to publish the site.

Synopsis

Name of the script to call

[SiteBuilderHost]/remote_admin/sites.php

Login:password for accessing the directory

Login: Root

Password: Reseller

Parameters

cmd=allow_publish
ids=site_id[,site_id]

site_id - Site Alias or Site Identity (Work Directory)

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 Publish site function, the result string doesn't contain any values. It returns only status message.

Example

Command

[SiteBuilderHost]/remote_admin/sites.php?cmd=allow_publish&ids=VasiaPupkin,Piter

Result

<RESULT_ACTION><RESULT NAME=""></RESULT><STATUS CODE="010068">Publishing has finished successfully.</STATUS></RESULT_ACTION>