Domain Properties - GetVirtualDirectoryProperties

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Domain Properties - GetVirtualDirectoryProperties retrieves the properties of virtual directory under a specified website. This web service call can be made as

http://your-domain.com/HC7API/DomainProperties.asmx?op=GetVirtualDirectoryProperties.

Input Parameters

• HostUserName

• HostPassword

• OwnerName

• VirtualDirectoryPath

• WebsiteName

• OptionalParam

•  Language
   

Output Parameters

• AllowAnonymous - True / False

• WriteAccess - True / False

• ReadAccess - True / False

• DirectoryBrowsingAccess - True / False

• LoggingEnabled - True / False

• ExecutePermissions - None / Scripts Only / Scripts and Executables

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

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <WebsiteName>MyDomain.com</WebsiteName>

      <VirtualDirectoryPath>parent/child</VirtualDirectoryPath>

      <OptionalParam>xml</OptionalParam>

    </GetVirtualDirectoryProperties>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

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

Host: your-domain.com

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

Content-Length: length

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

WebsiteName=MyDomain.com&VirtualDirectoryPath=parent/child&OptionalParam=xml

Sample C# Code

public DomainProperties.Response GetVirtualDirectoryProperties(string strHostUserName, string strHostPassword, string strOwnerName, string strWebsiteName, string strVirtualDirectoryPath)

{

         try

         {

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

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

                   oResponse = oDomain.GetVirtualDirectoryProperties(strHostUserName, strHostPassword,  

                   strOwnerName, strWebsiteName, strVirtualDirectoryPath, null);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetVirtualDirectoryProperties</ Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

       <VirtualDirectories xmlns="">

          <AllowAnonymous>True<AllowAnonymous>

          <WriteAccess>True<WriteAccess>

          <ReadAccess>False<ReadAccess>

          <DirectoryBrowsingAccess>False<DirectoryBrowsingAccess>

          <LoggingEnabled>True<LoggingEnabled>

          <ExecutePermissions>Scripts Only<ExecutePermissions>

       </VirtualDirectories>

    <Result/>

</Response>