subsonic-site/src/main/webapp/api-updatePlaylist.jsp


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

<h2 class="div"><a name="updatePlaylist"></a>updatePlaylist</h2>

<p>
    <code>http://your-server/rest/updatePlaylist.view</code>
    <br>Since <a href="#versions">1.8.0</a>
</p>

<p>
    Updates a playlist. Only the owner of a playlist is allowed to update it.
</p>
<table width="100%" class="bottomspace">
    <tr>
        <th class="param-heading">Parameter</th>
        <th class="param-heading">Required</th>
        <th class="param-heading">Default</th>
        <th class="param-heading">Comment</th>
    </tr>
    <tr class="table-altrow">
        <td><code>playlistId</code></td>
        <td>Yes</td>
        <td></td>
        <td>The playlist ID.</td>
    </tr>
    <tr>
        <td><code>name</code></td>
        <td>No</td>
        <td></td>
        <td>The human-readable name of the playlist.</td>
    </tr>
    <tr class="table-altrow">
        <td><code>comment</code></td>
        <td>No</td>
        <td></td>
        <td>The playlist comment.</td>
    </tr>
    <%--TODO: Add later--%>
    <%--<tr>--%>
        <%--<td><code>usernameToAdd</code></td>--%>
        <%--<td>No</td>--%>
        <%--<td></td>--%>
        <%--<td>Allow this user to listen to this playlist. Multiple parameters allowed.</td>--%>
    <%--</tr>--%>
    <%--<tr class="table-altrow">--%>
        <%--<td><code>usernameToRemove</code></td>--%>
        <%--<td>No</td>--%>
        <%--<td></td>--%>
        <%--<td>Disallow this user to listen to this playlist. Multiple parameters allowed.</td>--%>
    <%--</tr>--%>
    <tr>
        <td><code>songIdToAdd</code></td>
        <td>No</td>
        <td></td>
        <td>Add this song with this ID to the playlist. Multiple parameters allowed.</td>
    </tr>
    <tr class="table-altrow">
        <td><code>songIndexToRemove</code></td>
        <td>No</td>
        <td></td>
        <td>Remove the song at this position in the playlist. Multiple parameters allowed.</td>
    </tr>
</table>
<p>
    Returns an empty <code>&lt;subsonic-response&gt;</code> element on success.
</p>