OReFiL オンラインリソースページ情報取得 WebAPI 対応の仕様

[h-morita]

OReFiL オンラインリソースページ情報取得 WebAPI 機能

概要

OReFiL オンラインリソースページ情報取得 WebAPI に対応する。

理由

スコープ

OReFiL フロントエンドシステム

インタフェース仕様

REST

• URI
  • /online_resource/< id >.xml
    • < id >部にオンラインリソースの ID を指定
• エラー仕様
  • 基本的には HTTP ステータスをもとにエラーハンドリングを行うこと
  • ユーザパラメータにエラーがある場合は出来うる限りそのエラー内容を XML で返す
    • エラー内容の仕様
      • errors: エラーリスト
        • error: エラー
          • http_status_code: HTTP ステータスコード
          • code: アプリケーションエラーコード
          • name: エラー名
          • message: エラーメッセージ
    • エラーサンプル

      <?xml version="1.0" encoding="UTF-8"?>
      <errors>
        <error>
          <http_status_code>401</http_status_code>
          <code>40401</code>
          <name>Orefil::InvalidOnlineResourceId</name>
          <message>Entry not Found. (:id => 99999)</message>
        </error>
      </errors>
      

レスポンスサンプル

<?xml version="1.0" encoding="UTF-8"?>
<online_resource>
  <title>UCSC Genome Browser Home</title>
  <mesh_term_list>
    <mesh_term>Abnormalities, Multiple</mesh_term>
    <mesh_term>Carbamoyl-Phosphate Synthase I Deficiency Disease</mesh_term>
    <mesh_term>Chickens</mesh_term>
    <mesh_term>Chromosome Deletion</mesh_term>
    <mesh_term>Chromosome Mapping</mesh_term>
    <mesh_term>Chromosomes, Human, Pair 2</mesh_term>
    <mesh_term>Computational Biology</mesh_term>
    <mesh_term>DNA Primers</mesh_term>
    <mesh_term>Database Management Systems</mesh_term>
    <mesh_term>Databases, Genetic</mesh_term>
    <mesh_term>Databases, Nucleic Acid</mesh_term>
    <mesh_term>Databases, Protein</mesh_term>
    <mesh_term>Exons</mesh_term>
    <mesh_term>Genome</mesh_term>
    <mesh_term>Genome, Human</mesh_term>
    <mesh_term>Genomics</mesh_term>
    <mesh_term>Information Storage and Retrieval</mesh_term>
    <mesh_term>Internet</mesh_term>
    <mesh_term>Linkage (Genetics)</mesh_term>
    <mesh_term>Microsatellite Repeats</mesh_term>
    <mesh_term>Polymorphism, Single Nucleotide</mesh_term>
    <mesh_term>Proteins</mesh_term>
    <mesh_term>Proteome</mesh_term>
    <mesh_term>Proteomics</mesh_term>
    <mesh_term>RNA, Messenger</mesh_term>
    <mesh_term>Sequence Alignment</mesh_term>
    <mesh_term>Software</mesh_term>
    <mesh_term>Zebrafish</mesh_term>
  </mesh_term_list>
  <url>http://genome.ucsc.edu/</url>
  <pages>
    <google>
      http://www.google.com/search?hl=en&amp;q=link%3ahttp%3A%2F%2Fgenome.ucsc.edu%2F&amp;btnG=Google+Search
    </google>
    <altavista>
      http://www.altavista.com/web/results?itag=ody&amp;q=link:http%3A%2F%2Fgenome.ucsc.edu%2F&amp;kgs=0&amp;kls=1
    </altavista>
  </pages>
  <papers>
    <biomed_central>
      http://www.biomedcentral.com/search/results.asp?txtSearch1=genome.ucsc.edu%2F&amp;chkBMCJournals=true&amp;chkCurrentOpinion=true&amp;drpFromDate=&amp;drpToDate=&amp;chkNSP=true&amp;drpAddedInLast=&amp;drpOrderBy=by+date&amp;drpPerPage=20&amp;drpAbstract=no+abstract&amp;strTempString=&amp;strSearchBoxType=bmc_boolean_results&amp;Search.x=10&amp;jou_id=&amp;Search.x=0&amp;Search.y=0&amp;Search=Search
    </biomed_central>
    <scirus>
      http://www.scirus.com/srsapp/search?q=genome.ucsc.edu%2F&amp;ds=jnl&amp;g=s&amp;t=all
    </scirus>
    <highwire_press>
      http://highwire.org/cgi/searchresults?fulltext=genome.ucsc.edu%2F&amp;andorexactfulltext=and&amp;author1=&amp;pubdate_year=&amp;volume=&amp;firstpage=&amp;src=hw&amp;searchsubmit=redo&amp;resourcetype=1&amp;search=Search&amp;fmonth=Jan&amp;fyear=1844&amp;tmonth=Dec&amp;tyear=2007&amp;fdatedef=1+January+1844&amp;tdatedef=31+Dec+2007
    </highwire_press>
    <google_scholar>
      http://scholar.google.com/scholar?hl=en&amp;lr=&amp;q=genome.ucsc.edu%2F&amp;btnG=Search
    </google_scholar>
  </papers>
  <pmid_list>
    <pmid>18086701</pmid>
    <pmid>18172923</pmid>
    <pmid>17984227</pmid>
    <pmid>17151077</pmid>
    <pmid>17142222</pmid>
    <pmid>16500937</pmid>
    <pmid>16372332</pmid>
    <pmid>16381938</pmid>
    <pmid>16888352</pmid>
    <pmid>16722777</pmid>
    <pmid>16888346</pmid>
    <pmid>16888348</pmid>
    <pmid>15608236</pmid>
    <pmid>15554057</pmid>
    <pmid>15216554</pmid>
    <pmid>12519945</pmid>
    <pmid>12045153</pmid>
    <pmid>11932250</pmid>
  </pmid_list>
</online_resource>