This is a listing of the XTS API commands as of 2009-05-31. I'm documenting it now as a stepping stone to the XTS2 API, which is modular and handles payments completely differently.

The XTS1 API stub is /v1/urli

/v1 is the version of the API. /urli is the method that is being used to access the API. I also intended to support XMLRPC but there turned out to be no point. urli stands for "URL invocation", in which every client call on the API is GET with a URL in the format stub/command?param1=value1&param2=value2&...

The API commands are:

• getshows - get the names of all shows
• getshow
• getperformances - get the performances of a show
• getprogramme - get info about upcoming shows and their next performances - the website uses this call
• getnowandnext - get ticket count info about the next n performances - an applet shows this info in the XTS client
• getticketcounts
• gettickettypes - get the types of tickets that can be sold for a given show
• getbookings - get a list of all booking names that have uncollected tickets
• getticketsinbooking - get the tickets that are present in a booking
• getpaymenttypes - get accepted payment types
• getstats - get various bits of meta-information about the code and database - shown on the about page
• getlogrecords - get n records from the XTS log
• gettakings - get the amount of money taken in cash since a given time
• holdticket - reserve a ticket ready for sale
• touchtickets - bump the expiry on a set of reserved tickets
• yieldticket - give up a reserved ticket without buying it
• sellticket - mark a ticket as sold
• selltickets - mark a set of tickets as sold - atomic
• refundtickets - sell anti-tickets
• cancelbookedticket - delete a ticket that exists in a booking
• releasebookings - delete all tickets in bookings for a given performance
• booktickets - put reserved tickets into a booking
• holdbacktickets - set the number of "held back" tickets for a performance (for instance, a fringe allocation)
• checkbookingname
• report - fetch a takings, performance or show report
• verifybooking - check whether a set of verification details for a verified booking are correct
• isadmin - check whether the password provided works as an admin password
• nop - do nothing