|
Version: 7C
HC7 Build: 7.00.0012 and later
API Build: 1.00.0001 and later
Domain Manager - AddWebsite adds a website under a specified owner. This web service call can be made as http://your-domain.com/HC7API/DomainManager.asmx?op=AddWebsite.
Input Parameters
HostUserName
HostPassword
OwnerName - owner name who is going to add website
WebsiteName - name of website to be added
WebsiteOwner - webadmin name under which you want to add this website
WebsiteType - IPBased / NameBased
SoldPlanID - Unique identification number of plan already sold to WebsiteOwner, with desired resource quota in it
Note : SoldPlanID the unique identification number, can be retrieved using GetSoldPlans.
|
IPAddress - IP address of website (if WebsiteType parameter is set to IPBased), IPLessDomainIP (if WebsiteType parameter is set to NameBased)
Note : IP Address list can be retrieved using GetFreeIPList or GetIPLessDomainIPList method of ServerManager.
|
OptionalParam
DNSServerName - if sent, DNS will be created
on specified server otherwise loadbalancing will be
done
AllowAnonymous True/False - default value will be set to True
ReadAcess True/False - default value will be set to True
WriteAccess True/False - default value will be set to False
ScriptSourceAccess True/False - default value will be set to True
ExecuteAccess True/False - default value will be set to False
DirectoryBrowsingAccess True/False - default value will be set to False
FrontPageExtensionsAccess True/False - default value will be set to False
EnableDefaultDocument True/False - default value will be set to True
DefaultDocumentList - comma separated list of default documents for this website, default value will be set to "default.html,default.htm,default.asp,default.aspx,index.htm,index.html,index.cfm,index.asp,index.aspx"
TemporaryVirDirectory - send if you want to create temporary virtual directory in case of NameBased site
Language
Output Parameters
N/A
Sample Optional Parameters
<Parameters>
<Parameter Name = "AllowAnonymous ">True</Parameter>
<Parameter Name = "ReadAcess ">True</Parameter>
<Parameter Name = "WriteAccess">True</Parameter>
<Parameter Name = "ScriptSourceAccess">True</Parameter>
<Parameter Name = "ExecuteAccess">True</Parameter>
<Parameter Name = "DirectoryBrowsingAccess">True</Parameter>
<Parameter Name = "FrontPageExtensionsAccess">True</Parameter>
<Parameter Name = "EnableDefaultDocument">True</Parameter>
<Parameter Name = "DefaultDocumentList ">default.html,default.htm,default.asp,default.aspx,index.htm,index.html,index.cfm,index.asp,index.aspx</Parameter>
<Parameter Name = "Language">French</Parameter>
</Parameters>
Sample SOAP Request
POST /HC7API/DomainManager.asmx HTTP/1.1
Host: your-domain.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/AddWebsite"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddWebsite xmlns="http://tempuri.org/">
<HostUserName>host</HostUserName>
<HostPassword>host123</HostPassword>
<OwnerName>david</OwnerName>
<WebsiteName>MyDomain.com</WebsiteName>
<WebsiteOwner>john</WebsiteOwner>
<WebsiteType>IPBased</WebsiteType>
<SoldPlanID>12</SoldPlanID>
<IPAddress> 127.0.0.1 </IPAddress>
<DNSServerName>abc</DNSServerName>
<OptionalParam>xml</OptionalParam>
</AddWebsite>
</soap:Body>
</soap:Envelope>
Sample HTTP Request
POST /HC7API/DomainManager.asmx/AddWebsite HTTP/1.1
Host: your-domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
HostUserName=host&HostPassword=host123&OwnerName=david&WebsiteName=MyDomain.com&WebsiteOwner
=john&WebsiteType=IPBased&SoldPlanID=12&IPAddress=127.0.0.1&DNSServerName=abc&OptionalParam=xml
Sample C# Code
public DomainManager.Response AddWebsite(string strHostUserName, string strHostPassword, string strOwnerName, string strWebsiteName, string strWebsiteOwner, string strWebsiteType, string IPAddress, int nSoldPlanID, string strDNSServerName)
{
try
{
DomainManager.DomainManager oDomain = new DomainManager.DomainManager();
DomainManager.Response oResponse = new DomainManager.Response();
XmlDocument oDoc = new XmlDocument();
//Adding root node
XmlNode xOptionalParam = oDoc.CreateNode(XmlNodeType.Element,"Parameters","");
.......
.......
oResponse = oDomain.AddWebsite(strHostUserName, strHostPassword, strOwnerName,
strWebsiteName, strWebsiteOwner, strWebsiteType, IPAddress, nSoldPlanID, strDNSServerName,
OptionalParam);
}
catch
{
}
return oResponse;
}
Sample Response
<Response>
<Method>AddWebsite</ Method>
<Status>true</Status>
<ErrorCode>70700011</ErrorCode>
<ErrorDescription>Website created successfully.</ErrorDescription>
<Result/>
</Response>