summaryrefslogtreecommitdiff
path: root/data/docs/11
diff options
context:
space:
mode:
authorYorhel <git@yorhel.nl>2013-01-03 11:16:51 +0100
committerYorhel <git@yorhel.nl>2013-01-03 11:16:51 +0100
commit633ae14c50509237f0b3d3999c890b9abc6747b4 (patch)
tree668f48e61024047ffcd72806f86d092c272b3e3d /data/docs/11
parent7ee6f2230c5ed21e74d7d10b2f464de8b3ab414e (diff)
Multi::API: Added 'get votelist'
Diffstat (limited to 'data/docs/11')
-rw-r--r--data/docs/1160
1 files changed, 57 insertions, 3 deletions
diff --git a/data/docs/11 b/data/docs/11
index 760ad283..1b46ecd2 100644
--- a/data/docs/11
+++ b/data/docs/11
@@ -235,9 +235,8 @@ however still required.<br />
</dl>
<p>
The server replies with either 'ok' (no arguments), or 'error' (see below).
- Note that logging in using a username or password is optional. While currently
- there is no difference between anonymous and user logins, future features may
- only be available when logged in with a username.
+ Note that logging in using a username or password is optional, but some
+ commands are only available when logged in.
</p>
@@ -889,6 +888,57 @@ however still required.<br />
</tr>
</table>
+:SUBSUB:get votelist
+<p>Provides access to the votes of the logged in user. As such, this command is only available when logged in as a user.</p>
+<p>Returned members:</p>
+<table style="margin: 5px 2%; width: 95%">
+ <thead><tr>
+ <td style="width: 80px">Member</td>
+ <td style="width: 50px">Flag</td>
+ <td style="width: 90px">Type</td>
+ <td style="width: 40px">null</td>
+ <td>Description</td>
+ </tr></thead>
+ <tr class="odd">
+ <td>vn</td>
+ <td>basic</td>
+ <td>integer</td>
+ <td>no</td>
+ <td>Visual Novel ID</td>
+ </tr>
+ <tr>
+ <td>vote</td>
+ <td>basic</td>
+ <td>integer</td>
+ <td>no</td>
+ <td>In the range of 10 (lowest) to 100 (highest). These are displayed on the site as a fractional number between 1 and 10.</td>
+ </tr>
+ <tr class="odd">
+ <td>added</td>
+ <td>basic</td>
+ <td>integer</td>
+ <td>no</td>
+ <td>Unix timestamp of when this vote has been added.</td>
+ </tr>
+</table>
+<p>The returned list is always sorted on the 'vn' field.</p><br />
+
+<p>The following filters are recognised:</p>
+<table style="margin: 5px 2%; width: 95%">
+ <thead><tr>
+ <td style="width: 80px">Field</td>
+ <td style="width: 90px">Value</td>
+ <td style="width: 90px">Operators</td>
+ <td>&nbsp;</td>
+ </tr></thead>
+ <tr class="odd">
+ <td>uid</td>
+ <td>integer</td>
+ <td>=</td>
+ <td>This filter must be present, and must currently must be '0' (= logged in user)</td>
+ </tr>
+</table>
+
:SUB:The 'error' response
@@ -935,6 +985,10 @@ however still required.<br />
This section lists the changes made in each version of the VNDB code.
Check out the <a href="/t/an">announcements board</a> for more information about updates.
</p>
+<b>2.23</b>
+<ul>
+ <li>Added 'get votelist'</li>
+</ul>
<b>2.15</b>
<ul>
<li>Fixed a bug with the server not allowing extra whitespace after a "get .. " command</li>