Domain Properties - DeletePrivateFolder

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Domain Properties - DeletePrivateFolder deletes a specified private folder. This web service call can be made as http://your-domain.com/HC7API/DomainProperties.asmx?op=DeletePrivateFolder.

Input Parameters

• HostUserName

• HostPassword

• OwnerName

• FolderPath

• UserName

• WebsiteName

• OptionalParam

•  Language
   

Output Parameters

N/A

Sample Optional Parameters

<Parameters>

<Parameter Name = "Language">French</Parameter>

</Parameters>

Sample SOAP Request

POST /HC7API/DomainProperties.asmx HTTP/1.1

Host: your-domain.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/DeletePrivateFolder"

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <FolderPath>D:\webspace\david\john\MyDomain.com</FolderPath>

      <UserName>john</UserName>

      <WebsiteName>MyDomain.com</WebsiteName>

      <OptionalParam>xml</OptionalParam>

    </DeletePrivateFolder>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/DomainProperties.asmx/DeletePrivateFolder HTTP/1.1

Host: your-domain.com

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

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&FolderPath=

D:\webspace\david\john\MyDomain.com&UserName=john&WebsiteName

=MyDomain.com&OptionalParam=xml

Sample C# Code

public DomainProperties.Response DeletePrivateFolder(string strHostUserName, string strHostPassword, string strOwnerName, string strFolderPath, string strUserName, string strWebsiteName)

{

         try

         {

                   DomainProperties.DomainProperties oDomain = new DomainProperties.DomainProperties();

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

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

                   strFolderPath, strUserName, strWebsiteName, null);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>DeletePrivateFolder</ Method>

    <Status>true</Status>

    <ErrorCode>70702071</ErrorCode>

    <ErrorDescription>Private Folder removed successfully.</ErrorDescription>

    <Result/>

</Response>