チケット #220: online_resource_api_en.html

ファイル online_resource_api_en.html, 16.6 KB (登録者: yy, 17 年 前)

「OReFiL オンラインリソースページ情報取得 WebAPI 機能」の英語版です。

行番号 
1<!DOCTYPE html
2        PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5<head>
6<title>OReFiL: Help</title>
7<style type="text/css">
8<!--/* <![CDATA[ */
9.a {color: green}
10.b {border: thin dotted #888; font-size:18px}
11.e {background: #eee}
12.m {text-decoration: none; background: #eef; margin: .1ex .1em .1ex .1em}
13.n {background: #ddd}
14a.m:link {color: #00f}
15a.m:visited {color: #00f}
16a.m:hover {color: #770}
17a.m:active {color: #00f}
18h1 {text-indent: .2em; border-color: black; border-width: 0 0 1px 4px; border-style: none none solid double}
19h2 {margin-bottom: 20px; padding: 8px 0; border-top: 6px solid #444; border-bottom: 6px solid #444; text-indent: .2em;}
20h3 {padding: .2em .3em .2em .3em; margin: 0 0 .5em 0; color: white; background: #444}
21ul {margin-top: 0; margin-bottom: 3ex}
22li {margin-bottom: .7ex}
23body {font-family: Arial, sans-serif; margin: 1.5ex; padding: 0; line-height: 1.4; color: #333; font-size: 0.9em}
24html {overflow-y:scroll;}
25p {margin: .7ex .7em .7ex .7em}
26table {
27        margin: 0 0 3ex 7ex;
28        border: 1px solid #CCCCCC;
29        border-collapse: separate;
30        border-spacing: 1px;
31}
32td {
33        border: 1px solid #CCCCCC;
34        border-collapse: separate;
35        border-spacing: 1px;
36}
37pre {
38        width: 500px;
39        padding: 2em;
40        overflow: auto;
41        border: 1px solid #CCCCCC;
42        border-collapse: separate;
43        border-spacing: 1px;
44}
45/* ]]> */-->
46</style>
47</head>
48<body>
49<h1>Specification of the OReFiL WebAPI for obtaining online resource information</h1>
50<ul>
51<li><a href="#sec_1">SOAP Interface</a></li>
52<li><a href="#sec_2">REST Interface</a></li>
53<li><a href="#sec_3">Responses</a></li>
54<li><a href="#sec_4">SOAP Request / Response Sample</a></li>
55<li><a href="#sec_5">REST Request / Response Sample</a></li>
56</ul>
57<center><p><a href="/">Begin a search</a></p>
58<p>Comments and suggestions are welcome, please send an email to yayamamo AT cb DOT k DOT u-tokyo DOT ac DOT jp.</p></center>
59
60<h2>Interface Specifications</h2>
61
62<a id="sec_1"></a>
63<h3 id="SOAP">SOAP</h3>
64<ul><li>WSDL
65<ul><li>/online_resource/service.wsdl
66</li></ul></li><li>Entry Point
67<ul><li>/online_resource/api
68</li></ul></li><li>SOAPAction
69<ul><li>/online_resource/api/GetResourceInfoById
70</li></ul></li><li>Parameters
71</li></ul><table class="wiki">
72<tr><td> Name </td><td> Description </td><td> Must/Optional </td><td> Default Value </td><td> Allowable Values
73</td></tr><tr><td> id </td><td> Online resource ID </td><td> Must </td><td> - </td><td> Integer
74</td></tr></table>
75<ul><li>Errors
76<ul><li>Follows the SOAP error specification as much as possible.
77</li></ul></li></ul>
78
79<a id="sec_2"></a>
80<h3 id="REST">REST</h3>
81<ul><li>URI
82<ul><li>/online_resource/&lt; id &gt;.xml
83<ul><li>Specifying an online resource id at &lt; id &gt;
84</li></ul></li></ul></li><li>Errors
85<ul><li>Basically users need to handle errors based on HTTP statuses.
86</li><li>The error description is given in an XML format as much as possible if there is an error in user parameters.
87<ul><li>Error description
88<ul><li>errors: a list of errors
89<ul><li>error: description of each error
90<ul><li>http_status_code: HTTP status code
91</li><li>code: application error code
92</li><li>name: error name
93</li><li>message: error message
94</li></ul></li></ul></li></ul></li><li>Error sample
95<pre class="wiki">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
96&lt;errors&gt;
97  &lt;error&gt;
98    &lt;http_status_code&gt;401&lt;/http_status_code&gt;
99    &lt;code&gt;40401&lt;/code&gt;
100    &lt;name&gt;Orefil::InvalidOnlineResourceId&lt;/name&gt;
101    &lt;message&gt;Entry not Found. (:id =&gt; 99999)&lt;/message&gt;
102  &lt;/error&gt;
103&lt;/errors&gt;
104</pre></li></ul></li></ul></li></ul>
105
106<a id="sec_3"></a>
107<h2>Response</h2>
108<ul><li>return (OnlineResource): Online resource ( online_resource if REST )
109<ul><li>id: Online resource ID
110</li><li>title: Title of the online resource
111</li><li>updated_at: Update time ( XML Schema format )
112</li><li>average_stars: Average rating
113</li><li>mesh_term_list: A list of MeSH terms
114<ul><li>item: A MeSH term ( mesh_term if REST )
115</li></ul></li><li>url: Online resource's URL
116</li><li>pages: A list of URLs that search for referring links
117<ul><li>item: Referring link search ( `page` if REST )
118<ul><li>name: Name of the search engine
119</li><li>url: URL for search
120</li></ul></li></ul></li><li>papers: A list of URLs that search for citing papers
121<ul><li>item: Citing paper search ( `paper` if REST )
122<ul><li>name: Name of the search engine
123</li><li>url: URL for search
124</li></ul></li></ul></li><li>pmid_list: A ilst of PMIDs that cite the resource
125<ul><li>item: pmid ( pmid if REST )
126</li></ul></li></ul></li></ul>
127
128<h2>Request / Response Sample</h2>
129<p>
130Here are samples of requests and their corresponding responses in SOAP and REST.
131</p>
132<ul><li>Request
133<ul><li>Online resource ID : 4980
134</li></ul></li></ul>
135
136<a id="sec_4"></a>
137<h3 id="SOAP1">SOAP</h3>
138<ul><li>Request
139<pre class="wiki">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
140
141  &lt;SOAP-ENV:Envelope
142
143    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
144
145    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
146
147    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
148
149    SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
150
151    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"&gt;
152
153      &lt;SOAP-ENV:Body&gt;
154
155        &lt;m:GetResourceInfoById xmlns:m="urn:ActionWebService"&gt;
156
157          &lt;id xsi:type="xsd:int"&gt;4980&lt;/id&gt;
158
159        &lt;/m:GetResourceInfoById&gt;
160
161      &lt;/SOAP-ENV:Body&gt;
162
163    &lt;/SOAP-ENV:Envelope&gt;
164</pre></li><li>Response
165<pre class="wiki">&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
166&lt;env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
167    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
168    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;
169  &lt;env:Body&gt;
170    &lt;n1:GetResourceInfoByIdResponse xmlns:n1="urn:ActionWebService"
171        env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"&gt;
172      &lt;return xsi:type="n1:Resource..OnlineResource"&gt;
173        &lt;id xsi:type="xsd:int"&gt;4980&lt;/id&gt;
174        &lt;mesh_term_list n2:arrayType="xsd:string[28]"
175            xmlns:n2="http://schemas.xmlsoap.org/soap/encoding/"
176            xsi:type="n2:Array"&gt;
177          &lt;item&gt;Abnormalities, Multiple&lt;/item&gt;
178          &lt;item&gt;Carbamoyl-Phosphate Synthase I Deficiency Disease&lt;/item&gt;
179          &lt;item&gt;Chickens&lt;/item&gt;
180          &lt;item&gt;Chromosome Deletion&lt;/item&gt;
181          &lt;item&gt;Chromosome Mapping&lt;/item&gt;
182          &lt;item&gt;Chromosomes, Human, Pair 2&lt;/item&gt;
183          &lt;item&gt;Computational Biology&lt;/item&gt;
184          &lt;item&gt;DNA Primers&lt;/item&gt;
185          &lt;item&gt;Database Management Systems&lt;/item&gt;
186          &lt;item&gt;Databases, Genetic&lt;/item&gt;
187          &lt;item&gt;Databases, Nucleic Acid&lt;/item&gt;
188          &lt;item&gt;Databases, Protein&lt;/item&gt;
189          &lt;item&gt;Exons&lt;/item&gt;
190          &lt;item&gt;Genome&lt;/item&gt;
191          &lt;item&gt;Genome, Human&lt;/item&gt;
192          &lt;item&gt;Genomics&lt;/item&gt;
193          &lt;item&gt;Information Storage and Retrieval&lt;/item&gt;
194          &lt;item&gt;Internet&lt;/item&gt;
195          &lt;item&gt;Linkage (Genetics)&lt;/item&gt;
196          &lt;item&gt;Microsatellite Repeats&lt;/item&gt;
197          &lt;item&gt;Polymorphism, Single Nucleotide&lt;/item&gt;
198          &lt;item&gt;Proteins&lt;/item&gt;
199          &lt;item&gt;Proteome&lt;/item&gt;
200          &lt;item&gt;Proteomics&lt;/item&gt;
201          &lt;item&gt;RNA, Messenger&lt;/item&gt;
202          &lt;item&gt;Sequence Alignment&lt;/item&gt;
203          &lt;item&gt;Software&lt;/item&gt;
204          &lt;item&gt;Zebrafish&lt;/item&gt;
205        &lt;/mesh_term_list&gt;
206        &lt;pmid_list xmlns:n3="http://schemas.xmlsoap.org/soap/encoding/"
207            xsi:type="n3:Array"
208            n3:arrayType="xsd:string[15]"&gt;
209          &lt;item&gt;16888352&lt;/item&gt;
210          &lt;item&gt;16381938&lt;/item&gt;
211          &lt;item&gt;12045153&lt;/item&gt;
212          &lt;item&gt;15216554&lt;/item&gt;
213          &lt;item&gt;17151077&lt;/item&gt;
214          &lt;item&gt;16888348&lt;/item&gt;
215          &lt;item&gt;16372332&lt;/item&gt;
216          &lt;item&gt;11932250&lt;/item&gt;
217          &lt;item&gt;16722777&lt;/item&gt;
218          &lt;item&gt;12519945&lt;/item&gt;
219          &lt;item&gt;16500937&lt;/item&gt;
220          &lt;item&gt;17142222&lt;/item&gt;
221          &lt;item&gt;15554057&lt;/item&gt;
222          &lt;item&gt;15608236&lt;/item&gt;
223          &lt;item&gt;16888346&lt;/item&gt;
224        &lt;/pmid_list&gt;
225        &lt;papers n4:arrayType="n1:Resource..Paper[4]"
226            xmlns:n4="http://schemas.xmlsoap.org/soap/encoding/"
227            xsi:type="n4:Array"&gt;
228          &lt;item&gt;
229            &lt;name xsi:type="xsd:string"&gt;BioMed Central&lt;/name&gt;
230            &lt;url xsi:type="xsd:string"&gt;http://www.biomedcentral.com/search/results.asp?txtSearch1=genome.ucsc.edu%2F&amp;amp;amp;chkBMCJournals=true&amp;amp;amp;chkCurrentOpinion=true&amp;amp;amp;drpFromDate=&amp;amp;amp;drpToDate=&amp;amp;amp;chkNSP=true&amp;amp;amp;drpAddedInLast=&amp;amp;amp;drpOrderBy=by+date&amp;amp;amp;drpPerPage=20&amp;amp;amp;drpAbstract=no+abstract&amp;amp;amp;strTempString=&amp;amp;amp;strSearchBoxType=bmc_boolean_results&amp;amp;amp;Search.x=10&amp;amp;amp;jou_id=&amp;amp;amp;Search.x=0&amp;amp;amp;Search.y=0&amp;amp;amp;Search=Search&lt;/url&gt;
231          &lt;/item&gt;
232          &lt;item&gt;
233            &lt;name xsi:type="xsd:string"&gt;Scirus&lt;/name&gt;
234            &lt;url xsi:type="xsd:string"&gt;http://www.scirus.com/srsapp/search?q=genome.ucsc.edu%2F&amp;amp;amp;ds=jnl&amp;amp;amp;g=s&amp;amp;amp;t=all&lt;/url&gt;
235          &lt;/item&gt;
236          &lt;item&gt;
237            &lt;name xsi:type="xsd:string"&gt;HighWire Press&lt;/name&gt;
238            &lt;url xsi:type="xsd:string"&gt;http://highwire.org/cgi/searchresults?fulltext=genome.ucsc.edu%2F&amp;amp;amp;andorexactfulltext=and&amp;amp;amp;author1=&amp;amp;amp;pubdate_year=&amp;amp;amp;volume=&amp;amp;amp;firstpage=&amp;amp;amp;src=hw&amp;amp;amp;searchsubmit=redo&amp;amp;amp;resourcetype=1&amp;amp;amp;search=Search&amp;amp;amp;fmonth=Jan&amp;amp;amp;fyear=1844&amp;amp;amp;tmonth=Dec&amp;amp;amp;tyear=2007&amp;amp;amp;fdatedef=1+January+1844&amp;amp;amp;tdatedef=31+Dec+2007&lt;/url&gt;
239          &lt;/item&gt;
240          &lt;item&gt;
241            &lt;name xsi:type="xsd:string"&gt;Google Scholar&lt;/name&gt;
242            &lt;url xsi:type="xsd:string"&gt;http://scholar.google.com/scholar?hl=en&amp;amp;amp;lr=&amp;amp;amp;q=genome.ucsc.edu%2F&amp;amp;amp;btnG=Search&lt;/url&gt;
243          &lt;/item&gt;
244        &lt;/papers&gt;
245        &lt;average_stars xsi:type="xsd:double"&gt;+3.5&lt;/average_stars&gt;
246        &lt;url xsi:type="xsd:string"&gt;http://genome.ucsc.edu/&lt;/url&gt;
247        &lt;updated_at xsi:type="xsd:dateTime"&gt;2008-02-20T00:00:00+09:00&lt;/updated_at&gt;
248        &lt;pages n5:arrayType="n1:Resource..Page[2]"
249            xmlns:n5="http://schemas.xmlsoap.org/soap/encoding/"
250            xsi:type="n5:Array"&gt;
251          &lt;item&gt;
252            &lt;name xsi:type="xsd:string"&gt;Google&lt;/name&gt;
253            &lt;url xsi:type="xsd:string"&gt;http://www.google.com/search?hl=en&amp;amp;amp;q=link%3ahttp%3A%2F%2Fgenome.ucsc.edu%2F&amp;amp;amp;btnG=Google+Search&lt;/url&gt;
254          &lt;/item&gt;
255          &lt;item&gt;
256            &lt;name xsi:type="xsd:string"&gt;Altavista&lt;/name&gt;
257            &lt;url xsi:type="xsd:string"&gt;http://www.altavista.com/web/results?itag=ody&amp;amp;amp;q=link:http%3A%2F%2Fgenome.ucsc.edu%2F&amp;amp;amp;kgs=0&amp;amp;amp;kls=1&lt;/url&gt;
258          &lt;/item&gt;
259        &lt;/pages&gt;
260        &lt;title xsi:type="xsd:string"&gt;UCSC Genome Browser Home&lt;/title&gt;
261      &lt;/return&gt;
262    &lt;/n1:GetResourceInfoByIdResponse&gt;
263  &lt;/env:Body&gt;
264&lt;/env:Envelope&gt;
265</pre></li></ul>
266
267<a id="sec_5"></a>
268<h3 id="REST1">REST</h3>
269<ul><li>Request
270<pre class="wiki">/online_resource/4980.xml
271</pre></li><li>Response
272<pre class="wiki">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
273&lt;online_resource&gt;
274  &lt;id&gt;4980&lt;/id&gt;
275  &lt;title&gt;UCSC Genome Browser Home&lt;/title&gt;
276  &lt;updated_at&gt;2008-02-20T00:00:00+09:00&lt;/updated_at&gt;
277  &lt;average_stars&gt;3.5&lt;/average_stars&gt;
278  &lt;mesh_term_list&gt;
279    &lt;mesh_term&gt;Abnormalities, Multiple&lt;/mesh_term&gt;
280    &lt;mesh_term&gt;Carbamoyl-Phosphate Synthase I Deficiency Disease&lt;/mesh_term&gt;
281    &lt;mesh_term&gt;Chickens&lt;/mesh_term&gt;
282    &lt;mesh_term&gt;Chromosome Deletion&lt;/mesh_term&gt;
283    &lt;mesh_term&gt;Chromosome Mapping&lt;/mesh_term&gt;
284    &lt;mesh_term&gt;Chromosomes, Human, Pair 2&lt;/mesh_term&gt;
285    &lt;mesh_term&gt;Computational Biology&lt;/mesh_term&gt;
286    &lt;mesh_term&gt;DNA Primers&lt;/mesh_term&gt;
287    &lt;mesh_term&gt;Database Management Systems&lt;/mesh_term&gt;
288    &lt;mesh_term&gt;Databases, Genetic&lt;/mesh_term&gt;
289    &lt;mesh_term&gt;Databases, Nucleic Acid&lt;/mesh_term&gt;
290    &lt;mesh_term&gt;Databases, Protein&lt;/mesh_term&gt;
291    &lt;mesh_term&gt;Exons&lt;/mesh_term&gt;
292    &lt;mesh_term&gt;Genome&lt;/mesh_term&gt;
293    &lt;mesh_term&gt;Genome, Human&lt;/mesh_term&gt;
294    &lt;mesh_term&gt;Genomics&lt;/mesh_term&gt;
295    &lt;mesh_term&gt;Information Storage and Retrieval&lt;/mesh_term&gt;
296    &lt;mesh_term&gt;Internet&lt;/mesh_term&gt;
297    &lt;mesh_term&gt;Linkage (Genetics)&lt;/mesh_term&gt;
298    &lt;mesh_term&gt;Microsatellite Repeats&lt;/mesh_term&gt;
299    &lt;mesh_term&gt;Polymorphism, Single Nucleotide&lt;/mesh_term&gt;
300    &lt;mesh_term&gt;Proteins&lt;/mesh_term&gt;
301    &lt;mesh_term&gt;Proteome&lt;/mesh_term&gt;
302    &lt;mesh_term&gt;Proteomics&lt;/mesh_term&gt;
303    &lt;mesh_term&gt;RNA, Messenger&lt;/mesh_term&gt;
304    &lt;mesh_term&gt;Sequence Alignment&lt;/mesh_term&gt;
305    &lt;mesh_term&gt;Software&lt;/mesh_term&gt;
306    &lt;mesh_term&gt;Zebrafish&lt;/mesh_term&gt;
307  &lt;/mesh_term_list&gt;
308  &lt;url&gt;http://genome.ucsc.edu/&lt;/url&gt;
309  &lt;pages&gt;
310    &lt;page&gt;
311      &lt;name&gt;Google&lt;/name&gt;
312      &lt;url&gt;
313        http://www.google.com/search?hl=en&amp;amp;q=link%3ahttp%3A%2F%2Fgenome.ucsc.edu%2F&amp;amp;btnG=Google+Search
314      &lt;/url&gt;
315    &lt;/page&gt;
316    &lt;page&gt;
317      &lt;name&gt;Altavista&lt;/name&gt;
318      &lt;url&gt;
319        http://www.altavista.com/web/results?itag=ody&amp;amp;q=link:http%3A%2F%2Fgenome.ucsc.edu%2F&amp;amp;kgs=0&amp;amp;kls=1
320      &lt;/url&gt;
321    &lt;/page&gt;
322  &lt;/pages&gt;
323  &lt;papers&gt;
324    &lt;paper&gt;
325      &lt;name&gt;BioMed Central&lt;/name&gt;
326      &lt;url&gt;
327        http://www.biomedcentral.com/search/results.asp?txtSearch1=genome.ucsc.edu%2F&amp;amp;chkBMCJournals=true&amp;amp;chkCurrentOpinion=true&amp;amp;drpFromDate=&amp;amp;drpToDate=&amp;amp;chkNSP=true&amp;amp;drpAddedInLast=&amp;amp;drpOrderBy=by+date&amp;amp;drpPerPage=20&amp;amp;drpAbstract=no+abstract&amp;amp;strTempString=&amp;amp;strSearchBoxType=bmc_boolean_results&amp;amp;Search.x=10&amp;amp;jou_id=&amp;amp;Search.x=0&amp;amp;Search.y=0&amp;amp;Search=Search
328      &lt;/url&gt;
329    &lt;/paper&gt;
330    &lt;paper&gt;
331      &lt;name&gt;Scirus&lt;/name&gt;
332      &lt;url&gt;
333        http://www.scirus.com/srsapp/search?q=genome.ucsc.edu%2F&amp;amp;ds=jnl&amp;amp;g=s&amp;amp;t=all
334      &lt;/url&gt;
335    &lt;/paper&gt;
336    &lt;paper&gt;
337      &lt;name&gt;HighWire Press&lt;/name&gt;
338      &lt;url&gt;
339        http://highwire.org/cgi/searchresults?fulltext=genome.ucsc.edu%2F&amp;amp;andorexactfulltext=and&amp;amp;author1=&amp;amp;pubdate_year=&amp;amp;volume=&amp;amp;firstpage=&amp;amp;src=hw&amp;amp;searchsubmit=redo&amp;amp;resourcetype=1&amp;amp;search=Search&amp;amp;fmonth=Jan&amp;amp;fyear=1844&amp;amp;tmonth=Dec&amp;amp;tyear=2007&amp;amp;fdatedef=1+January+1844&amp;amp;tdatedef=31+Dec+2007
340      &lt;/url&gt;
341    &lt;/paper&gt;
342    &lt;paper&gt;
343      &lt;name&gt;Google Scholar&lt;/name&gt;
344      &lt;url&gt;
345        http://scholar.google.com/scholar?hl=en&amp;amp;lr=&amp;amp;q=genome.ucsc.edu%2F&amp;amp;btnG=Search
346      &lt;/url&gt;
347    &lt;/paper&gt;
348  &lt;/papers&gt;
349  &lt;pmid_list&gt;
350    &lt;pmid&gt;16888352&lt;/pmid&gt;
351    &lt;pmid&gt;16381938&lt;/pmid&gt;
352    &lt;pmid&gt;12045153&lt;/pmid&gt;
353    &lt;pmid&gt;15216554&lt;/pmid&gt;
354    &lt;pmid&gt;17151077&lt;/pmid&gt;
355    &lt;pmid&gt;16888348&lt;/pmid&gt;
356    &lt;pmid&gt;16372332&lt;/pmid&gt;
357    &lt;pmid&gt;11932250&lt;/pmid&gt;
358    &lt;pmid&gt;16722777&lt;/pmid&gt;
359    &lt;pmid&gt;12519945&lt;/pmid&gt;
360    &lt;pmid&gt;16500937&lt;/pmid&gt;
361    &lt;pmid&gt;17142222&lt;/pmid&gt;
362    &lt;pmid&gt;15554057&lt;/pmid&gt;
363    &lt;pmid&gt;15608236&lt;/pmid&gt;
364    &lt;pmid&gt;16888346&lt;/pmid&gt;
365  &lt;/pmid_list&gt;
366&lt;/online_resource&gt;
367</pre></li></ul>
368
369</body>
370</html>