HTTP API Definition: Difference between revisions

HTTP API Definition (view source)

673 bytes added , 13 April 2008

no edit summary

340

edits

@@ Line 1: / Line 1: @@
 = Early Draft =
-== Anime Data ==
+== General Parameters ==
-Allows retrieval of non-file or episode related information for a specific anime by AID (AniDB anime id).
-=== Access ===
+These parameters apply to all HTTP XML API pages and should always be added to the request URLs.
-Base URL: TBA
 Parameters:
@@ Line 16: / Line 13: @@
 ** client version number, needs to be valid client version number for the given client identification string.
+Example:
+URL: http://.../animedb.pl?show=xmlapi&client=clientname&clienver=13&...
+== Anime Search ==
+Allows lookup of AniDB anime ids (AIDs) by anime title. Additionally AniDB also provides a daily dump with all anime titles which can be used to implement client-side searches, see: [[API]].
+=== Access ===
+Base URL: TBA
+Parameters:
+* query={string}
+** the query string to search for.
+Example:
+URL: http://.../animedb.pl?show=xmlapi&...&t=search&query=sometitle
+=== Data ===
+<code><pre>
+<?xml version="1.0" encoding="utf-8" ?>
+</pre></code>
+== Anime Data ==
+Allows retrieval of non-file or episode related information for a specific anime by AID (AniDB anime id).
+=== Access ===
+Base URL: TBA
+Parameters:
 * aid={integer} [required]
 ** AniDB anime id of the anime you want to retrieve data for.
@@ Line 21: / Line 55: @@
 Example:
-URL: http://.../animedb.pl?show=xmlapi&client=clientname&clienver=13&aid=1832
+URL: http://.../animedb.pl?show=xmlapi&...&t=anime&aid=1832