VJA:API

From RemyWiki

Since there are enough people hacking extensions onto VJA as is, it was about time I do some simple API calls to provide functionality that programmers need.

Basic Information

All API calls are located under the directory http://vjarmy.com/iidx/api/; there is no directory listing at this time or sort of index save this document.

All API calls require HTTP authentication with the user name and password of the VJA User making the call. Failure to authenticate at all will give a 401 HTTP error. Failure to authenticate with proper credentials will *not*, and instead give you just result text that reads "Invalid login and/or password." Please make sure your parsers watch for this. (This error message may change formats.)

If you have API hook requests, please post them on the discussion page for this document.

API Calls

User Lookup

Location: http://vjarmy.com/iidx/api/userlookup.php
Arguments: Takes one of three optional arguments:

• djname - takes a string of the user's DJ name.
• login - takes a string of the user's login name.
• id - takes an integer of the user's ID number.

Returns: If no argument is given, XML based user data for the authenticated user is returned. Otherwise, XML based user data for the user given in the argument is returned.

Example Returned Data:

<?xml version="1.0" encoding="UTF-8"?>
<vjadata version="0.1" xmlns="http://vjarmy.com/iidx/ns#">
	<user>
		<id>1</id>
		<login><![CDATA[Remy]]></login>
		<djname><![CDATA[REMY]]></djname>
	</user>
</vjadata>

Future versions of this API call may reveal more user data as specified by the VJA XML Schema.