API Methods: audio.getList

Description

Returns all items in the site or user's audio gallery.

Authentication

This method requires authentication without user credentials.

API Version

Version 1&2

Required parameters

  • None

Optional parameters

  • audio_id :
    the id number for the audio item
  • user_id :
    the id number for the user who owns this item
  • link :
    the path to the audio file which can be appended to the end of the site url (ex. http://SITENAME/LINK)
  • genre :
    the genre of the audio item
  • artist :
    the artist of the audio item
  • composer :
    the composer of the audio item
  • description :
    a description of the audio item
  • year :
    the year associate with the audio item
  • title :
    the title of the audio item
  • total_comments :
    the total number of comments for this audio item
  • views :
    the number of times this audio item has been viewed
  • total_ratings :
    the number of times this audio file has been rated
  • average_rating :
    the average rating of this audio item
  • ss_key :
    the key of the community associated with the audio item. The list of communities is available from the communities.getList call.
  • interest_key :
    the key of a site interest associated with the audio item. The list of interests is available from the siteinterests.getList call.
  • subinterest_key :
    the key of a site sub-interest associated with the audio item. The list of interests is available from the siteinterests.getList call.

Example response

<?xml version="1.0"?>
<response status="ok" time="Fri, 18 Apr 2008 11:19:19 -0500">
    <audio_items count="2" total="4">
        <audio>
            <audio_id>115</audio_id>
            <user_id>5</user_id>

            <link>
                <![CDATA[user_multimedia_files/c534253be581dab76a436e8910ead0fa/SIGHTLINES.mp3]]>
            </link>
            <genre>
                <![CDATA[Hip-Hop]]>
            </genre>

            <artist>
                <![CDATA[Dujeous]]>
            </artist>
            <composer>
                <![CDATA[dujeous]]>
            </composer>

            <description>
                <![CDATA[Excellent]]>
            </description>
            <year>2007</year>
            <title>

                <![CDATA[test]]>
            </title>
            <total_comments>1</total_comments>
            <views>5</views>
            <total_ratings>1</total_ratings>

        </audio>
        <audio>
            <audio_id>116</audio_id>
            <user_id>8</user_id>
            <link>

                <![CDATA[user_multimedia_files/97f9f898160085e39ed73aa45ae6df0c/bi-2 - Track 16 - album - 16.mp3]]>
            </link>
            <genre>
                <![CDATA[Other]]>
            </genre>
            <artist>

                <![CDATA[bi-2]]>
            </artist>
            <composer>
                <![CDATA[bi-2]]>
            </composer>
            <description>

                <![CDATA[Not Available]]>
            </description>
            <year>2007</year>
            <title>
                <![CDATA[bi-2]]>

            </title>
            <total_comments>1</total_comments>
            <views>5</views>
            <total_ratings>2</total_ratings>

        </audio>
    </audio_items>
</response>