Help API: Lists

All of the endpoints in this page use the same generic list element.

XML

<list id="6">
  <dc:title>Banned Books</dc:title>
  <dc:identifier>http://localhost:3001/list/6</dc:identifier>
  <dc:description>
    <p>For political, religious, or moral reasons, all these books included in this list were banned in 
    some places of the world.</p>
    <p>Reading some of these books is a great way to understand how censorship works, and evolved in 
    our society.</p>
    <p>List of banned books 
    <br />... on Wikipedia: http://en.wikipedia.org/wiki/Banned_books
    <br />... on Google: http://books.google.com/googlebooks/banned/</p>
  </dc:description>
  <favorites>Banned Books</favorites>
  <items>Banned Books</items>
</list>
Most elements should be easy to understand, items is actually the number of items (books and user generated content) included in the list.

Endpoints

Endpoint: /lists
Formats: XML
Description: View the lists, use pagination
Parameters:

  • page: for the page number, in the root <lists> node you will find the current page and total number of pages
  • favorites: normally, only the lists with at least 2 favorites are displayed. You can change the minimum value using this parameter.
  • order: normally based on the number of favorites, use comments to order them by most discussed lists
Endpoint: /book/:id/lists
Formats: XML
Description: View in which list a book is included
Parameters:

  • order: normally the order is based on the number of favorites, use name to switch this to alphabetical order



Terms of Use | Mobile | Blog (en-fr) | Press | API | About | Help RSS