Developer Center

Need a Hand?

Developer Center

Feed

Overview

API resources will generally return an Atom-compatible feed with standardized metadata in the opensearch namespace.

Feed Format

<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:magnify="http://www.magnify.net/api/magnify"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
      xmlns:media="http://search.yahoo.com/mrss/">
  <id>http://example.magnify.net/api/content/user?per_page=10&amp;page=1&amp;sort=title</id>
  <link rel="self"
        href="http://example.magnify.net/api/content/user?per_page=10&amp;page=1&amp;sort=title"
        type="application/atom+xml" />
  <link rel="next"
        href="http://example.magnify.net/api/content/user?per_page=10&amp;page=1&amp;sort=title&amp;start=11"
        type="application/atom+xml" />
  <title>Videos for User Bob</title>

  <rights>Copyright 2008, Magnify Networks</rights>
  <opensearch:startIndex>1</opensearch:startIndex>

  <opensearch:itemsPerPage>10</opensearch:itemsPerPage>
  <opensearch:totalResults>33</opensearch:totalResults>
  <entry>...</entry>

Important Elements

• id: the Atom-required identifier for this feed
• opensearch:startIndex: the index of the first item displayed in this feed representation
• opensearch:itemsPerPage: the maximum number of items to display per page (may be greater than actual number of results)
• opensearch:totalResults: the approximate number of total result items for your query
• link: links to related resources, particularly next/previous page
  • self: the currently displayed feed
  • next: the next page in the result set. This link is only shown if more results are available on the next page and is the preferred method of pagination
  • previous: (not shown) the previous page in the result set, only shown if one is available