Domain Manager - SetFTPProperties

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

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

Input Parameters

• HostUserName

• HostPassword

• OwnerName - creator or owner name of ftp site

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

• OptionalParam

• AllowAnonymous - True / False

• ReadAccess - True / False

• WriteAccess - True / False

• Language
   

Output Parameters

N/A

Sample Optional Parameters

<Parameters>

<Parameter Name = "AllowAnonymous">True</Parameter>

<Parameter Name = "ReadAccess">False</Parameter>

<Parameter Name = "WriteAccess">False</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/SetFTPProperties"

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <FTPSiteName>MyDomain.com</FTPSiteName>

      <OptionalParam>xml</OptionalParam>

    </SetFTPProperties>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/DomainManager.asmx/SetFTPProperties 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 SetFTPProperties(string strHostUserName, string strHostPassword, string strOwnerName, string strFTPSiteName)

{

         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 = "AllowAnonymous";

  xParameter.Attributes.Append(xAttribute);

  xParameter.InnerText = "True";

  xOptionalParam.AppendChild(xParameter);

  .......

  .......

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

                    strFTPSiteName, OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>SetFTPProperties</Method>

    <Status>true</Status>

    <ErrorCode>73000031</ErrorCode>

    <ErrorDescription>FTP site successfully updated.</ErrorDescription>

    <Result/>

 </Response>