4 Podcast Lists are used to collect podcasts about one topic. On the website,
5 podcast lists are available at https://gpodder.net/lists/
11 .. http:post:: /api/2/lists/(username)/create.(format)
12 :synopsis: create a new podcast list
14 * requires authenticaton
17 :query title: url-encoded title
18 :param username: username for which a new podcast list should be created
19 :param format: see :ref:`formats`
21 The list content is sent in the request body, in the format indicates by
24 The server then generates a short name for the list from the title given in
25 the Request. For example, from the title "My Python Podcasts" the name
26 "my-python-podcasts" would be generated.
28 :status 409: if the the user already has a podcast list with the
30 :status 303: the podcast list has been created at the URL given in the
31 :http:header:`Location` header
37 .. http:get:: /api/2/lists/(username).json
38 :synopsis: get a user's podcast lists
50 "title": "My Python Podcasts",
51 "name": "my-python-podcasts",
52 "web": "http://gpodder.net/user/a-user/lists/my-python-podcasts"
56 :status 200: the list of lists is returned
57 :status 404: the user was not found
63 .. http:get:: /api/2/lists/(username)/list/(listname).(format)
64 :synopsis: get a podcast list
68 :param username: username to which the list belongs
69 :param listname: name of the requested podcast list
70 :param format: see :ref:`formats`
71 :status 200: the podcast list is returned in in the requested format
72 :status 404: if the user or the list do not exist
78 .. http:put:: /api/2/lists/(username)/list/(listname).(format)
79 :synopsis: update a podcast list
81 * requires authentication
84 :param username: username to which the list belongs
85 :param listname: name of the requested podcast list
86 :param format: see :ref:`formats`
87 :status 404: if the user or the list do not exist
88 :status 204: if the podcast list has been created / updated
94 .. http:delete:: /api/2/lists/(username)/list/(listname).(format)
95 :synopsis: delete a podcast list
97 * requires authentication
100 :param username: username to which the list belongs
101 :param listname: name of the requested podcast list
102 :param format: see :ref:`formats`
103 :status 404: if the user or the list do not exist
104 :status 204: if the podcast list has been deleted