辞書検索サービス v08

v08は古いバージョンです。
今後は最新バージョンのv10をご利用ください。
http://www.btonic.com/ws/NetDicv10Spec.htm

Webサービス・インタフェースの詳細

辞書WebサービスのURL：
http://btonic.est.co.jp/NetDic/NetDicv08.asmx
インターフェース定義（WSDL）：
http://btonic.est.co.jp/NetDic/NetDicv08.asmx?WSDL
Setup付サンプルプログラム：
NetDicTestOEMSetup.msi
C#のソースコードによる定義：
Visual Studio .NET/C# によるサーバー側のソースコードの一部です。
各methodの解説：

GetDicList （SOAP呼び出し例）
使用可能な辞書のリストを取得するmethodです。各辞書についての各種の情報が DicInfo 構造体で返されます。
  • 戻り値
    リターン値：成功(true)／失敗(false)
    DicInfoList：使用可能な辞書の辞書情報（DicInfo構造体）の配列
    • DicInfo構造体
      DicID：辞書ID
      FullName：辞書の正式名称
      ShortName：辞書の短縮名（16文字以下
      Publisher：出版社名
      Abbrev：内部用識別名（英数8文字以下）
      LogoURL：バナー画像URL
      StartItemID：初期表示項目ID
      ScopeList：指定可能な検索対象（Scope）の配列
      SearchOptionList：この辞書で推奨される検索方法（SearchOption）の配列
      DefSearchOptionIndex：この辞書のデフォルトの検索方法（SearchOptionList中のインデックス）
      ItemMapList：この辞書の項目マップの配列（内部用）
    ErrorMessage：エラー発生時のエラーメッセージ

SearchDicItem （SOAP呼び出し例）
検索を実行するmethodです。辞書・検索語・検索オプションを指定して検索し、見つかった辞書項目の一覧を取得します。
見つかった項目の内容は、次の GetDicItem でひとつづつ取得することも出来ますし、この method で検索と同時に内容も一緒に取得してしまうことも出来ます。
見つかった項目が多い場合に複数回に分けて取得することもできます。

  • 検索条件指定のパラメータ
    DicIDList：検索対象辞書IDの配列（複数指定により串刺し(=OR)検索となる）
    QueryList：Query構造体の配列（複数指定によりAND/OR検索）
    • Query構造体
      Words：検索文字列
      ScopeID：検索対象。指定可能な ScopeID は辞書によって異なり、GetDicInfo で取得する。（DicInfo構造体の ScopeList）
      ただし、見出し語検索(HEADWORD)/全文検索(ANYWHERE)の２つはすべての辞書で使用可能。三省堂辞書の場合、成句検索(IDIOM) も英和・仏和・独和で共通に使用可能。
      MatchOption：一致条件指定。完全一致(EXACT)/部分一致(CONTAIN)/前方一致(STARTWITH)/後方検索(ENDWITH)
      MergeOption：検索結果の併合方法。それまでの併合結果とAND(AND)/それまでの併合結果とOR(OR)

  • 取得データの形式指定のパラメータ
    FormatOption：テキストデータの形式。V08ではHTMLに固定。
    ResourceOption：バイナリデータの形式。V08ではURIに固定。
    CharsetOption：テキストとして使用する文字の範囲。範囲外の文字は、インライン画像として返される。これは決して送受するデータの encoding を指定するものではないので注意。
    UNICODEの文字すべて+EGIX仕様による文字鏡の文字（MOJIKYO）／ UNICODEの文字すべて（UNICODE）／日本語Windows環境で表示出来る文字（WINJPENV）／ JIS範囲の文字のみ（JIS）

  • 検索結果一覧の取得数指定のパラメータ
    ReqItemIndex：何番目から取得するか(*A)
    ReqItemTitleCount：何個を取得するか(*B)
    ReqItemContentCount：何個について内容も同時に取得するか(*C)

    検索結果の全項目のうち、A 番目から始めて B個の項目(DicItem)が返されます。
    返される B 個のうち、先頭の C個の項目については、DicItem構造体の Head, Body 部分まですべてメンバーに値がセットされます。C個目以降については Head, Body 部分は空で、DicID, ItemID, Title だけがセットされます。

    使用例１： A=0, B=40, C=0 → 先頭40個のタイトルだけ取得。
    使用例２： A=0, B=10, C=10 → 先頭10個の内容までを全て取得。
    使用例３： A=0, B=20, C=1 → 先頭20個のタイトルと先頭1個だけは内容も取得。

  • 戻り値
    リターン値：成功(true)／失敗(false)
    ItemCountTotal：見つかった項目の総数
    ItemCountInList：ItemList配列で返される項目(DicItem)の数
    ItemList：辞書項目（DicItem構造体）の配列
    • DicItem構造体
      DicID：辞書ID
      ItemID：項目ID
      Title：項目の見出し（V08 では HTML形式）
      Head：見出し部の内容（V08 では HTML形式）
      Body：本文の内容（V08 では HTML形式）
    ErrorMessage：エラー発生時のエラーメッセージ


GetDicItem （SOAP呼び出し例）
辞書項目の内容を取得する method です。
辞書IDと項目IDを指定して、ひとつづつ内容を取得します。

  • 取得データの形式指定のパラメータ
    FormatOption：テキストデータの形式。V08ではHTMLに固定。
    ResourceOption：バイナリデータの形式。V08ではURIに固定。
    CharsetOption：テキストとして使用する文字の範囲。範囲外の文字は、インライン画像として返される。これは決して送受するデータの encoding を指定するものではないので注意。
    UNICODEの文字すべて+EGIX仕様による文字鏡の文字（MOJIKYO）／ UNICODEの文字すべて（UNICODE）／日本語Windows環境で表示出来る文字（WINJPENV）／ JIS範囲の文字のみ（JIS）

  • 戻り値
    リターン値：成功(true)／失敗(false)
    DicItem：取得した辞書項目
    • DicItem構造体
      DicID：辞書ID
      ItemID：項目ID
      Title：項目の見出し（V08 では HTML形式）
      Head：見出し部の内容（V08 では HTML形式）
      Body：本文の内容（V08 では HTML形式）
    ErrorMessage：エラー発生時のエラーメッセージ