Domain Manager - GetFTPSites

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Domain Manager - GetFTPSites  retrieves all ftp sites under a specified owner. This web service call can be made as http://your-domain.com/HC7API/DomainManager.asmx?op=GetFTPSites.

Input Parameters

• HostUserName

• HostPassword

• OwnerName - user name whose ftp sites you want to retrieve, can be set to Host Name for getting all records

• OptionalParam

• FTPSiteName - search filter

• Language
   

Output Parameters

• FTPSiteID - a unique identification number given to each ftp site

• FTPSiteName

• Creator - Reseller Name, returned if OwnerName parameter is set to Host Name

• Owner - Webadmin Name, returned if OwnerName parameter is set to Reseller Name

• PlanName - SoldPlan instance name under which ftp site is created

• ServerName - name of the sever on which ftp site is physically created

• ServerIP - IP of the sever on which ftp site is physically created

Sample Optional Parameters

<Parameters>

<Parameter Name = "FTPSiteName">MyDomain.com</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/GetFTPSites"

<?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>

    <GetFTPSites xmlns="http://tempuri.org/">

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <OptionalParam>xml</OptionalParam>

    </GetFTPSites>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/DomainManager.asmx/GetFTPSites HTTP/1.1

Host: your-domain.com

Content-Type: application/x-www-form-urlencoded

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&OptionalParam=xml

Sample C# Code

public DomainManager.Response GetFTPSites(string strHostUserName, string strHostPassword, string strOwnerName)

{

         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","");

  //Adding sub nodes

  XmlNode xParameter = oDoc.CreateNode(XmlNodeType.Element,"Parameter","");

  XmlAttribute xAttribute = oDoc.CreateAttribute("Name");

  xAttribute.Value = "FTPSiteName";

  xParameter.Attributes.Append(xAttribute);

  xParameter.InnerText = "MyDomain.com";

  xOptionalParam.AppendChild(xParameter);

  .......

  .......

  .......

                    oResponse = oDomain.GetFTPSites(strHostUserName, strHostPassword, strOwnerName,

                    OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetFTPSites</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

        <FTPSites xmlns="">

        <RecordCount>2</RecordCount>

            <RecordRow>

                <FTPSiteID>1578</FTPSiteID>

                <FTPSiteName>MyDomain.com</FTPSiteName>

                <Owner>john</Owner>

                <ServerName>abc</ServerName>

                <ServerIP>127.0.0.1</ServerIP>

                <PlanName>MyPlan</PlanName>

            </RecordRow>

                   .......

                   .......

                   .......

        </FTPSites>

    </Result>

</Response>