API Methods: communities.getList



Description

Returns a list of site communities

Authentication

This method requires authentication without user credentials.

Required parameters

  • None

Optional parameters

  • community_id :
    the id number of the community
  • ss_key :
    the key of the community
  • community_name :
    the name of the community
  • sort_order :
    this is used to order the communities when they are displayed in a list
  • title_tag :
    the html page title for any page filtered for this community
  • meta_keywords :
    the html meta keywords for any page filtered for this community
  • meta_description :
    the html meta description for any page filtered for this community

Example response

<?xml version="1.0"?>
<response status="ok" time="Fri, 18 Apr 2008 14:02:59 -0500">
    <communities count="2" total="114">
        <community>
            <community_id>1</community_id>
            <ss_key>1</ss_key>
            <community_name>
                <![CDATA[All]]>
            </community_name>
            <sort_order>1</sort_order>
            <title_tag/>
            <meta_keywords/>
            <meta_description/>
        </community>
        <community>
            <community_id>2</community_id>
            <ss_key>2</ss_key>
            <community_name>
                <![CDATA[New Orleans]]>
            </community_name>
            <sort_order>2</sort_order>
            <title_tag>
                <![CDATA[New Orleans page title edited by pavan...]]>
            </title_tag>
            <meta_keywords>
                <![CDATA[French Quarter]]>
            </meta_keywords>
            <meta_description/>
        </community>
    </communities>
</response>