doc/api/reference/suggestions.rst

   1 Suggestions API
   2 ===============
   3
   4 Retrieve Suggested Podcasts
   5 ---------------------------
   6
   7 ..  http:get:: /suggestions/(int:number).(format)
   8     :synopsis: retrieve suggested podcasts
   9
  10     * Requires HTTP authentication
  11     * Since 1.0
  12
  13     **Example request**:
  14
  15     .. sourcecode:: http
  16
  17         GET /suggestions/10.opml
  18
  19     **Example response**:
  20
  21     .. sourcecode:: http
  22
  23         HTTP/1.1 200 OK
  24
  25         [
  26           {
  27            "website": "http://www.linuxgeekdom.com",
  28            "mygpo_link": "http://gpodder.net/podcast/64439",
  29            "description": "Linux Geekdom",
  30            "subscribers": 0,
  31            "title": "Linux Geekdom",
  32            "author": "aj@linuxgeekdom.com (A.J. Stringham)",
  33            "url": "http://www.linuxgeekdom.com/rssmp3.xml",
  34            "logo_url": null
  35          },
  36          {
  37            "website": "http://goinglinux.com",
  38            "mygpo_link": "http://gpodder.net/podcast/11171",
  39            "description": "Going Linux",
  40            "subscribers": 571,
  41            "title": "Going Linux",
  42            "author": "Larry Bushey",
  43            "url": "http://goinglinux.com/mp3podcast.xml",
  44            "logo_url": "http://goinglinux.com/images/GoingLinux80.png"
  45          }]
  46
  47     :param number: the maximum number of podcasts to return
  48     :param format: see :ref:`formats`
  49     :query jsonp: function name for the JSONP format (since 2.8)
  50
  51     Download a list of podcasts that the user has not yet subscribed to (by
  52     checking all server-side subscription lists) and that might be
  53     interesting to the user based on existing subscriptions (again on all
  54     server-side subscription lists).
  55
  56     The TXT format is a simple URL list (one URL per line), and the OPML file
  57     is a "standard" OPML feed. The JSON format looks as follows:
  58
  59     The server does not specify the "relevance" for the podcast suggestion, and
  60     the client application SHOULD filter out any podcasts that are already
  61     added to the client application but that the server does not know about yet
  62     (although this is just a suggestion for a good client-side UX).