List

Overview

Resources in list will return a <feed> representing one or more playlists. When a single playlist is displayed with show, it is unrolled into a <feed> containing one or more <entry> elements representing content items, in a format similar to results returned by a content resource. Otherwise, each <entry> in the feed represents a single playlist.

Resources

show

parameters

• id (required)

example

Returns an unrolled representation of the list specified with the id parameter. The id is a 16-digit alphanumeric string, as elsewhere. You can obtain the id from the browse or user results below, any kind of entry referencing a playlist item or the URI of the playlist's Magnify page. The output format is identical to results returned by content/*, see below.

browse

parameters

• page (default: 1)
• per_page (default: 10)

example

Retrieves all publically viewable playlists from the channel. Returns pages of results conaining appropriate <link> tags to follow in order to obtain the contents of the list with show.

user

parameters

• id (required)
• page (default: 1)
• per_page (default: 10)

example

Retrieves a list of playlists owned by the user specified by the id parameter. The output and optional parameters are the same as for browse above.

Results

Feed Format

A standard feed with openseach metadata is produced, as described on the Feed page. The feed contains either playlists (for browse and user) or content items (for show) as <entry> elements.

Entry Format

When a list of content items is returned for a single playlist, the entry format is identical to that for content. When a list of playlists is returned, the entry format is as follows:

<entry>
  <link rel="self"
        href="http://example.magnify.net/api/list/show?id=LWBF0SVFZBYT93RC" />
  <link rel="alternate"
        href="http://example.magnify.net/watch/playlist/LWBF0SVFZBYT93RC" />
  <link rel="user"
        href="http://example.magnify.net/api/user/show?id=YH65RWKLY4FGYQYW" />
  <magnify:id>LWBF0SVFZBYT93RC</magnify:id>
  <updated>2008-06-13T13:21:37Z</updated>
  <title>Hoary Hedgehogs</title>

  <author>
    <name>example</name>
    <uri>http://example.magnify.net/api/user/show?id=YH65RWKLY4FGYQYW</uri>
  </author>
  <id>http://example.magnify.net/api/list/show?id=LWBF0SVFZBYT93RC</id>
  <content>Hedgehogs share their wisdom!</content>
  <media:thumbnail url="http://img.youtube.com/vi/mQmU0DczhOs/2.jpg" />

</entry>

Important Elements

link: links to relevant resources
• self: a feed containing only this entry (useful for getting individual entries from browse results)
• alternate: the Magnify-hosted page for this playlist
• user: a feed representing the user to whom this list belongs, present if the user is not Anonymous
• author: description of the user associated with this list items
  • name: the user's magnify handle or full name (whichever is available)
  • uri: a link to the feed representing the user (same as link rel=user above)
• title, list: the title and description of the playlist
• media:thumbnail: the location of the thumbnail for this playlist, given as the url attribute (generally the thumbnail for the first video in the list)
• magnify:id: the playlist's id number; valid for id=... parameters
• id: Atom-required entry id

Note

Feeds returned from list resources are generally valid Atom