GMOD RPC API

Background

This effort was started after Josh Goodman's talk at the January 2009 GMOD Meeting meeting titled "MOD Web API (A RESTful interface for MODs)". The main idea is to increase interoperability among the various model organism databases by creating an easy to use high level RESTful API. The queries iterated below are currently in the proposal stage and have no been implemented at any MOD.

Members

• Josh Goodman - FlyBase
• Robert Buels - SOL Genomics Network
• Add your name here

Goals

• Data model agnostic
• Language agnostic
• Easy to use
• Versioned URLs for API stability over time

API Version

In order to provide a stable URL API all web calls should be versioned according to what GMOD REST API they are using. The version number included in the URLs corresponds to the API version and not the data version.

Current GMOD REST API Version: 1

Suggested operations

Searches

Organism List

Purpose: Obtain a list of organisms that are able to be queried with this service.
URL: http://yourmod.org/gmodrest/v<api version>/organisms
Example URL: http://flybase.org/gmodrest/v1/organisms
Example Result: <xml> <?xml version="1.0" encoding="UTF-8"?> <resultset>

  <organism>
      <species></species>
      <genus></genus>
      <taxonomy_id></taxonomy_id>
  </organism>
  <organism>
      <species></species>
      <genus></genus>
      <taxonomy_id></taxonomy_id>
  </organism>

</resultset> </xml>