[English]

GGDB Web Service API マニュアル

1. GGDB Web Serviceとは?

GGDB Web Serviceでは、GGDBのデータを利用することができる様々なAPIを提供しています。

APIを利用することにより外部より簡単にGGDBのデータにアクセスできるので、どなたでもGGDB Web Serviceを利用したアプリケーションの開発が可能になります。

2. どのようなサービスを提供しているのか?

GGDB Web Serviceでは、REST/SOAP方式のAPIを提供しています。

各APIの詳細については後述のAPIマニュアルをご参照ください。

3. どうやって利用するのか?

GGDB Web Serviceでは、REST/SOAP方式のAPIを提供しています。

REST-APIを使用するには、HTTPコネクションを使用できる環境が必要になります。

またブラウザや、Perl、Javaのようなプログラミング言語が必要です。

APIマニュアルにはRESTのサンプルURLやSOAP-APIのサンプルプログラムも記載していますので、ご参照ください。

4. APIマニュアル

searchSymbol
REST Operation /search/query+symbol[offset,[limit]][/type]
SOAP Operation searchSymbol
Description Symbol情報を検索して、エントリ一覧を返す
SOAP
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: 検索したいキーワード(symbol)
type: list or cnt
offset: オフセット値
limit: 取得件数
WSDL Output return (xs:string)
Output Description エントリの詳細情報一覧(XML形式)
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();
}
REST
Operation search
URI Convention /search/query+symbol[offset,[limit]][/type]
Input query, type, offset, limit
Input Description query: 検索したいキーワード (Symbol)
type: list or cnt
offset: オフセット値
limit: 取得件数
Output xml
Output Description エントリの詳細情報一覧(XML形式)
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 Designation情報を検索して、エントリ一覧を返す
SOAP
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: 検索したいキーワード(enzyme)
type: list or cnt
offset: オフセット値
limit: 取得件数
WSDL Output return (xs:string)
Output Description エントリの詳細情報一覧(XML形式)
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();
}
REST
Operation search
URI Convention /search/query+designation[offset,[limit]][/type]
Input query, type, offset, limit
Input Description query: 検索したいキーワード (enzyme)
type: list or cnt
offset: オフセット値
limit: 取得件数
Output xml
Output Description エントリの詳細情報一覧(XML形式)
Sample URI http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/alpha1,3-N-acetylgalactosaminytransferase+designation/
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/alpha1,3-N-acetylgalactosaminytransferase+designation/list
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/alpha1,3-N-acetylgalactosaminytransferase+designation/cnt
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/alpha1,3-N-acetylgalactosaminytransferase+designation/1,5
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/alpha1,3-N-acetylgalactosaminytransferase+designation/1
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/alpha1,3-N-acetylgalactosaminytransferase+designation/1,5/list
http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/search/alpha1,3-N-acetylgalactosaminytransferase+designation/1,5/cnt
searchAcceptor
REST Operation /search/query+acceptor[offset,[limit]][/type]
SOAP Operation searchAcceptor
Description Acceptor情報を検索して、エントリ一覧を返す
SOAP
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: 検索したいキーワード(acceptor)
type: list or cnt
offset: オフセット値
limit: 取得件数
WSDL Output return (xs:string)
Output Description エントリの詳細情報一覧(XML形式)
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();
}
REST
Operation search
URI Convention /search/query+acceptor [offset,[limit]][/type]
Input query, type, offset, limit
Input Description query: 検索したいキーワード (acceptor)
type: list or cnt
offset: オフセット値
limit: 取得件数
Output xml
Output Description エントリの詳細情報一覧(XML形式)
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 Expression情報を検索して、エントリ一覧を返す
SOAP
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: 検索したいキーワード(specific)
type: list or cnt
offset: オフセット値
limit: 取得件数
WSDL Output return (xs:string)
Output Description エントリの詳細情報一覧(XML形式)
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();
}
REST
Operation search
URI Convention /search/query+expression[offset,[limit]][/type]
Input query, type, offset, limit
Input Description query: 検索したいキーワード (specific)
type: list or cnt
offset: オフセット値
limit: 取得件数
Output xml
Output Description エントリの詳細情報一覧(XML形式)
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 PUBMED_ID情報を検索して、エントリ一覧を返す
SOAP
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: 検索したいキーワード(PMID)
type: list or cnt
offset: オフセット値
limit: 取得件数
WSDL Output return (xs:string)
Output Description エントリの詳細情報一覧(XML形式)
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();
}
REST
Operation search
URI Convention /search/query+PMID[offset,[limit]][/type]
Input query, type, offset, limit
Input Description query: 検索したいキーワード (PMID)
type: list or cnt
offset: オフセット値
limit: 取得件数
Output xml
Output Description エントリの詳細情報一覧(XML形式)
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 GGDBエントリの詳細情報をXML形式で返す
SOAP
Operation getXmlEntry
WSDL http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl
WSDL Input symbol (xs:string)
Input Description 任意のSymbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
WSDL Output return (xs:string)
Output Description エントリの詳細情報一覧(XML形式)
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();
}
REST
Operation entry
URI Convention entry/symbol[.xml]
Input symbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
Input Description 任意のSymbol
Output xml
Output Description エントリの詳細情報(XML形式)
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 GGDBエントリの詳細情報をTEXT形式で返す
SOAP
Operation getTextEntry
WSDL http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl
WSDL Input symbol (xs:string)
Input Description 任意のSymbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
WSDL Output return (xs:string)
Output Description エントリの詳細情報一覧(XML形式)
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();
}
REST
Operation entry
URI Convention entry/symbol.text
Input symbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
Input Description 任意のSymbol
Output xml
Output Description エントリの詳細情報(XML形式)
Sample URI http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1.text
getDraftEntry
REST Operation /entry/symbol.draft
SOAP Operation getDraftEntry
Description GGDBエントリの詳細情報をドラフトテキスト形式で返す
SOAP
Operation getDraftEntry
WSDL http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl
WSDL Input symbol (xs:string)
Input Description 任意のSymbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
WSDL Output return (xs:string)
Output Description エントリの詳細情報一覧(ドラフトテキスト形式)
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();
}
REST
Operation entry
URI Convention entry/symbol.draft
Input symbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
Input Description 任意のSymbol
Output xml
Output Description エントリの詳細情報(ドラフトテキスト形式)
Sample URI http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1.draft
getDesignation
REST Operation entry/symbol/designation
SOAP Operation getDesignation
Description 任意のDesignation情報を返す
SOAP
Operation getDesignation
WSDL http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl
WSDL Input symbol (xs:string)
Input Description 任意のSymbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
WSDL Output return (xs:string)
Output Description エントリの詳細情報(XML形式)
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();
}
REST
Operation entry
URI Convention entry/symbol/designation
Input symbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
Input Description 任意のSymbol
Output xml
Output Description エントリの詳細情報(XML形式)
Sample URI http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1/designation
getExpression
REST Operation entry/symbol/expression
SOAP Operation getExpression
Description 任意のExpression情報を返す
SOAP
Operation getExpression
WSDL http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl
WSDL Input symbol (xs:string)
Input Description 任意のSymbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
WSDL Output return (xs:string)
Output Description エントリの詳細情報(XML形式)
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();
}
REST
Operation entry
URI Convention entry/symbol/expression
Input symbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
Input Description 任意のSymbol
Output xml
Output Description エントリの詳細情報(XML形式)
Sample URI http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1/expression
getAcceptor
REST Operation entry/symbol/acceptor
SOAP Operation getAcceptor
Description 任意のAcceptor情報を返す
SOAP
Operation getAcceptor
WSDL http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl
WSDL Input symbol (xs:string)
Input Description 任意のSymbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
WSDL Output return (xs:string)
Output Description エントリの詳細情報(XML形式)
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();
}
REST
Operation entry
URI Convention entry/symbol/acceptor
Input symbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
Input Description 任意のSymbol
Output xml
Output Description エントリの詳細情報(XML形式)
Sample URI http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1/acceptor
getPMID
REST Operation entry/symbol/PMID
SOAP Operation getPMID
Description 任意のPMID情報を返す
SOAP
Operation getPMID
WSDL http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/services/GGDB?wsdl
WSDL Input symbol (xs:string)
Input Description 任意のSymbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
WSDL Output return (xs:string)
Output Description エントリの詳細情報(XML形式)
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();
}
REST
Operation entry
URI Convention entry/symbol/PMID
Input symbol (カンマ区切りで複数エントリ取得可: FUT1,FUT2,FUT3…)
Input Description 任意のSymbol
Output xml
Output Description エントリの詳細情報(XML形式)
Sample URI http://riodb.ibase.aist.go.jp/rcmg/ws/ggdb/entry/FUT1/PMID
getIdList
REST Operation getIdList[/type[.format]]
SOAP Operation getIdList
Description GeneNameとmRNAの一覧を返す
SOAP
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 GeneNameと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();
}
REST
Operation getIdList
URI Convention getIdList[/type[.format]]
Input type, format
Input Description type: list or cnt
format: xml or text
Output xml
Output Description GeneNameと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

5. 共通仕様

5.1. 処理時の結果が0件の場合

Search及びEntry処理時に結果が0件の場合、空エントリを返す。RESTは、ステータスが404になる。


5.2. 実行中エラーの処理

実行時にエラーが発生した場合、RESTは404ステータスを返し、エラー画面が表示される。

5.3. SOAP Fault

SOAPはSOAP Faultを返すが、エラーの処理については各クライアントに任せられる。

SOAP Input 正常時
<?xml version='1.0' encoding='utf-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:typens=http://webservice.jcggdb.jp
        xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
        xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 <soap:Body>
  <typens:getIdList>
   <format xsi:type="xsd:string">text</format>
   <type xsi:type="xsd:string">list</type>
  </typens:getIdList>
 </soap:Body>
</soap:Envelope>
SOAP Output 正常時
<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
 <soapenv:Body>
  <ns:getIdListResponse xmlns:ns="http://webservice.jcggdb.jp">
   <ns:return>
    FUT1 NM_000148
    FUT2 NM_000511
    …
    SLC35D2 NM_007001
    beta3Glc-T NM_194318
   </ns:return>
  </ns:getIdListResponse>
 </soapenv:Body>
</soapenv:Envelope>
SOAP Input エラー時
※ Requestのパラメータが不足
<?xml version='1.0' encoding='utf-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:typens=http://webservice.jcggdb.jp
        xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
        xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 <soap:Body>
  <typens:getIdList>
   <format xsi:type="xsd:string">text</format>
  </typens:getIdList>
 </soap:Body>
</soap:Envelope>
SOAP Output エラー時
※ SOAP Faultを返す
<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
 <soapenv:Body>
  <soapenv:Fault>
   <faultcode>soapenv:Server</faultcode>
   <faultstring>
    Exception occurred while trying to invoke service method getIdList
   </faultstring>
   <detail />
  </soapenv:Fault>
 </soapenv:Body>
</soapenv:Envelope>

©2008 Research Center for Medical Glycoscience, National Institute of Advanced Industrial Science and Technology (AIST)