From 0c25f70821c11087863f8e20529665a08ee948d9 Mon Sep 17 00:00:00 2001 From: Yorhel Date: Fri, 28 Apr 2017 11:55:48 +0200 Subject: API: Made a start on "get staff" support --- data/docs/11 | 141 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 141 insertions(+) (limited to 'data') 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.
"width", integer, width of the full-size screenshot + + staff + staff + array of objects + no + + (Possibly empty) list of staff related to the VN, each object has the following members:
+ "sid", integer, staff ID
+ "aid", integer, alias ID
+ "name", string
+ "original", string, possibly null
+ "role", string
+ "note", string, possibly null + +

Sorting is possible on the following fields: id, title, released, popularity, rating, votecount.


@@ -1147,6 +1162,126 @@ however still required.
+:SUBSUB:get staff +

+Unlike other database entries, staff have more than one unique identifier.
+There is the main 'staff ID', which uniquely identifies a person and is what +the staff pages on the site represent.
+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.
+
+Returned members:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MemberFlagTypenullDescription
id-integernoStaff ID
namebasicstringnoPrimary (romaji) staff name
originalbasicstringyesPrimary original name
genderbasicstringyes
languagebasicstringnoPrimary language
linksdetailsobjectno + External links, object has the following members:
+ "homepage", official homepage,
+ "wikipedia", title of the related article on the English wikipedia.
+ "twitter", name of the twitter account.
+ "anidb", AniDB creator ID.
+ All values can be null. +
descriptiondetailsstringyesDescription/notes of the staff, can contain formatting codes as described in d9.3
aliasesaliasesarray of arraysno + List of names and aliases. Each name is represented as an array with the + following elements: Alias ID, name (romaji) and the original name.
+ This list also includes the "primary" name. +
main_aliasaliasesintegernoID of the alias that is the "primary" name of the entry
+

Sorting is possible on the 'id' field.


+ +

The following filters are recognised:

+ + + + + + + + + + + + + + + + + + + +
FieldValueOperators 
idinteger
array of integers		= != > >= < <=
= !=		 
aidinteger
array of integers		=
=		 
+ + :SUBSUB:get user

Returned members:

@@ -1526,7 +1661,13 @@ however still required.

This section lists the changes made in each version of the VNDB code. Check out the announcements board for more information about updates. +

+2017-04-28because screw version numbers +2.27