Difference between revisions of "XTS API"

From EUTC Wiki
m (This may also take a while.)
 
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.

Revision as of 16:42, 18 July 2008

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.