1. Introduction
  2. REST servises
  3. SOAP servises
  4. List of REST APIs
  5. List of SOAP APIs
  6. Sample codes with SOAP or REST APIs.

Introduction

VarySysDB Web service provide the various REST and SOAP APIs to use VarySysDB data.
Any one can use the service to develop the application using VarySysDB Web service.

REST servises

To connect to the REST service you need an environment of HTTP connection (e.g. web browser) and the programming language (e.g. Perl or JAVA).

To use the VarySysDB Web service, please call the methods and parameters to [http://h-invitational.jp/hinv/hws/varysysdb/] as below;
http://h-invitational.jp/hinv/hws/varysysdb/search/hogehoge+definition/
The POST access are approved, but the GET access may also be possible.

SOAP servises

To connect to the SOAP service, please use SOAP library of programing languages.
Please access the following to connect to WSDL.
http://h-invitational.jp/hinv/hws/varysysdb/API_name?wsdl

List of REST APIs

Requests for polymorphism annotation data

No.OverviewURL
1 Search SNP ID (RS_number) by specifing the search key*1 and query*2. http://h-invitational.jp/hinv/hws/varysysdb/search/606953+omim_id/
http://h-invitational.jp/hinv/hws/varysysdb/search/FAM39B+definition/
http://h-invitational.jp/hinv/hws/varysysdb/search/HIT000022181+hit/
http://h-invitational.jp/hinv/hws/varysysdb/search/HIX0000001+hix/
2 Search SNP IDs (RS_number) by specifing multiple search keies and queries. http://h-invitational.jp/hinv/hws/varysysdb/search/HIX0000001,HIX0000002,HIX0000003+hix/
3 Specify the genomic location (e.g. chr6, 1-1000000). http://h-invitational.jp/hinv/hws/varysysdb/search/chr6:1-1000000+map/
4 Specify the offset and limit for the request (e.g. 0-100). http://h-invitational.jp/hinv/hws/varysysdb/search/chr6:1-1000000+map/0,100/
5 Fetch the number of the hits. http://h-invitational.jp/hinv/hws/varysysdb/search/BC053657+accession/count/
6 Fetch xml data by specifing SNP ID (RS_number) query. http://h-invitational.jp/hinv/hws/varysysdb/entry/rs1578391/
7 Fetch mapping data by specifing SNP ID (RS_number) query. http://h-invitational.jp/hinv/hws/varysysdb/entry/rs1578391+map/
8 Fetch "genomic polymorphism annotation" data by specifing SNP ID (RS_number) query. http://h-invitational.jp/hinv/hws/varysysdb/entry/rs1578391+genomic_polymorphism/
9 Fetch "polymorphism features" data by specifing SNP IDs (RS_number) query. http://h-invitational.jp/hinv/hws/varysysdb/entry/rs1578391+polymorphism_feature/
10 Fetch "polymorphism effects" data by specifing SNP ID (RS_number) query. http://h-invitational.jp/hinv/hws/varysysdb/entry/rs1578391+polymorphism_effect/
11 Fetch "transcript polymorphism" data by specifing SNP ID (RS_number) query. http://h-invitational.jp/hinv/hws/varysysdb/entry/rs1578391+transcript_polymorphism/
12 Fetch "translation polymorphism" data by specifing SNP ID (RS_number) query. http://h-invitational.jp/hinv/hws/varysysdb/entry/rs1578391+translation_polymorphism/

*1 strings which can be used as seach keys
hit / hix / accession / chromosome / band / definition / db_snp / interpro_id / interpro_name / omim_id
*2 case insensitive, parfect match for all types of queries except for "definition", where patial match are allowed.

Requests for Short Tandem Repeat (STR) data

No.OverviewURL
1 Fetch HIT IDs by specify the genomic location (e.g. chr1, 1-1000000). http://h-invitational.jp/hinv/hws/varysysdb/search_short_tandem_repeat/chr1:1-1000000/
2 Fetch HIT IDs by specify the genomic location and the offset and limit for the request (e.g. chr1, 1-1000000 and 0-100). http://h-invitational.jp/hinv/hws/varysysdb/search_short_tandem_repeat/chr1:1-10000000/100,50/
3 Fetch "Short Tandem Repeat (STR)" data by specifing HIT ID as query. http://h-invitational.jp/hinv/hws/varysysdb/short_tandem_repeat/HIT000249846/

Requests for Copy Number Variation (CNV) data

No.OverviewURL
1 Fetch Variation_ID (CNV ID) by specify the genomic location (e.g. chr1, 1-1000000). http://h-invitational.jp/hinv/hws/varysysdb/search_copy_number_variation/chr1:1-10000000/
2 Fetch Variation_ID (CNV ID) by specify the genomic location and the offset and limit for the request (e.g. chr1, 1-1000000 and 0-100). http://h-invitational.jp/hinv/hws/varysysdb/search_copy_number_variation/chr1:1-10000000/10,20/
3 Fetch "Copy Number Variation (CNV)" data by specifing Variation_ID (CNV ID) as query. http://h-invitational.jp/hinv/hws/varysysdb/copy_number_variation/Variation_2041/

List of SOAP APIs

Requests for polymorphism annotation data

No.API nameOverviewwsdl
1 soap_search_rs_number.php Search SNP ID (RS_number) by specifing the search key*1 and query*2. soap_search_rs_number.php?wsdl
2 soap_get_record.php Fetch xml data by specifing SNP ID (RS_number) query. soap_get_record.php?wsdl
3 soap_get_record_genomic_polymorphism.php Fetch "genomic polymorphism annotation" data by specifing SNP ID (RS_number) query. soap_get_record_genomic_polymorphism.php?wsdl
4 soap_get_record_polymorphism_feature.php Fetch "polymorphism features" data by specifing SNP IDs (RS_number) query. soap_get_record_polymorphism_feature.php?wsdl
5 soap_get_record_polymorphism_effect.php Fetch "polymorphism effects" data by specifing SNP ID (RS_number) query. soap_get_record_polymorphism_effect.php?wsdl
6 soap_get_record_transcript_polymorphism.php Fetch "transcript polymorphism" data by specifing SNP ID (RS_number) query. soap_get_record_transcript_polymorphism.php?wsdl
7 soap_get_record_translation_polymorphism.php Fetch "translation polymorphism" data by specifing SNP ID (RS_number) query. soap_get_record_translation_polymorphism.php?wsdl
*1 strings which can be used as seach keys
hit / hix / accession / chromosome / band / definition / db_snp / interpro_id / interpro_name / omim_id
*2 case insensitive, parfect match for all types of queries except for "definition", where patial match are allowed.

Requests for Short Tandem Repeat (STR) data

No.API nameOverviewwsdl
1 soap_search_short_tandem_repeat.php Fetch HIT IDs by specify the genomic location (e.g. chr1, 1-1000000). soap_search_short_tandem_repeat.php?wsdl
2 soap_get_short_tandem_repeat.php Fetch "Short Tandem Repeat (STR)" data by specifing HIT ID as query. soap_get_short_tandem_repeat.php?wsdl

Requests for Copy Number Variation (CNV) data

No.API nameOverviewwsdl
1 soap_search_copy_number_variation.php Fetch Variation_ID (CNV ID) by specify the genomic location (e.g. chr1, 1-1000000). soap_search_copy_number_variation.php?wsdl
2 soap_get_copy_number_variation.php Fetch "Copy Number Variation (CNV)" data by specifing Variation_ID (CNV ID) as query. soap_get_copy_number_variation.php?wsdl

Sample codes

Here are the sample codes with SOAP or REST APIs.
Perl sample codes with REST
PHP sample codes with REST
Ruby sample codes with REST
Java sample codes with REST
Perl sample codes with SOAP
PHP sample codes with SOAP
Ruby sample codes with SOAP
Java sample codes with SOAP


This servise is in following accodances.
http://www.pageom.org/Home.html
http://togows.dbcls.jp/site/en/index.html