Domain Manager - GetNameBasedFTPProperties

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

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

Input Parameters

• HostUserName

• HostPassword

• OwnerName - creator or owner name of name based ftp site

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

• OptionalParam

• Language
   

Output Parameters

• 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/GetNameBasedFTPProperties"

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <FTPName>MyFTPSite</FTPName>

      <OptionalParam>xml</OptionalParam>

    </GetNameBasedFTPProperties>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

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

Host: your-domain.com

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

Content-Length: length

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

Sample C# Code

public DomainManager.Response GetNameBasedFTPProperties(string strHostUserName, string strHostPassword, string strOwnerName, string strFTPName)

{

         try

         {

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

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

                    oResponse = oDomain.GetNameBasedFTPProperties(strHostUserName, strHostPassword,

                    strOwnerName, strFTPName, null);

        }

        catch

        {

        }

        return oResponse;

}

Sample Response

<Response>

    <Method>GetNameBasedFTPProperties</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

        <NameBasedFTPProperties xmlns="">

            <ReadAccess>True</ReadAccess>

            <WriteAccess>True</WriteAccess>

        </NameBasedFTPProperties>

    </Result>

</Response>