User:Ommina

From AniDB
Revision as of 08:56, 14 June 2011 by Ommina (talk | contribs) (N)
Jump to navigation Jump to search

--> Edit FILE docs to include MyList data block <--

CATEGORY: Retrieve Category Data

UPDATED: Get List of Updated Anime IDs

Returns a list of AniDB anime ids of anime that have been updated in in a given time frame, ordered by descending date.

Command String:

  • UPDATED entity=1&[age={int4 id}|time={int4 date}]

Possible Replies:

  • 243 UPDATED

{int entity}|{int total count}|{int last update date}|{list aid}

  • 343 NO UPDATES

Info:

  • entity is always 1
  • Either age OR time can be specified, but not both
  • age is specified in days.
    • eg: age=30 requests a list of aid values of anime that have changed in the past 30 days
  • time is specified in unix time.
    • eg: time=1264982400 requests a list of aid values of anime that have changed since 2010-02-01
  • A maximum of 200 values will be returned
  • count specifies the total number of items found for the given time period. In short, if this value is great than 200, you have not retrieved all applicable ids.
  • last update date will contain the AniDB update time of the last aid to appear on the list

An anime will be considered updated if:

  • 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 episode for the anime is added, or delete (but NOT edited!) ( --> But perhaps airdate changes should <-- )
  • An episode title is added, edited, or delete
  • An anime category is added, or deleted (but NOT edited: eg, weight change)
  • An anime relation is added, or deleted


REVIEW: Get Anime Review

Retrieves the review scores and text for an anime review. Like ANIMEDESC, it will likely take multiple calls to this comment to retrieve a complete review - almost all reviews will overflow the size limits of a UDP packet.

Command String:

  • REVIEW rid={int4 id}

Possible Replies:

  • 234 REVIEW
{int4 current part}|{int4 max parts}|{int4 review id}|{int4 author uid}|{int4 score_animation}|{int4 score_sound}|{int4 score_story}|{int4 score_character}|{int4 score_value}|{int4 score_enjoyment}|{str review_text}
  • 234 REVIEW
{int4 current part}|{int4 max parts}|{str review_text}
  • 334 NO SUCH REVIEW

Info:

  • IDs and scores are returned with part zero only. Parts one through max exclude the scores and return the text block only.



[Maybe exchange author uid for author name. Or a uid->name lookup via USER?]

WISHLIST: Retrieve Wishlist Data

Retrieve wishlist data.

Command String:
full list:

  • WISHLIST

by aid:

  • WISHLIST aid={int4 aid}

by wishlist id:

  • WISHLIST lid={int4 lid}

by priority:

  • WISHLIST priority={int4 priority}


Possible Replies:

by aid, lid:

  • 223 WISHLIST
{int4 lid}|{int4 aid}|{int2 type}|{int2 priority}|{int4 fromuid}|{str comment}|{int4 adddate}


full list, by priority:

  • 229 MULTIPLE WISHLIST ITEMS
{int4 aid}|{int4 type}|{int4 priority}/n
{int4 aid}|{int4 type}|{int4 priority}/n

..repeated n times

  • 323 NO SUCH WISHLIST ITEM


Info:

  • Priority values are 0: low, 1: medium, 2: high
  • Type values are 1: to watch, 2: to get
  • Multiple items are returned in descending priority (high priority first)
  • The fromuid field represents the uid of the user that created the wishlist entry. Typically this is the actual user, but could be a buddy.

WISHLISTADD: Add Anime to Wishlist

Command String:

  • WISHLISTADD aid={int4 aid}&type={int2 type}&priority={int2 priority}[&comment={str comment}]


  • 226 WISHLIST ITEM ADDED
{int4 wishlist id}
  • 228 WISHLIST ITEM UPDATED
{int4 wishlist id}

WISHLISTDEL: Remove Anime from Wishlist

NOTIFICATION: Retrieve Notification Date

NOTIFICATIONADD: Add Anime or Group to Notify List

Command String:

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}


Possible Replies:

  • 246 NOTIFICATION ITEM ADDED
{int4 notification id}
  • 248 NOTIFICATION ITEM UPDATED
{int4 notification id}
  • 399 NO CHANGES


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

Empty Table

Byte 1
Bit Decimal Data Field
0 1 String
1 2 String
2 4 String
3 8 String
4 16 String
5 32 String
6 64 String
7 128 String