Retrieving Information about a Virtual Directory

The get operation lets you obtain settings of virtual directories.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet that creates a virtual directory should include the get operation node:

<packet>
<virtdir>
   <get>
   ...
   </get>
</virtdir>
</packet>

 

The get node is presented by type GetVDirInputType (virtdir.xsd). Its graphical representation is as follows:

GetVDirInputType

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The get node of the output XML packet is structured as follows:

SDirGetResultType

 

Samples

The following request packet retrieves a virtual directory /dir1 properties on the specified site:

<packet>
<virtdir>
<get>
   <site-id>1</site-id>
   <name>/dir1</name>
</get>
</virtdir>
</packet>

Response:

<packet>
  <virtdir>
    <get>
      <result>
        <status>ok</status>
        <properties>
          <access-source>false</access-source>
          <access-read>true</access-read>
          <access-write>false</access-write>
          <dir-browsing>false</dir-browsing>
          <log-visits>true</log-visits>
          <default-doc>
            <enabled/>
            <search>Index.html</search>
            <search>Index.htm</search>
            <search>Index.cfm</search>
            <search>Index.shtml</search>
            <search>Index.shtm</search>
            <search>Index.stm</search>
            <search>Index.php</search>
            <search>Index.php3</search>
            <search>Index.asp</search>
            <search>Index.aspx</search>
            <search>Default.htm</search>
            <search>Default.asp</search>
            <search>Default.aspx</search>
          </default-doc>
          <access-anonymous>true</access-anonymous>
          <require-ssl>false</require-ssl>
          <ip-allow/>
          <ip-deny/>
          <is-deny-by-concurrent-requests>true</is-deny-by-concurrent-requests>
          <max-concurrent-requests>4</max-concurrent-requests>
          <is-deny-by-request-rate>true</is-deny-by-request-rate>
          <max-requests>33</max-requests>
          <request-interval>333</request-interval>
        </properties>
      </result>
    </get>
  </virtdir>
</packet>