546
edits
UDP API Definition: Difference between revisions
m
no edit summary
Epoximator (talk | contribs) |
Epoximator (talk | contribs) mNo edit summary |
||
| Line 1: | Line 1: | ||
{{TOCright}} | |||
'''Author:''' [[User:Exp|Exp]]<br> | '''Author:''' [[User:Exp|Exp]]<br> | ||
'''Version:''' 0.03 - 13.01.2006 <br> | '''Version:''' 0.03 - 13.01.2006 <br> | ||
'''Version number used for protover parameter:''' "3" | '''Version number used for protover parameter:''' "3" | ||
'''IMPORTANT NOTICE FOR DEVELOPERS:''' | |||
* Register _your_ client [http://anidb.info/perl-bin/animedb.pl?show=client here] and post relevant information [[UDP_Clients|here]] '''RIGHT NOW'''. Thanks! | |||
If you want to recieve a notification mail every time a new version of the API Specs is released or want to have your client linked/hosted by anidb drop [[User:Exp|Exp]] a line. | * If you want to recieve a notification mail every time a new version of the API Specs is released or want to have your client linked/hosted by anidb drop [[User:Exp|Exp]] a line. | ||
* If you have suggestions for improvements or new features use [[UDP_API_DEV]]. | |||
== Formats used in this Spec == | == Formats used in this Spec == | ||
| Line 49: | Line 16: | ||
:* int2 - 2byte Integer (in string representation) | :* int2 - 2byte Integer (in string representation) | ||
:* int4 - 4byte Integer (in string representation) | :* int4 - 4byte Integer (in string representation) | ||
:* str - String (NOTE: might be as long as 5000 bytes !!!, via udp api no string is likely to extend > | :* str - String (NOTE: might be as long as 5000 bytes !!!, via udp api no string is likely to extend >1400 bytes) | ||
=== Content Encoding === | === Content Encoding === | ||
| Line 91: | Line 58: | ||
}} | }} | ||
{{eyecatch|NOTE:| | {{eyecatch|NOTE:| | ||
Due to the length contraints of an UDP package API replies might be truncated at the end if they exceed the max. length of ~ | Due to the length contraints of an UDP package API replies might be truncated at the end if they exceed the max. length of ~1400 bytes. Such events are not handled specially, the data will simply be sent truncated. | ||
}} | }} | ||
| Line 971: | Line 938: | ||
ANIDB_OUT_OF_SERVICE =601, //C | ANIDB_OUT_OF_SERVICE =601, //C | ||
API_VIOLATION =666, //C | API_VIOLATION =666, //C | ||
</pre> | |||
== Changelog == | |||
<pre> | |||
0.03 - 13.01.2006 | |||
ANIME, EPISODE, GROUP, STATS, TOP, UPTIME, MYLISTSTATS, VOTE and RANDOM commands added | |||
it is now possible to use html escaped code in mylist fields, and '=' | |||
updated epno in default file name (for new specials) | |||
... (a lot of stuff already forgotten) | |||
0.02c - 10.10.2004 | |||
LOGOUT now requires the session string too | |||
Note on 6xx server errors and tags added | |||
0.02b - 14.08.2004 | |||
503 INVALID SESSION changed to 506 INVALID SESSION | |||
BUGFIX: 200 message on AUTH did not contain a session key | |||
BUGFIX: 1 internal bug fixed | |||
0.02 - 13.08.2004 | |||
new session key needs to be send with each command | |||
random udp ports no longer required | |||
FILE, MYLIST, MYLISTDEL, MYLISTADD commands added | |||
Some textparts of return values changed | |||
additional documentation added | |||
check the caching section! | |||
0.01b - 12.08.2004 | |||
added NOTIFYLIST, NOTIFYGET, NOTIFYACK, SENDMSG commands | |||
0.01 - 10.08.2004 | |||
initial version | |||
</pre> | </pre> | ||
[[Category: Development]] | [[Category: Development]] | ||