subsonic-site/src/main/webapp/api-createShare.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

<h2 class="div"><a name="createShare"></a>createShare</h2>
<p>
    <code>http://your-server/rest/createShare.view</code>
    <br>Since <a href="#versions">1.6.0</a>
</p>
<p>
    Creates a public URL that can be used by anyone to stream music or video from the Subsonic server.  The URL is short and
    suitable for posting on Facebook, Twitter etc. Note: The user must be authorized to share (see Settings &gt; Users
    &gt; User is allowed to share files with anyone).
</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>id</code></td>
        <td>Yes</td>
        <td></td>
        <td>ID of a song, album or video to share. Use one <code>id</code> parameter for each entry to share.</td>
    </tr>
    <tr>
        <td><code>description</code></td>
        <td>No</td>
        <td></td>
        <td>A user-defined description that will be displayed to people visiting the shared media.</td>
    </tr>
    <tr class="table-altrow">
        <td><code>expires</code></td>
        <td>No</td>
        <td></td>
        <td>The time at which the share expires. Given as milliseconds since 1970.</td>
    </tr>
</table>
<p>
    Returns a <code>&lt;subsonic-response&gt;</code> element with a nested <code>&lt;shares&gt;</code>
    element on success, which in turns contains a single <code>&lt;share&gt;</code> element for the newly created share.
    <a href="http://subsonic.svn.sourceforge.net/viewvc/subsonic/trunk/subsonic-main/src/main/webapp/xsd/shares_example_1.xml?view=markup">Example</a>.
</p>