Domain Manager - GetFTPProperties

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Domain Manager - GetFTPProperties  retrieves properties of a specified ftp site. This web service call can be made as http://your-domain.com/HC7API/DomainManager.asmx?op=GetFTPProperties.

Input Parameters

• HostUserName

• HostPassword

• OwnerName - creator or owner name of ftp site

• FTPSiteName - name of ftp site whose properties you want to retrieve

• OptionalParam

• Language
   

Output Parameters

• IPAddress - IP address assigned to ftp site

• Port

• DomainStatus - Running / Stopped / Paused / Continued

• AllowAnonymous - True / False

• ReadAccess - True / False

• WriteAccess - True / False

Sample Optional Parameters

<Parameters>

<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/GetFTPProperties"

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <FTPSiteName>MyDomain.com</FTPSiteName>

      <OptionalParam>xml</OptionalParam>

    </GetFTPProperties>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

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

Host: your-domain.com

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

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&FTPSiteName=MyDomain.com
&OptionalParam=xml

Sample C# Code

public DomainManager.Response GetFTPProperties(string strHostUserName, string strHostPassword, string strOwnerName, string strFTPSiteName)

{

         try

         {

                    DomainManager.DomainManager oDomain = new DomainManager.DomainManager();

                    DomainManager.Response oResponse = new DomainManager.Response();

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

                    strFTPSiteName, null);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetFTPProperties</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

        <FTPSiteProperties xmlns="">

            <IPAddress>127.0.0.1</IPAddress>

            <Port>21</Port>

            <DomainStatus>Running</DomainStatus>

            <AllowAnonymous>False</AllowAnonymous>

            <ReadAccess>True</ReadAccess>

            <WriteAccess>True</WriteAccess>

        </FTPSiteProperties>

    </Result>

</Response>