diff options
Diffstat (limited to 'data/docs')
-rw-r--r-- | data/docs/11 | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/data/docs/11 b/data/docs/11 index 70c5b2f5..99c727d7 100644 --- a/data/docs/11 +++ b/data/docs/11 @@ -402,6 +402,150 @@ however still required.<br /> novel and its releases. Note that the algorithm of this search may change and that it can use a different algorithm than the search function on the website. </td> +</table><br /><br /> + +<b>Returned object members for the 'release' type:</b> +<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>Release ID</td> + </tr> + <tr> + <td>title</td> + <td>basic</td> + <td>string</td> + <td>no</td> + <td>Release title (romaji)</td> + </tr> + <tr class="odd"> + <td>original</td> + <td>basic</td> + <td>string</td> + <td>yes</td> + <td>Original/official title of the release.</td> + </tr> + <tr> + <td>released</td> + <td>basic</td> + <td>date (string)</td> + <td>yes</td> + <td>Release date</td> + </tr> + <tr class="odd"> + <td>type</td> + <td>basic</td> + <td>string</td> + <td>no</td> + <td>"complete", "partial" or "trial"</td> + </tr> + <tr> + <td>patch</td> + <td>basic</td> + <td>boolean</td> + <td>no</td> + <td> </td> + </tr> + <tr class="odd"> + <td>freeware</td> + <td>basic</td> + <td>boolean</td> + <td>no</td> + <td> </td> + </tr> + <tr> + <td>doujin</td> + <td>basic</td> + <td>boolean</td> + <td>no</td> + <td> </td> + </tr> + <tr class="odd"> + <td>languages</td> + <td>basic</td> + <td>array of strings</td> + <td>no</td> + <td> </td> + </tr> + <tr> + <td>website</td> + <td>details</td> + <td>string</td> + <td>yes</td> + <td>Official website URL</td> + </tr> + <tr class="odd"> + <td>notes</td> + <td>details</td> + <td>string</td> + <td>yes</td> + <td>Random notes, can contain formatting codes as described in <a href="/d9.3">d9.3</a></td> + </tr> + <tr> + <td>minage</td> + <td>details</td> + <td>integer</td> + <td>yes</td> + <td>Age rating, 0 = all ages.</td> + </tr> + <tr class="odd"> + <td>gtin</td> + <td>details</td> + <td>string</td> + <td>yes</td> + <td>JAN/UPC/EAN code. This is actually an integer, but formatted as a string to avoid an overflow on 32bit platforms.</td> + </tr> + <tr> + <td>catalog</td> + <td>details</td> + <td>string</td> + <td>yes</td> + <td>Catalog number.</td> + </tr> + <tr class="odd"> + <td>platforms</td> + <td>details</td> + <td>array of strings</td> + <td>no</td> + <td>Empty array when platform is unknown.</td> + </tr> + <tr> + <td>media</td> + <td>details</td> + <td>array of objects</td> + <td>no</td> + <td> + Objects have the following two members:<br /> + "medium", string<br /> + "qty", integer, the quantity. <b>null</b> when it is not applicable for the medium.<br /> + An empty array is returned when the media are unknown. + </td> + </tr> +</table> + +<b>Accepted filters for the 'release' type:</b> +<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> </table> |