diff options
author | Yorhel <git@yorhel.nl> | 2017-04-28 11:55:48 +0200 |
---|---|---|
committer | Yorhel <git@yorhel.nl> | 2017-04-28 11:55:48 +0200 |
commit | 0c25f70821c11087863f8e20529665a08ee948d9 (patch) | |
tree | 548701f645def2e9db36597c9b74629375ff4054 /data | |
parent | 6a1b29156dc5496eb7beda5134e3cff5efd074ce (diff) |
API: Made a start on "get staff" support
Diffstat (limited to 'data')
-rw-r--r-- | data/docs/11 | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/data/docs/11 b/data/docs/11 index 56246d05..e9b41299 100644 --- a/data/docs/11 +++ b/data/docs/11 @@ -479,6 +479,21 @@ however still required.<br /> "width", integer, width of the full-size screenshot </td> </tr> + <tr class="odd"> + <td>staff</td> + <td>staff</td> + <td>array of objects</td> + <td>no</td> + <td> + (Possibly empty) list of staff related to the VN, each object has the following members:<br /> + "sid", integer, staff ID<br /> + "aid", integer, alias ID<br /> + "name", string<br /> + "original", string, possibly null<br /> + "role", string<br /> + "note", string, possibly null + </td> + </tr> </table> <p>Sorting is possible on the following fields: id, title, released, popularity, rating, votecount.</p><br /> @@ -1147,6 +1162,126 @@ however still required.<br /> </table> +:SUBSUB:get staff +<p> +Unlike other database entries, staff have more than one unique identifier.<br /> +There is the main 'staff ID', which uniquely identifies a person and is what +the staff pages on the site represent.<br /> +Additionally, every staff name and alias also has its own unique identifier, +which is referenced from other database entries to identify which alias was +used. This identifier is generally hidden on the site and aliases do not have +their own page, but the IDs are exposed in this API in order to facilitate +linking between VNs/characters and staff.<br /> +<br /> +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>id</td> + <td>-</td> + <td>integer</td> + <td>no</td> + <td>Staff ID</td> + </tr> + <tr> + <td>name</td> + <td>basic</td> + <td>string</td> + <td>no</td> + <td>Primary (romaji) staff name</td> + </tr> + <tr class="odd"> + <td>original</td> + <td>basic</td> + <td>string</td> + <td>yes</td> + <td>Primary original name</td> + </tr> + <tr> + <td>gender</td> + <td>basic</td> + <td>string</td> + <td>yes</td> + <td></td> + </tr> + <tr class="odd"> + <td>language</td> + <td>basic</td> + <td>string</td> + <td>no</td> + <td>Primary language</td> + </tr> + <tr> + <td>links</td> + <td>details</td> + <td>object</td> + <td>no</td> + <td> + External links, object has the following members:<br /> + "homepage", official homepage,<br /> + "wikipedia", title of the related article on the English wikipedia.<br /> + "twitter", name of the twitter account.<br /> + "anidb", <a href="http://anidb.net/">AniDB</a> creator ID.<br /> + All values can be <b>null</b>. + </td> + </tr> + <tr class="odd"> + <td>description</td> + <td>details</td> + <td>string</td> + <td>yes</td> + <td>Description/notes of the staff, can contain formatting codes as described in <a href="/d9.3">d9.3</a></td> + </tr> + <tr> + <td>aliases</td> + <td>aliases</td> + <td>array of arrays</td> + <td>no</td> + <td> + List of names and aliases. Each name is represented as an array with the + following elements: Alias ID, name (romaji) and the original name.<br /> + This list also includes the "primary" name. + </td> + </tr> + <tr class="odd"> + <td>main_alias</td> + <td>aliases</td> + <td>integer</td> + <td>no</td> + <td>ID of the alias that is the "primary" name of the entry</td> + </tr> +</table> +<p>Sorting is possible on the 'id' 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> </td> + </tr></thead> + <tr class="odd"> + <td>id</td> + <td>integer<br />array of integers</td> + <td>= != > >= < <=<br />= !=</td> + <td> </td> + </tr> + <tr> + <td>aid</td> + <td>integer<br />array of integers</td> + <td>=<br />=</td> + <td> </td> + </tr> +</table> + + :SUBSUB:get user <p>Returned members:</p> <table style="margin: 5px 2%; width: 95%"> @@ -1526,7 +1661,13 @@ however still required.<br /> <p> 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. + <br /><br /> </p> +<b>2017-04-28</b> <b class="grayedout">because screw version numbers</b> +<ul> + <li>Add "get staff" command</li> + <li>Add "staff" flag to "get vn" command</li> +</ul> <b>2.27</b> <ul> <li>Add "username" filter to "get user"</li> |