1,633
edits
HTTP API Definition: Difference between revisions
m
<tt> ... </tt> reads more nicely for parameters
Fahrenheit (talk | contribs) (→Data) |
m (<tt> ... </tt> reads more nicely for parameters) |
||
| Line 1: | Line 1: | ||
{{TOCright}} | {{TOCright}} | ||
= Early Draft = | = Early Draft = | ||
Note | {{eyecatch|Note|This is still a very early draft and has not yet been implemented!}} | ||
= General = | = General = | ||
| Line 20: | Line 21: | ||
These parameters apply to all HTTP XML API pages and should always be added to the request URLs. | These parameters apply to all HTTP XML API pages and should always be added to the request URLs. | ||
All users of the HTTP XML API need to be registered and have to provide their registered client identifier and version number on each request. For more information on client registration visit [[ | All users of the HTTP XML API need to be registered and have to provide their registered client identifier and version number on each request. For more information on client registration visit [[UDP API Definition]]. | ||
Parameters: | Parameters: | ||
* client={string} [required] | * <tt>client={string}</tt> [required] | ||
** client identification string, needs to be a registered client identifier, see: | ** client identification string, needs to be a registered client identifier, see: | ||
* clientver={integer} [required] | * <tt>clientver={integer}</tt> [required] | ||
** client version number, needs to be valid client version number for the given client identification string. | ** client version number, needs to be valid client version number for the given client identification string. | ||
| Line 43: | Line 44: | ||
Parameters: | Parameters: | ||
* query={string} [required] | * <tt>query={string}</tt> [required] | ||
** the escaped query string to search for ( | ** the escaped query string to search for (i.e. "sailor moon" should be sent as "sailor%20moon"). | ||
Example: | Example: | ||
| Line 82: | Line 83: | ||
Parameters: | Parameters: | ||
* aid={integer} [required] | * <tt>aid={integer}</tt> [required] | ||
** AniDB anime id of the anime you want to retrieve data for. | ** AniDB anime id of the anime you want to retrieve data for. | ||