Changes between Version 12 and Version 13 of GuidelineForWebService

Show
Ignore:
Timestamp:
2009/03/20 16:32:43 (15 years ago)
Author:
chisato-yamasaki
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GuidelineForWebService

    v12 v13  
    2323   * When any error occurs during processing at a server, a method  
    2424  
    25  * TogoWS Guidelines 
    2625 
    27 REST 
     26= TogoWS TogoWS Guidelines = 
    2827 
    29 TogoWS stated the rulers below:  
    30 •       http://togows.dbcls.jp/site/services.html  
    31 •       http://togows.dbcls.jp/site/rest.html  
    32 •        
    33 How to call the entries 
    34         http://togows.dbcls.jp/entry/database/entry_id[,entry_id2,...]/field[.format] 
    35 # How to include the name space of the databases in URL:  
    36 •       http://frnadb.example.org/entry/id instead of http://frnadb.example.org/entry/frnadb/id 
    37 # How to add the name spaces for the institution, release_numer of the database:  
    38 •       http://togows.dbcls.jp/entry/birc-hinv-5.0/HIT0012345  
     28== REST == 
     29 
     30TogoWS stated the rulers as below: 
     31 
     32 * http://togows.dbcls.jp/site/services.html 
     33 * http://togows.dbcls.jp/site/rest.html 
     34 
     35=== How to call the entries === 
     36 
     37{{{ 
     38http://togows.dbcls.jp/entry/database/entry_id[,entry_id2,...]/field[.format] 
     39}}} 
     40 
     41How to include the name space of the databases in URL: 
     42 
     43 * http://frnadb.example.org/entry/id instead of http://frnadb.example.org/entry/frnadb/id 
     44 
     45How to add the name spaces for the institution, release_numer of the database:  
     46 
     47 * http://togows.dbcls.jp/entry/birc-hinv-5.0/HIT0012345 
     48 
    3949NOTE: 
    4050The default fotmat for the entries is “.txt”, and can be in the specified format by adding the suffix, such as “.xml”.  
    41 How to search the entries 
     51 
     52エントリの部分要素取得について: 
     53 
     54エントリの一部を field 名で取得できる機能は !BioRuby/BioPerl を利用した TogoWS の拡張ですが、 
     55バックエンドが XML データベースの場合など、field の代わりに XPath を利用することも検討可能。 
     56 
     57=== How to search the entrie === 
     58 
     59{{{ 
    4260http://togows.dbcls.jp/search/database/query+string[.format][/offset,limit[.format]]  
    4361http://togows.dbcls.jp/search/database/query+string/count 
    44 The format of "query string" to be based on “Common Query Language“ 
     62}}} 
    4563 
    46 The conversion and data format and ID 
     64he format of "query string" to be based on “Common Query Language" [http://en.wikipedia.org/wiki/Common_Query_Language Common Query Language] 
     65 
     66=== The conversion and data format and ID === 
     67 
     68{{{ 
    4769http://togows.dbcls.jp/convert/data_source.format 
    48 Metadata 
    49 •       The list of the databases 
     70}}} 
     71 
     72=== Metadata === 
     73 
     74 * The list of the databases 
     75 
     76{{{ 
    5077http://togows.dbcls.jp/entry/ 
    51 •       The list of the fields 
     78http://togows.dbcls.jp/search/ 
     79}}} 
     80 
     81 * The list of the fields 
     82 
     83{{{ 
    5284http://togows.dbcls.jp/entry/DB名/ 
    53 •       The list of the formats 
    54 http://togows.dbcls.jp/entry/DB_name/formats 
    55 SOAP 
    56 •        Calling a method with asynchronous 
    57 o       The name for the method with asynchronous end with “Async” and return job ID  
    58 o       Rerurn job ID to “CheckAsyncStatus?” method and give either RUNNING, COMPLETED, or ERROR  
    59 o       Method name for the method with asynchronous mst be” BeginInvoke methods+Result” and stae job ID as a parameter  
    60 •       Required test environment  
    61 o       Perl: Soap::Lite 0.69  
    62 o       Ruby: SOAP4R 1.5.5 (Ruby 1.8.6 bundle)  
    63 o       Python: SOAPpy 0.12.0  
    64 o       Java: Axis 1.4  
     85}}} 
     86 
     87 * The list of the formats 
     88 
     89{{{ 
     90http://togows.dbcls.jp/entry/DB名/formats 
     91}}} 
     92 
     93== SOAP == 
     94 
     95 * Required test environment 
     96  * Perl: Soap::Lite 0.69 
     97  * Ruby: SOAP4R 1.5.5 (Ruby 1.8.6 bundle) 
     98  * Python: SOAPpy 0.12.0 
     99  * Java: Axis 1.4 
     100 * SOAP version 1.2, at least 
     101 * Calling a method with asynchronous 
     102  * The name for the method with asynchronous end with “Async” and return job ID 
     103  * Rerurn job ID to “CheckAsyncStatus?” method and give either RUNNING, COMPLETED, or ERROR 
     104  * Method name for the method with asynchronous mst be” BeginInvoke methods+Result” and stae job ID as a parameter 
     105 
     106== History == 
     107 
     108 * version [wiki:Manifest2.0_e] (2009/03/20)