Documentation Center

FolderList

When the subfolders are retrieved from a folder, an XML structure with the metadata of the current folder and information about the subfolders is returned.

XML structure

<xs:schema id="ISHFolder" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ishfolder">
    <xs:complexType>
      <xs:choice maxOccurs="unbounded">
        <xs:element ref="ishfields" minOccurs="1" maxOccurs="1"/>
        <xs:element ref="ishfolder" minOccurs="0" maxOccurs="unbounded"/>
      </xs:choice>
      <xs:attribute name="ishfolderref" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:long">
            <xs:minInclusive value="0"/>
            <xs:maxInclusive value="9999999999"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="ishfoldertype" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="ISHNone"/>
            <xs:enumeration value="ISHModule"/>
            <xs:enumeration value="ISHMasterDoc"/>
            <xs:enumeration value="ISHLibrary"/>
            <xs:enumeration value="ISHTemplate"/>
            <xs:enumeration value="ISHIllustration"/>
            <xs:enumeration value="ISHPublication"/>
            <xs:enumeration value="ISHReference"/>
            <xs:enumeration value="ISHQuery"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishfields">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishfield"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishfield">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="xs:string">
          <xs:attribute name="name" use="required">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:maxLength value="255"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name="level" use="required">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value="none"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name="ishvaluetype" use="optional">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value=""/>
                <xs:enumeration value="value"/>
                <xs:enumeration value="element"/>
                <xs:enumeration value="id"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>
</xs:schema>

Example

<ishfolder ishfolderref="3222" ishfoldertype="ISHNone">
  <ishfields>
    <ishfield name="FNAME" level="none">General</ishfield>
    <ishfield name="FDOCUMENTTYPE" level="none">None</ishfield>
    <ishfield name="CREATED-ON" level="none">05/04/2002 15:45:06</ishfield>
    <ishfield name="MODIFIED-ON" level="none">25/06/2008 13:42:32</ishfield>
    <ishfield name="FISHQUERY" level="none" />
    <ishfield name="FUSERGROUP" level="none" />
    <ishfield name="READ-ACCESS" level="none" />
  </ishfields>
  <ishfolder ishfolderref="9193" ishfoldertype="ISHQuery">
    <ishfields>
      <ishfield name="FNAME" level="none">Smart Folders</ishfield>
      <ishfield name="FDOCUMENTTYPE" level="none">Query Folder</ishfield>
      <ishfield name="CREATED-ON" level="none">17/11/2005 13:49:52</ishfield>
      <ishfield name="MODIFIED-ON" level="none">09/05/2008 10:03:48</ishfield>
      <ishfield name="FISHQUERY" level="none">&lt;ishfolderquery&gt;
&lt;!--Metadata Query --&gt;
&lt;ishfields&gt;
&lt;ishfield name="CREATED-ON" level="logical" ishoperator="greaterthan"&gt;01/01/2999&lt;/ishfield&gt;
&lt;/ishfields&gt;
&lt;/ishfolderquery&gt;</ishfield>
      <ishfield name="FUSERGROUP" level="none" />
      <ishfield name="READ-ACCESS" level="none" />
    </ishfields>
  </ishfolder>
  <ishfolder ishfolderref="11869" ishfoldertype="ISHNone">
    <ishfields>
      <ishfield name="FNAME" level="none">Customer Specific</ishfield>
      <ishfield name="FDOCUMENTTYPE" level="none">None</ishfield>
      <ishfield name="CREATED-ON" level="none">03/08/2006 12:09:28</ishfield>
      <ishfield name="MODIFIED-ON" level="none">21/12/2006 09:14:54</ishfield>
      <ishfield name="FISHQUERY" level="none" />
      <ishfield name="FUSERGROUP" level="none">Default Department</ishfield>
      <ishfield name="READ-ACCESS" level="none" />
    </ishfields>
  </ishfolder>
  <ishfolder ishfolderref="12887" ishfoldertype="ISHNone">
    <ishfields>
      <ishfield name="FNAME" level="none">__TestData</ishfield>
      <ishfield name="FDOCUMENTTYPE" level="none">None</ishfield>
      <ishfield name="CREATED-ON" level="none">28/11/2006 15:54:45</ishfield>
      <ishfield name="MODIFIED-ON" level="none">05/06/2008 11:26:47</ishfield>
      <ishfield name="FISHQUERY" level="none" />
      <ishfield name="FUSERGROUP" level="none" />
      <ishfield name="READ-ACCESS" level="none" />
    </ishfields>
  </ishfolder>
  <ishfolder ishfolderref="14182" ishfoldertype="ISHModule">
    <ishfields>
      <ishfield name="FNAME" level="none">FAQ's</ishfield>
      <ishfield name="FDOCUMENTTYPE" level="none">Module</ishfield>
      <ishfield name="CREATED-ON" level="none">24/04/2007 12:14:02</ishfield>
      <ishfield name="MODIFIED-ON" level="none">06/11/2007 10:22:11</ishfield>
      <ishfield name="FISHQUERY" level="none" />
      <ishfield name="FUSERGROUP" level="none">Default Department</ishfield>
      <ishfield name="READ-ACCESS" level="none" />
    </ishfields>
  </ishfolder>
  <ishfolder ishfolderref="15573" ishfoldertype="ISHNone">
    <ishfields>
      <ishfield name="FNAME" level="none">__MyTestFolder</ishfield>
      <ishfield name="FDOCUMENTTYPE" level="none">None</ishfield>
      <ishfield name="CREATED-ON" level="none">09/01/2008 10:59:44</ishfield>
      <ishfield name="MODIFIED-ON" level="none">28/01/2008 11:50:09</ishfield>
      <ishfield name="FISHQUERY" level="none" />
      <ishfield name="FUSERGROUP" level="none">Default Department</ishfield>
      <ishfield name="READ-ACCESS" level="none" />
    </ishfields>
  </ishfolder>
  <ishfolder ishfolderref="16363" ishfoldertype="ISHNone">
    <ishfields>
      <ishfield name="FNAME" level="none">R&amp;D</ishfield>
      <ishfield name="FDOCUMENTTYPE" level="none">None</ishfield>
      <ishfield name="CREATED-ON" level="none">21/02/2008 10:43:30</ishfield>
      <ishfield name="MODIFIED-ON" level="none">21/02/2008 10:47:57</ishfield>
      <ishfield name="FISHQUERY" level="none" />
      <ishfield name="FUSERGROUP" level="none" />
      <ishfield name="READ-ACCESS" level="none" />
    </ishfields>
  </ishfolder>
</ishfolder>