UDP API DEV: Difference between revisions

UDP API DEV (view source)

Revision as of 18:52, 28 April 2006

2,102 bytes removed , 28 April 2006

m

clean

Epoximator

546

edits

@@ Line 7: / Line 7: @@
 == Data Commands ==
 === [[UDP_API_Definition#ANIME:_Retrieve_Anime_Data|ANIME]] ===
-'''Possible Replies:'''
-* XXX ANIME BEST MATCH
-: ...
-'''Comments:'''<br>
-I'd like this command to cope with a couple of different encodings when passed a title, and be explicit over whether it finds only one result or does a best-match guess. --[[User:Rar|Rar]] 04:51, 30 Oct 2005 (CET)
-: On second thought, is a wide search really wanted or is 'WHERE lower(name)=' good enough?. About encodings, do you care to elaborate? --[[User:Epoximator|Epoximator]] 18:24, 25 November 2005 (CET)
-::Oh, specifically, I'd like anime lookups to be able to take sjis/utf8 rather than just html escaped ascii, as an option. While all real programming languages have trivial encoding switching: <code>string.decode('sjis').encode('ascii','xmlcharrefreplace')</code> some that might find a use for udp access to anidb (such as the dire mirc scripting language), do not, so dealing with it serverside would be nice. --[[User:Rar|Rar]] 01:28, 29 January 2006 (CET)
 === [[UDP_API_Definition#ANIMEINFO:_Retrieve_Anime_Data|ANIMEINFO]] ===
@@ Line 20: / Line 13: @@
 '''Replies:'''
-* This command should return all missing informations from ANIME, sush as companies, external links (ANN, ...), awards, ...
+* This command should return all missing informations from ANIME, sush as companies, external links (ANN, ...), awards, ...--[[User:Darsh|Darsh]] 12:10, 19 April 2006 (CEST)
+: OK. But included in ANIME with an argument, like acode.--[[User:Epoximator|Epoximator]] 00:18, 21 April 2006 (CEST)
---[[User:Darsh|Darsh]] 12:10, 19 April 2006 (CEST)
-: OK. But included in ANIME with an argument, like acode.--[[User:Epoximator|Epoximator]] 00:18, 21 April 2006 (CEST)
 === [[UDP_API_Definition#EPISODE:_Retrieve_Episode_Data|EPISODE]] ===
 === [[UDP_API_Definition#GROUP:_Retrieve_Group_Data|GROUP]] ===
-I obtain:
-|851|665|109|1004|Zhentarim DivX|zx|#zhentarim|irc.chatsociety.net|http://www.zhentarim.net/
-The irc channel and irc server are on two fields, and this is not documented. --[[User:Darsh|Darsh]] 12:14, 28 April 2006 (CEST)
 === [[UDP_API_Definition#FILE:_Retrieve_File_Data|FILE]] ===
@@ Line 37: / Line 25: @@
 : fid|state
 '''Comments:'''<br>
-Pass a list of fields (limit e.g. 10 entries)
+Selection by anime, group and episode number is not unique. As an example: FILE aid=22&gid=41&tag=tag0002&epno=1 <br>
-and return content. This makes it possible to request new fields in the database without
-breaking API for older clients.
-On updates, only the list of possible fields
-need to be extendet. -- --[[User:Dinoex|Dinoex]]
-: I think it's a good idea. Modified a bit. --[[User:Epoximator|Epoximator]] 13:38, 26 November 2005 (CET)
-'''Comments:'''<br>
-Selection by anime, group and episode number is not unique.
-As an example: FILE aid=22&gid=41&tag=tag0002&epno=1 <br>
 This commands always return only the first match. --[[User:Darsh|Darsh]] 12:10, 19 April 2006 (CEST)
 : Can be fixed with MULTIPLE FILES FOUND, or just return the latest version. Maybe selectable with an argument.--[[User:Epoximator|Epoximator]] 00:18, 21 April 2006 (CEST)
-'''Comments:'''<br>
 Add {str anidbfilename} to fcode?  --[[User:Darsh|Darsh]] 10:56, 25 April 2006 (CEST)
@@ Line 167: / Line 143: @@
 === ENCODING ===
-Sets preferred encoding.
+Sets preferred encoding per session.
 '''Command String:'''
@@ Line 178: / Line 154: @@
 '''Info:'''
 * Supported encodings: http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html
-* Default: ASCII.
+* Default: ASCII. Reset on logout.
-'''Comments:'''
-: This could be included in the AUTH command or an environment command that includes options for encryption, encoding and compression. (In response to rar's request.) --[[User:Epoximator|Epoximator]] 11:48, 31 January 2006 (CET)
-: This should definetly become an additional, optional parameter of the AUTH command. There is really no reason why this should be an extra command. It just means two more UDP packets overhead on each client connection. --[[User:Exp|Exp]] 05:28, 8 February 2006 (CET)
-[[Category:Development]]
-: I think epoxi was more thinking of this command as setting a session state flag, like a parameter in AUTH would, rather than being sent prior to *every* command, which would of course be silly. I see no reason not to have both. --[[User:Rar|Rar]] 16:21, 10 February 2006 (CET)
 === [[UDP_API_Definition#AUTH:_Authing_to_the_AnimeDB|AUTH]] : extend ===
@@ Line 201: / Line 171: @@
 '''Notification Packet Format:'''
    XXX {int4 notify_packet_id} NOTIFICATION
-   {int4 time_online}|{int4 comment}
+   {int4 time offline}|{int4 comment}
 '''Info:'''
-* time_online is time the API should be up again, 0 if indefinite (client can direct user to the anidb site for status updates)
+* Time offline is the time in minutes the API will be down, 0 if indefinite (client can direct user to the anidb site for status updates).
-* comment can tell the user the reason for the API to go down and/or tell where to check for status updates
+* The comment is a short explanation for the downtime.
+* Only one datagram will be sent, and the server will not listen for replies.
+'''Comment:'''
+: Time offline and comment will most likely not be specified normally. '0|None' will be the default and should indicate restart for update. --[[User:Epoximator|Epoximator]] 20:52, 28 April 2006 (CEST)
+[[Category:Development]]