TIAPI: Difference between revisions

From tango.info wiki
Jump to navigation Jump to search
Line 5: Line 5:


==Reading==
==Reading==
Formats:
The API should provide the ability to return a query search of the database. 
 
===Query Fields===
 
Ideally the query parameters would be customizable to the search likely being able to include:
 
* Title
* Orchestra
* Album
* TINT
* ...
 
===Return Format===
Any Internet media format would work but JSON would be best given the human readability and open standard format.
 
* csv?
* csv?
* xml?
* xml?
* json?
* json?


==Writing==
==Writing==
Not planned.
Not planned.

Revision as of 2014-02-05T04:16:27

Overview

TIAPI = TI-API = API for tango.info

Ideally this will be a RESTful API likely requiring a HTTP GET method to query the database. This will provide a dynamic way to interactively query the tango.info database.

Reading

The API should provide the ability to return a query search of the database.

Query Fields

Ideally the query parameters would be customizable to the search likely being able to include:

  • Title
  • Orchestra
  • Album
  • TINT
  • ...

Return Format

Any Internet media format would work but JSON would be best given the human readability and open standard format.

  • csv?
  • xml?
  • json?

Writing

Not planned.