2
edits
UDP API Definition: Difference between revisions
Jump to navigation
Jump to search
m
In AUTH "Command String:" mtu parameter was missing a '=' sign.
m (In AUTH "Command String:" mtu parameter was missing a '=' sign.) |
|||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 157: | Line 157: | ||
=== AUTH: Authing to the AnimeDB === | === AUTH: Authing to the AnimeDB === | ||
'''Command String:''' | '''Command String:''' | ||
* AUTH user={str username}&pass={str password}&protover={int4 apiversion}&client={str clientname}&clientver={int4 clientversion}[&nat=1&comp=1&enc={str encoding}&mtu{int4 mtu value}&imgserver=1] | * AUTH user={str username}&pass={str password}&protover={int4 apiversion}&client={str clientname}&clientver={int4 clientversion}[&nat=1&comp=1&enc={str encoding}&mtu={int4 mtu value}&imgserver=1] | ||
'''Possible Replies:''' | '''Possible Replies:''' | ||
| Line 474: | Line 474: | ||
'''Info:''' | '''Info:''' | ||
* See: '''PUSH''' | * See: '''PUSH''' | ||
== Notification Commands == | |||
=== NOTIFICATIONADD: Add Anime or Group to Notify List === | |||
'''Command String:'''<br> | |||
by anime id: | |||
* NOTIFICATIONADD aid={int4 aid}&type={int2 type}&priority={int2 priority} | |||
by group id: | |||
* NOTIFICATIONADD gid={int4 gid}&type={int2 type}&priority={int2 priority} | |||
<br> | |||
'''Possible Replies:''' | |||
* 246 NOTIFICATION ITEM ADDED | |||
: {int4 notification id} | |||
* 248 NOTIFICATION ITEM UPDATED | |||
: {int4 notification id} | |||
* 399 NO CHANGES | |||
<br> | |||
'''Info:''' | |||
* ''Priority'' values are 0: low, 1: medium, 2: high | |||
* ''Type'' values are 0: all, 1: new, 2: group, 3: complete | |||
=== NOTIFICATIONDEL: Remove Anime or Group from Notify List === | |||
'''Command String:'''<br> | |||
by anime id: | |||
* NOTIFICATIONDEL aid={int4 aid} | |||
by group id: | |||
* NOTIFICATIONDEL gid={int4 gid} | |||
<br> | |||
'''Possible Replies:''' | |||
* 247 NOTIFICATION ITEM DELETED | |||
: {int4 notification_table}|{int4 relid} | |||
* 324 NO SUCH NOTIFICATION ITEM | |||
<br> | |||
'''Info:''' | |||
* ''notification_table'' values are 1: anime, 2: group | |||
* ''relid'' value matches the aid/gid supplied | |||
== Buddy Commands == | == Buddy Commands == | ||
| Line 848: | Line 891: | ||
<td>6</td> | <td>6</td> | ||
<td align="right">64</td> | <td align="right">64</td> | ||
<td> | <td><i>retired</i></td> | ||
</tr> | </tr> | ||
<tr bgcolor="#eeeeee"> | <tr bgcolor="#eeeeee"> | ||
<td>5</td> | <td>5</td> | ||
<td align="right">32</td> | <td align="right">32</td> | ||
<td> | <td><i>retired</i></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>4</td> | <td>4</td> | ||
<td align="right">16</td> | <td align="right">16</td> | ||
<td> | <td><i>retired</i></td> | ||
</tr> | </tr> | ||
<tr bgcolor="#eeeeee"> | <tr bgcolor="#eeeeee"> | ||
| Line 1,662: | Line 1,705: | ||
> GROUP gid=7091&s=bunny | > GROUP gid=7091&s=bunny | ||
< 250 GROUP | < 250 GROUP | ||
7091|832|1445|43|566|Frostii|Frostii|#frostii|irc.rizon.net|http://frostii.com|15844.jpg|1228089600|0|1|1301875200|1304222640|7255,1'3097,4'748,4'8106,1'8159,2'8402,1'8696,1'9022,1 | 7091|832|1445|43|566|Frostii|Frostii|#frostii|irc.rizon.net|<nowiki>http://frostii.com</nowiki>|15844.jpg|1228089600|0|1|1301875200|1304222640|7255,1'3097,4'748,4'8106,1'8159,2'8402,1'8696,1'9022,1 | ||
---- | ---- | ||
| Line 1,730: | Line 1,773: | ||
* A change is made to the anime record itself | * A change is made to the anime record itself | ||
* An ''main'' or ''official'' anime title is added, edited, or deleted (not ''short'' or ''synonym'') | * An ''main'' or ''official'' anime title is added, edited, or deleted (not ''short'' or ''synonym'') | ||
* An episode for the anime is added, or | * An episode for the anime is added, or deleted (but NOT edited!) | ||
* An episode title is added, edited, or | * An episode title is added, edited, or deleted | ||
* An anime relation is added, or deleted | * An anime relation is added, or deleted | ||
| Line 1,763: | Line 1,806: | ||
'''States:''' | '''States:''' | ||
0 - unknown - state is unknown or the user doesn't want to provide this information | 0 - unknown - state is unknown or the user doesn't want to provide this information | ||
1 - | 1 - internal storage - the file is stored on hdd (but is not shared) | ||
2 - | 2 - external storage - the file is stored on cd/dvd/... | ||
3 - deleted - the file has been deleted or is not available for other reasons (i.e. reencoded) | 3 - deleted - the file has been deleted or is not available for other reasons (i.e. reencoded) | ||
4 - remote storage - the file is stored on NAS/cloud/... | |||
'''Filestates:''' (for normal files, i.e. not generic) | '''Filestates:''' (for normal files, i.e. not generic) | ||
| Line 1,785: | Line 1,829: | ||
---- | ---- | ||
=== MYLISTADD: Add file to MyList === | === MYLISTADD: Add file to MyList === | ||
The command string for MYLISTADD is made of up two blocks: a 'fileinfo' block, which limits the command to a specific file, or an 'animeinfo'/'groupinfo'/'episodeinfo' block, which can be used to specify a range of files, including generics. Additionally, a number of optional parameters can be included with either set. | The command string for MYLISTADD is made of up two blocks: a 'fileinfo' block, which limits the command to a specific file, or an 'animeinfo'/'groupinfo'/'episodeinfo' block, which can be used to specify a range of files, including generics. Additionally, a number of optional parameters can be included with either set. | ||