API Methods: forums.getList



Description

Returns a list of the available site forums.

Authentication

This method requires authentication without user credentials.

Required parameters

  • None

Optional parameters

  • forum_id :
    the id number of the forum
  • name :
    the name of the forum
  • description :
    a brief description of the forum
  • thread_count :
    the total number of threads in this forum and all children forums

Global parameters

  • None :
    This method returns nested data and as such does not take the normal global parameters.

Example response

<?xml version="1.0"?>
<response status="ok" time="Mon, 21 Apr 2008 14:38:34 -0500">
    <forums count="5" total="5">
        <forum>
            <forum_id>1</forum_id>
            <name>

                <![CDATA[Root]]>
            </name>
            <description/>
            <thread_count>6</thread_count>
            <children>

                <![CDATA[Yes]]>
            </children>
            <forums count="4">
                <forum>
                    <forum_id>5</forum_id>

                    <name>
                        <![CDATA[Social Networking Basics]]>
                    </name>
                    <description>
                        <![CDATA[Learn the basics]]>
                    </description>

                    <thread_count>3</thread_count>
                    <children>
                        <![CDATA[No]]>
                    </children>
                </forum>

                <forum>
                    <forum_id>6</forum_id>
                    <name>
                        <![CDATA[Small World Labs]]>
                    </name>

                    <description>
                        <![CDATA[News &amp; info about SWL]]>
                    </description>
                    <thread_count>0</thread_count>
                    <children>

                        <![CDATA[No]]>
                    </children>
                </forum>
                <forum>
                    <forum_id>7</forum_id>

                    <name>
                        <![CDATA[Business Social Networking]]>
                    </name>
                    <description/>
                    <thread_count>0</thread_count>

                    <children>
                        <![CDATA[No]]>
                    </children>
                </forum>
                <forum>
                    <forum_id>8</forum_id>

                    <name>
                        <![CDATA[General Questions]]>
                    </name>
                    <description/>
                    <thread_count>0</thread_count>

                    <children>
                        <![CDATA[No]]>
                    </children>
                </forum>
            </forums>
        </forum>

    </forums>
</response>