Changes between Version 12 and Version 13 of GuidelineForWebService

Timestamp:

2009/03/20 16:32:43 (16 years ago)

Author:

chisato-yamasaki

Comment:

--

GuidelineForWebService

@@ -23 +23 @@
    * When any error occurs during processing at a server, a method 
  
- * TogoWS Guidelines
 
-REST
+= TogoWS TogoWS Guidelines =
 
-TogoWS stated the rulers below: 
-•       http://togows.dbcls.jp/site/services.html 
-•       http://togows.dbcls.jp/site/rest.html 
-•       
-How to call the entries
-        http://togows.dbcls.jp/entry/database/entry_id[,entry_id2,...]/field[.format]
-# How to include the name space of the databases in URL： 
-•       http://frnadb.example.org/entry/id instead of http://frnadb.example.org/entry/frnadb/id
-# How to add the name spaces for the institution, release_numer of the database: 
-•       http://togows.dbcls.jp/entry/birc-hinv-5.0/HIT0012345 
+== REST ==
+
+TogoWS stated the rulers as below:
+
+ * http://togows.dbcls.jp/site/services.html
+ * http://togows.dbcls.jp/site/rest.html
+
+=== How to call the entries ===
+
+{{{
+http://togows.dbcls.jp/entry/database/entry_id[,entry_id2,...]/field[.format]
+}}}
+
+How to include the name space of the databases in URL：
+
+ * http://frnadb.example.org/entry/id instead of http://frnadb.example.org/entry/frnadb/id
+
+How to add the name spaces for the institution, release_numer of the database: 
+
+ * http://togows.dbcls.jp/entry/birc-hinv-5.0/HIT0012345
+
 NOTE:
 The default fotmat for the entries is “.txt”, and can be in the specified format by adding the suffix, such as “.xml”. 
-How to search the entries
+
+エントリの部分要素取得について：
+
+エントリの一部を field 名で取得できる機能は !BioRuby/BioPerl を利用した TogoWS の拡張ですが、
+バックエンドが XML データベースの場合など、field の代わりに XPath を利用することも検討可能。
+
+=== How to search the entrie ===
+
+{{{
 http://togows.dbcls.jp/search/database/query+string[.format][/offset,limit[.format]] 
 http://togows.dbcls.jp/search/database/query+string/count
-The format of "query string" to be based on “Common Query Language“
+}}}
 
-The conversion and data format and ID
+he format of "query string" to be based on “Common Query Language" [http://en.wikipedia.org/wiki/Common_Query_Language Common Query Language]
+
+=== The conversion and data format and ID ===
+
+{{{
 http://togows.dbcls.jp/convert/data_source.format
-Metadata
-•       The list of the databases
+}}}
+
+=== Metadata ===
+
+ * The list of the databases
+
+{{{
 http://togows.dbcls.jp/entry/
-•       The list of the fields
+http://togows.dbcls.jp/search/
+}}}
+
+ * The list of the fields
+
+{{{
 http://togows.dbcls.jp/entry/DB名/
-•       The list of the formats
-http://togows.dbcls.jp/entry/DB_name/formats
-SOAP
-•        Calling a method with asynchronous
-o       The name for the method with asynchronous end with “Async” and return job ID 
-o       Rerurn job ID to “CheckAsyncStatus?” method and give either RUNNING, COMPLETED, or ERROR 
-o       Method name for the method with asynchronous mst be” BeginInvoke methods＋Result” and stae job ID as a parameter 
-•       Required test environment 
-o       Perl: Soap::Lite 0.69 
-o       Ruby: SOAP4R 1.5.5 (Ruby 1.8.6 bundle) 
-o       Python: SOAPpy 0.12.0 
-o       Java: Axis 1.4 
+}}}
+
+ * The list of the formats
+
+{{{
+http://togows.dbcls.jp/entry/DB名/formats
+}}}
+
+== SOAP ==
+
+ * Required test environment
+  * Perl: Soap::Lite 0.69
+  * Ruby: SOAP4R 1.5.5 (Ruby 1.8.6 bundle)
+  * Python: SOAPpy 0.12.0
+  * Java: Axis 1.4
+ * SOAP version 1.2, at least
+ * Calling a method with asynchronous
+  * The name for the method with asynchronous end with “Async” and return job ID
+  * Rerurn job ID to “CheckAsyncStatus?” method and give either RUNNING, COMPLETED, or ERROR
+  * Method name for the method with asynchronous mst be” BeginInvoke methods＋Result” and stae job ID as a parameter
+
+== History ==
+
+ * version [wiki:Manifest2.0_e] (2009/03/20)