In GGDB Web Service, various API that can use the data of GGDB is being offered.
The development of the application using every GGDB Web Service becomes possible because it can access the data of GGDB by using API more easily than the outside.
In GGDB Web Service, API of the REST/SOAP method is being offered.
Please refer to the following API manuals for details of each API.
In GGDB Web Service, API of the REST/SOAP method is being offered.
The environment that can use the HTTP connection is needed to use REST-API.
Moreover, a browser and the programming language like Perl and Java, etc. are necessary.
The sample program of sample URL and SOAP-API of REST has been described in API manual, and refer, please.
| searchSymbol | |
| REST Operation | /search/query+symbol[offset,[limit]][/type] |
|---|---|
| SOAP Operation | searchSymbol |
| Description | The entry list is returned by retrieving Symbol. |
| Operation | searchSymbol |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | symbol (xs:string), type (xs:string), offset (xs:Integer), limit (xs:Integer) |
| Input Description |
symbol: keyword (symbol) type: list or cnt offset: offset value limit: limit value |
| WSDL Output | return (xs:string) |
| Output Description | Detailed list of entry (XML Format) |
| Sample Code |
try {
jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.SearchSymbol req = new jp.jcggdb.webservice.GGDBStub.SearchSymbol(); req.setSymbol("FUT"); req.setType("list"); req.setOffset(0); req.setLimit(5); jp.jcggdb.webservice.GGDBStub.SearchSymbolResponse res = stub.searchSymbol(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | search |
|---|---|
| URI Convention | /search/query+symbol[offset,[limit]][/type] |
| Input | query, type, offset, limit |
| Input Description |
query: keyword (Symbol) type: list or cnt offset: offset value limit: limit value |
| Output | xml |
| Output Description | Detailed list of entry (XML Format) |
| Sample URI |
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/FUT11+symbol/ http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/FUT11+symbol/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/FUT11+symbol/cnt http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/FUT11+symbol/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/FUT11+symbol/1 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/FUT11+symbol/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/FUT11+symbol/1,5/cnt |
| searchDesignation | |
| REST Operation | /search/query+designation[offset,[limit]][/type] |
|---|---|
| SOAP Operation | searchDesignation |
| Description | The entry list is returned by retrieving Designation. |
| Operation | searchDesignation |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | enzyme (xs:string), type (xs:string), offset (xs:Integer), limit (xs:Integer) |
| Input Description |
enzyme: keyword (enzyme) type: list or cnt offset: offset value limit: limit value |
| WSDL Output | return (xs:string) |
| Output Description | Detailed list of entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.SearchDesignation req = new jp.jcggdb.webservice.GGDBStub.SearchDesignation(); req.setEnzyme("a"); req.setType("list"); req.setOffset(0); req.setLimit(5); jp.jcggdb.webservice.GGDBStub.SearchDesignationResponse res = stub.searchDesignation(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| searchAcceptor | |
| REST Operation | /search/query+acceptor[offset,[limit]][/type] |
|---|---|
| SOAP Operation | searchAcceptor |
| Description | The entry list is returned by retrieving Acceptor. |
| Operation | searchAcceptor |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | acceptor (xs:string), type (xs:string), offset (xs:Integer), limit (xs:Integer) |
| Input Description |
acceptor: keyword (acceptor) type: list or cnt offset: offset value limit: limit value |
| WSDL Output | return (xs:string) |
| Output Description | Detailed list of entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.SearchAcceptor req = new jp.jcggdb.webservice.GGDBStub.SearchAcceptor(); req.setAcceptor("aa"); req.setType("list"); req.setOffset(0); req.setLimit(5); jp.jcggdb.webservice.GGDBStub.SearchAcceptorResponse res = stub.searchAcceptor(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | search |
|---|---|
| URI Convention | /search/query+acceptor [offset,[limit]][/type] |
| Input | query, type, offset, limit |
| Input Description |
query: keyword (acceptor) type: list or cnt offset: offset value limit: limit value |
| Output | xml |
| Output Description | Detailed list of entry (XML Format) |
| Sample URI |
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/O-glycan Synthesis+acceptor/ http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/O-glycan Synthesis+acceptor/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/O-glycan Synthesis+acceptor/cnt http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/O-glycan Synthesis+acceptor/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/O-glycan Synthesis+acceptor/1 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/O-glycan Synthesis+acceptor/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/O-glycan Synthesis+acceptor/1,5/cnt |
| searchExpression | |
| REST Operation | /search/query+expression[offset,[limit]][/type] |
|---|---|
| SOAP Operation | searchExpression |
| Description | The entry list is returned by retrieving Expression. |
| Operation | searchExpression |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | specific (xs:string), type (xs:string), offset (xs:Integer), limit (xs:Integer) |
| Input Description |
specific: keyword (specific) type: list or cnt offset: offset value limit: limit value |
| WSDL Output | return (xs:string) |
| Output Description | Detailed list of entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.SearchExpression req = new jp.jcggdb.webservice.GGDBStub.SearchExpression(); req.setSpecific("a"); req.setType("list"); req.setOffset(0); req.setLimit(5); jp.jcggdb.webservice.GGDBStub.SearchExpressionResponse res = stub.searchExpression(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | search |
|---|---|
| URI Convention | /search/query+expression[offset,[limit]][/type] |
| Input | query, type, offset, limit |
| Input Description |
query: keyword (specific) type: list or cnt offset: offset value limit: limit value |
| Output | xml |
| Output Description | Detailed list of entry (XML Format) |
| Sample URI |
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/spleen+expression/ http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/spleen+expression/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/spleen+expression/cnt http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/spleen+expression/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/spleen+expression/1 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/spleen+expression/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/spleen+expression/1,5/cnt |
| searchPMID | |
| REST Operation | /search/query+PMID[offset,[limit]][/type] |
|---|---|
| SOAP Operation | searchPMID |
| Description | The entry list is returned by retrieving PUBMED_ID. |
| Operation | searchPMID |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | PMID (xs:string), type (xs:string), offset (xs:Integer), limit (xs:Integer) |
| Input Description |
PMID: keyword (PMID) type: list or cnt offset: offset value limit: limit value |
| WSDL Output | return (xs:string) |
| Output Description | Detailed list of entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.SearchPMID req = new jp.jcggdb.webservice.GGDBStub.SearchPMID(); req.setPubmed_id("8182079"); req.setType("list"); req.setOffset(0); req.setLimit(5); jp.jcggdb.webservice.GGDBStub.SearchPMIDResponse res = stub.searchPMID(req); System.err.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | search |
|---|---|
| URI Convention | /search/query+PMID[offset,[limit]][/type] |
| Input | query, type, offset, limit |
| Input Description |
query: keyword (PMID) type: list or cnt offset: offset value limit: limit value |
| Output | xml |
| Output Description | Detailed list of entry (XML Format) |
| Sample URI |
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/11278338+PMID/ http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/11278338+PMID/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/11278338+PMID/cnt http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/11278338+PMID/1,5 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/11278338+PMID/1 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/11278338+PMID/1,5/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/11278338+PMID/1,5/cnt |
| getXmlEntry | |
| REST Operation | /entry/symbol[.xml] |
|---|---|
| SOAP Operation | getXmlEntry |
| Description | Detail on entry (XML Format) |
| Operation | getXmlEntry |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | symbol (xs:string) |
| Input Description | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| WSDL Output | return (xs:string) |
| Output Description | Detailed list of entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.GetXmlEntry req = new jp.jcggdb.webservice.GGDBStub.GetXmlEntry(); req.setSymbol("FUT1"); jp.jcggdb.webservice.GGDBStub.GetXmlEntryResponse res = stub.getXmlEntry(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | entry |
|---|---|
| URI Convention | entry/symbol[.xml] |
| Input | symbol (more entry acquisition: FUT1,FUT2,FUT3…) |
| Input Description | symbol |
| Output | xml |
| Output Description | Detail on entry (XML Format) |
| Sample URI |
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1 http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1.xml |
| getTextEntry | |
| REST Operation | /entry/symbol.text |
|---|---|
| SOAP Operation | getTextEntry |
| Description | Detailed information on the GGDB entry is returned by the TEXT form. |
| Operation | getTextEntry |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | symbol (xs:string) |
| Input Description | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| WSDL Output | return (xs:string) |
| Output Description | Detailed list of entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.GetTextEntry req = new jp.jcggdb.webservice.GGDBStub.GetTextEntry(); req.setSymbol("FUT1"); jp.jcggdb.webservice.GGDBStub.GetTextEntryResponse res = stub.getTextEntry(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | entry |
|---|---|
| URI Convention | entry/symbol.text |
| Input | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| Input Description | symbol |
| Output | xml |
| Output Description | Detail on entry (Text Format) |
| Sample URI | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1.text |
| getDraftEntry | |
| REST Operation | /entry/symbol.draft |
|---|---|
| SOAP Operation | getDraftEntry |
| Description | Detailed information on the GGDB entry is returned by the DRAFT TEXT Format. |
| Operation | getDraftEntry |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | symbol (xs:string) |
| Input Description | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| WSDL Output | return (xs:string) |
| Output Description | Detail on entry (Draft Text Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.GetTextEntry req = new jp.jcggdb.webservice.GGDBStub.GetTextEntry(); req.setSymbol("FUT1"); jp.jcggdb.webservice.GGDBStub.GetTextEntryResponse res = stub.getTextEntry(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | entry |
|---|---|
| URI Convention | entry/symbol.draft |
| Input | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| Input Description | symbol |
| Output | xml |
| Output Description | Detail on entry (DRAFT TEXT Format) |
| Sample URI | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1.draft |
| getDesignation | |
| REST Operation | entry/symbol/designation |
|---|---|
| SOAP Operation | getDesignation |
| Description | Return to Designation information. |
| Operation | getDesignation |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | symbol (xs:string) |
| Input Description | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| WSDL Output | return (xs:string) |
| Output Description | Detail on entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.GetDesignation req = new jp.jcggdb.webservice.GGDBStub.GetDesignation(); req.setSymbol("FUT1"); jp.jcggdb.webservice.GGDBStub.GetDesignationResponse res = stub.getDesignation(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | entry |
|---|---|
| URI Convention | entry/symbol/designation |
| Input | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| Input Description | symbol |
| Output | xml |
| Output Description | Detail on entry (XML Format) |
| Sample URI | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1/designation |
| getExpression | |
| REST Operation | entry/symbol/expression |
|---|---|
| SOAP Operation | getExpression |
| Description | Return to Expression information. |
| Operation | getExpression |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | symbol (xs:string) |
| Input Description | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| WSDL Output | return (xs:string) |
| Output Description | Detail on entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.GetExpression req = new jp.jcggdb.webservice.GGDBStub.GetExpression(); req.setSymbol("FUT1"); jp.jcggdb.webservice.GGDBStub.GetExpressionResponse res = stub.getExpression(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | entry |
|---|---|
| URI Convention | entry/symbol/expression |
| Input | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| Input Description | symbol |
| Output | xml |
| Output Description | Detail on entry (XML Format) |
| Sample URI | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1/expression |
| getAcceptor | |
| REST Operation | entry/symbol/acceptor |
|---|---|
| SOAP Operation | getAcceptor |
| Description | Return to Acceptor information. |
| Operation | getAcceptor |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | symbol (xs:string) |
| Input Description | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| WSDL Output | return (xs:string) |
| Output Description | Detail on entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.GetAcceptor req = new jp.jcggdb.webservice.GGDBStub.GetAcceptor(); req.setSymbol("FUT1"); jp.jcggdb.webservice.GGDBStub.GetAcceptorResponse res = stub.getAcceptor(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | entry |
|---|---|
| URI Convention | entry/symbol/acceptor |
| Input | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| Input Description | symbol |
| Output | xml |
| Output Description | Detail on entry (XML Format) |
| Sample URI | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1/acceptor |
| getPMID | |
| REST Operation | entry/symbol/PMID |
|---|---|
| SOAP Operation | getPMID |
| Description | Return to PMID information. |
| Operation | getPMID |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | symbol (xs:string) |
| Input Description | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| WSDL Output | return (xs:string) |
| Output Description | Detail on entry (XML Format) |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.GetPMID req = new jp.jcggdb.webservice.GGDBStub.GetPMID(); req.setSymbol("FUT1"); jp.jcggdb.webservice.GGDBStub.GetPMIDResponse res = stub.getPMID(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | entry |
|---|---|
| URI Convention | entry/symbol/PMID |
| Input | Symbol (more entry acquisition: FUT1,FUT2,FUT3….) |
| Input Description | symbol |
| Output | xml |
| Output Description | Detail on entry (XML Format) |
| Sample URI | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1/PMID |
| getIdList | |
| REST Operation | getIdList[/type[.format]] |
|---|---|
| SOAP Operation | getIdList |
| Description | Return to the list of GeneName and mRNA. |
| Operation | getIdList |
|---|---|
| WSDL | http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl |
| WSDL Input | type (xs:string), format (xs:string) |
| Input Description | type: list or cnt format: xml or text |
| WSDL Output | return (xs:string) |
| Output Description | The list of GeneName and mRNA. |
| Sample Code |
try { jp.jcggdb.webservice.GGDBStub stub = new jp.jcggdb.webservice.GGDBStub(); jp.jcggdb.webservice.GGDBStub.GetIdList req = new jp.jcggdb.webservice.GGDBStub.GetIdList(); req.setFormat("xml"); req.setType("list"); jp.jcggdb.webservice.GGDBStub.GetIdListResponse res = stub.getIdList(req); System.out.println(res.get_return()); } catch (Throwable e) { e.printStackTrace(); } |
| Operation | getIdList |
|---|---|
| URI Convention | getIdList[/type[.format]] |
| Input | type, format |
| Input Description |
type: list or cnt format: xml or text |
| Output | xml |
| Output Description | The list of GeneName and mRNA. |
| Sample URI |
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/getIdList http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/getIdList/list http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/getIdList/list.text http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/getIdList/cnt http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/getIdList/cnt.text |
When Search and Entry is processed, the empty entries of 0 the result are returned. As for REST, status becomes 404.

REST returns 404 status when the error occurs when executing it, and the error screen is displayed.
The processing of the error is left to the client though SOAP returns SOAP Fault.
©2008 Research Center for Medical Glycoscience, National Institute of Advanced Industrial Science and Technology (AIST)