XTS API - Revision history

Xander: /* General Errors */

2008-07-25T17:34:23Z

General Errors

← Older revision		Revision as of 17:34, 25 July 2008
Line 5:		Line 5:
	<br/><br/>		<br/><br/>
	= General Errors =		= General Errors =
	These errors can occur when calling any command, or when calling a command incorrectly. Errors are returned as an [[#<error>] document.		These errors can occur when calling any command, or when calling a command incorrectly. Errors are returned as an [[#<error>]] document.
	* '''401 notAuthorised''' You are not authorised to perform the action. You may need to supply a password, or it might simply be impossible to do what you want to do from the machine you're on.		* '''401 notAuthorised''' You are not authorised to perform the action. You may need to supply a password, or it might simply be impossible to do what you want to do from the machine you're on.
	* '''400.1 unrecognisedCommand''' The command is not recognised. Either you spelled it wrong, the API has changed since the documentation was written or you're simply doing it wrong.		* '''400.1 unrecognisedCommand''' The command is not recognised. Either you spelled it wrong, the API has changed since the documentation was written or you're simply doing it wrong.

	<br/><br/>		<br/><br/>

	= Commands =		= Commands =

Xander: This will do for today.

2008-07-18T17:21:17Z

This will do for today.

@@ Line 16: / Line 16: @@
 * No parameters (yet)
 === Returns ===
-A <shows> tag containing [[#<showsummary>]]s representing all shows in the database.
+A <shows> document containing [[#<showsummary>]]s representing all shows in the database.
 === Errors ===
 * Never returns an error.
@@ Line 27: / Line 27: @@
 === Errors ===
 * '''404.3 showNotFound''' if the show doesn't exist in the database.
 <br/><br/>
@@ Line 73: / Line 90: @@
      <description/>
    </show>
 </code>

Xander at 17:03, 18 July 2008

2008-07-18T17:03:17Z

← Older revision		Revision as of 17:03, 18 July 2008
Line 1:		Line 1:
	== XTS Application Programming Interface ==		= XTS Application Programming Interface =

	Correct (though incomplete) as of 2008-07-18 (RC1 "Fat Cat")		Correct (though incomplete) as of 2008-07-18 (RC1 "Fat Cat")

Xander at 17:02, 18 July 2008

2008-07-18T17:02:27Z

@@ Line 2: / Line 2: @@
 Correct (though incomplete) as of 2008-07-18 (RC1 "Fat Cat")
 == getshows ==
@@ Line 7: / Line 16: @@
 * No parameters (yet)
 === Returns ===
-<shows> containing [[#<show>]]s representing all shows in the database.
+A <shows> tag containing [[#<showsummary>]]s representing all shows in the database.
 === Errors ===
 * Never returns an error.
@@ Line 18: / Line 27: @@
 === Errors ===
 * '''404.3 showNotFound''' if the show doesn't exist in the database.

Xander at 16:44, 18 July 2008

2008-07-18T16:44:57Z

← Older revision		Revision as of 16:44, 18 July 2008
Line 3:		Line 3:
	Correct (though incomplete) as of 2008-07-18 (RC1 "Fat Cat")		Correct (though incomplete) as of 2008-07-18 (RC1 "Fat Cat")

	=== getshows ===		== getshows ==
	==== Parameters ====		=== Parameters ===
	* No parameters (yet)		* No parameters (yet)
	==== Returns ====		=== Returns ===
	<shows> containing [[#<show>]]s representing all shows in the database.		<shows> containing [[#<show>]]s representing all shows in the database.
	==== Errors ====		=== Errors ===
	* Never returns an error.		* Never returns an error.

	=== getshow ===		== getshow ==
	==== Parameters ====		=== Parameters ===
	* '''showid''' The ID of the show to get.		* '''showid''' The ID of the show to get.
	==== Returns ====		=== Returns ===
	A [[#<show>]] representing the show.		A [[#<show>]] representing the show.
	==== Errors ====		=== Errors ===
	* '''404.3 showNotFound''' if the show doesn't exist in the database.		* '''404.3 showNotFound''' if the show doesn't exist in the database.

Xander at 16:42, 18 July 2008

2008-07-18T16:42:01Z

← Older revision		Revision as of 16:42, 18 July 2008
Line 4:		Line 4:

	=== getshows ===		=== getshows ===
	== Parameters ==		==== Parameters ====
	* No parameters (yet)		* No parameters (yet)
	== Returns ==		==== Returns ====
	<shows> containing [[#<show>]]s representing all shows in the database.		<shows> containing [[#<show>]]s representing all shows in the database.
	== Errors ==		==== Errors ====
	* Never returns an error.		* Never returns an error.

	=== getshow ===		=== getshow ===
	== Parameters ==		==== Parameters ====
	* '''showid''' The ID of the show to get.		* '''showid''' The ID of the show to get.
	== Returns ==		==== Returns ====
	A [[#<show>]] representing the show.		A [[#<show>]] representing the show.
	== Errors ==		==== Errors ====
	* '''404.3 showNotFound''' if the show doesn't exist in the database.		* '''404.3 showNotFound''' if the show doesn't exist in the database.

Xander: This may also take a while.

2008-07-18T16:41:22Z

This may also take a while.

New page

== XTS Application Programming Interface ==

Correct (though incomplete) as of 2008-07-18 (RC1 "Fat Cat")

=== getshows ===
== Parameters ==
* No parameters (yet)
== Returns ==
<shows> containing [[#<show>]]s representing all shows in the database.
== Errors ==
* Never returns an error.

=== getshow ===
== Parameters ==
* '''showid''' The ID of the show to get.
== Returns ==
A [[#<show>]] representing the show.
== Errors ==
* '''404.3 showNotFound''' if the show doesn't exist in the database.