aboutsummaryrefslogtreecommitdiff
path: root/subsonic-site/src/main/webapp/api-search.jsp
diff options
context:
space:
mode:
authorScott Jackson <daneren2005@gmail.com>2012-07-02 21:24:02 -0700
committerScott Jackson <daneren2005@gmail.com>2012-07-02 21:24:02 -0700
commita1a18f77a50804e0127dfa4b0f5240c49c541184 (patch)
tree19a38880afe505beddb5590379a8134d7730a277 /subsonic-site/src/main/webapp/api-search.jsp
parentb61d787706979e7e20f4c3c4f93c1f129d92273f (diff)
downloaddsub-a1a18f77a50804e0127dfa4b0f5240c49c541184.tar.gz
dsub-a1a18f77a50804e0127dfa4b0f5240c49c541184.tar.bz2
dsub-a1a18f77a50804e0127dfa4b0f5240c49c541184.zip
Initial Commit
Diffstat (limited to 'subsonic-site/src/main/webapp/api-search.jsp')
-rw-r--r--subsonic-site/src/main/webapp/api-search.jsp65
1 files changed, 65 insertions, 0 deletions
diff --git a/subsonic-site/src/main/webapp/api-search.jsp b/subsonic-site/src/main/webapp/api-search.jsp
new file mode 100644
index 00000000..f74fba2e
--- /dev/null
+++ b/subsonic-site/src/main/webapp/api-search.jsp
@@ -0,0 +1,65 @@
+<h2 class="div"><a name="search"></a>search</h2>
+
+<p>
+ <code>http://your-server/rest/search.view</code>
+ <br>Since <a href="#versions">1.0.0</a>
+ <br>Deprecated since <a href="#versions">1.4.0</a>, use <code>search2</code> instead.
+</p>
+
+<p>
+ Returns a listing of files matching the given search criteria. Supports paging through the result.
+</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>artist</code></td>
+ <td>No</td>
+ <td></td>
+ <td>Artist to search for.</td>
+ </tr>
+ <tr>
+ <td><code>album</code></td>
+ <td>No</td>
+ <td></td>
+ <td>Album to searh for.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>title</code></td>
+ <td>No</td>
+ <td></td>
+ <td>Song title to search for.</td>
+ </tr>
+ <tr>
+ <td><code>any</code></td>
+ <td>No</td>
+ <td></td>
+ <td>Searches all fields.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>count</code></td>
+ <td>No</td>
+ <td>20</td>
+ <td>Maximum number of results to return.</td>
+ </tr>
+ <tr>
+ <td><code>offset</code></td>
+ <td>No</td>
+ <td>0</td>
+ <td>Search result offset. Used for paging.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>newerThan</code></td>
+ <td>No</td>
+ <td></td>
+ <td>Only return matches that are newer than this. Given as milliseconds since 1970.</td>
+ </tr>
+</table>
+<p>
+ Returns a <code>&lt;subsonic-response&gt;</code> element with a nested <code>&lt;searchResult&gt;</code>
+ element on success. <a href="http://subsonic.svn.sourceforge.net/viewvc/subsonic/trunk/subsonic-main/src/main/webapp/xsd/searchResult_example_1.xml?view=markup">Example</a>.
+</p>