Merge pull request #793 from gpodder/remove-advertise
[mygpo.git] / doc / api / reference / favorites.rst
blobf92386b2c7904fbecc2cb521ac33c8f878bcda50
1 Favorites API
2 =============
5 .. _api-favorite-episodes:
7 Get Favorite Episodes
8 ---------------------
10 ..  http:get:: /api/2/favorites/(username).json
11     :synopsis: return the user's favorite episodes
13     * Requires Authentication
14     * Since 2.4 (added released in 2.6)
16     The response is a list of all favorite episodes, as they can be seen on http://gpodder.net/favorites/
18     **Example response**:
20     .. sourcecode:: http
22         HTTP/1.1 200 OK
24         [
25            {
26              "title": "TWiT 245: No Hitler For You",
27              "url": "http://www.podtrac.com/pts/redirect.mp3/aolradio.podcast.aol.com/twit/twit0245.mp3",
28              "podcast_title": "this WEEK in TECH - MP3 Edition",
29              "podcast_url": "http://leo.am/podcasts/twit",
30              "description": "[...]",
31              "website": "http://www.podtrac.com/pts/redirect.mp3/aolradio.podcast.aol.com/twit/twit0245.mp3",
32              "released": "2010-12-25T00:30:00",
33              "mygpo_link": "http://gpodder.net/episode/1046492"
34             }
35         ]
37     :param username: username for which the favorites should be returned