SOAP版API

サービスの定義(WSDL)

サービスの稼働URL

無償公開サービスのURLです。365日24時間動作していますが稼働保証はございません。

本運用のサービスは多重化されたサーバで常時稼動させています。

商用サービスのURLは契約にしたがって開示させていただいております。

辞書検索サービスの使い方

辞書検索サービスを使って辞書を検索し表示する場合の一般的な手順です。

  1. GetDicListで呼び出し可能な辞書の一覧を取得
  2. SearchDicItemで辞書を検索
  3. GetDicItemで辞書項目を取得
  4. 取得した結果を画面に表示

メソッド

GetDicList

使用可能な辞書のリストを取得するメソッドです。

各辞書についての各種の情報が DicInfo 構造体で返されます。

引数

AuthTicket 認証チケット文字列です。
認証チケットの取得方法は別途契約により開示されます。
認証なしで無償の辞書にアクセスする場合には空文字列を指定してください。

戻り値 DicInfo構造体の配列

DicInfo構造体

使用可能な辞書の辞書情報を表します。

DicInfo
DicID 辞書ID
FullName 辞書の正式名称
ShortName 辞書の短縮名(16文字以下)
Publisher 出版社名
Abbrev 内部用識別名(英数字8文字以下)
StartItemID 初期表示項目ID
ScopeList Scope構造体の配列
SearchOptionList ScopeOption構造体の配列
DefSearchOptionIndex SearchOptionListのインデックス値。
この辞書のデフォルトの検索方法を示します。
ItemMapList この辞書の項目マップの配列(内部用の情報です。使用しないでください。)

SearchDicItem

辞書を検索するメソッドです。辞書・検索語・検索オプションを指定して検索し、見つかった辞書項目の一覧を取得します。

見つかった項目の内容は、GeDicImteメソッドでひとつづつ取得することも出来ますし、このメソッドで検索と同時に内容も一緒に取得してしまうことも出来ます。

見つかった項目が多い場合に複数回に分けて取得することもできます。

引数

AuthTicket 認証チケット文字列です。 認証チケットの取得方法は別途契約により開示されます。 認証なしで無償の辞書にアクセスする場合には空文字列を指定してください。
DicIdList 辞書のId一覧。Guidの配列。 Guidは XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX 形式の文字列です。 GetDicListで取得した辞書ID(DicID)を指定します。 複数のDicIDを指定すると辞書の串刺し(=OR)検索ができます。
QueryList Query構造体の配列。
Queryを複数指定することにによりAND/OR検索ができます。
ContentProfile ContentProfile構造体
SortOrderID 空文字列を指定してください。(将来ソート機能を追加するために予約してあります)
ItemStartIndex 何番目の項目から取得するかを指定します。(*A)
ItemCount 何個の項目を取得するか指定します。(*B)
CompleteItemCount 何個について内容も同時に取得するかを指定します。(*C)

検索結果一覧の取得数指定のパラメータ

検索結果の全項目のうち、A 番目から始めて B個の項目(DicItem)が返されます。

返される B 個のうち、先頭の C個の項目については、DicItem構造体の Head, Body 部分まですべてメンバーに値がセットされます。

C個目以降については Head, Body 部分は空で、DicID, ItemID, Title だけがセットされます。

使用例1: A=0, B=40, C=0 → 先頭40個のタイトルだけ取得。

使用例2: A=0, B=10, C=10 → 先頭10個の内容までを全て取得。

使用例3: A=0, B=20, C=1 → 先頭20個のタイトルと先頭1個だけは内容も取得。

戻り値

SearchDicItemResult 見つかった項目の総数です。
ItemList 配列で返される項目数は、ItemCount の数で 制限されているので、返されなかったものも含めていくつの項目が辞書内で見つかったかを返します。
ItemList DicItem構造体の配列。

GetDicItem

辞書項目の内容を取得するメソッドです。

辞書IDと項目IDを指定して、ひとつの項目のデータを取得します。

引数

AuthTicket 認証チケット文字列です。認証チケットの取得方法は別途契約により開示されます。 認証なしで無償の辞書にアクセスする場合には空文字列を指定してください。
DicID 辞書のIDです。
Guidで指定します。
Guidは XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX 形式の文字列です。
SearchDicItemメソッドで取得したDicItemのDicIDを指定してください。
ItemID 取得する項目のIDです。
SearchDicItemメソッドで取得したDicItemのItemIDを指定してください。
LocID 取得する項目のIDです。
項目内の特定の場所を指定するIDです。
ContentProfile ContentProfile構造体
QueryListForHighlight Query構造体の配列。
全文検索でヒットした語をハイライト表示したい場合に使用するものですが、通常は指定する必要はありません。

戻り値

DicID 辞書のID
ItemID 項目のID
LocID 項目内の特定の場所を指定するID
Title 項目の見出し
Head 見出し部の内容
Body 本文の内容

GetExactWords

完全一致する検索語候補を取得するメソッドです。

検索語を入力している途中にバックグラウンドで先読み検索を行い、入力補完した検索語の候補リストを表示させたいような時に使用する機能です。

内部動作としては、

  • 指定した検索条件で検索する
  • ヒットした項目それぞれについて、検索語と一致したキーワード表記を抽出
  • 抽出したキーワード表記をソートし、重複を削除
  • 結果のキーワードリストを候補として返す

というものです。

これで返されたキーワードで通常の検索を行えば、完全一致する項目が最低ひとつは存在することが保証されることになります。

引数

AuthTicket 認証チケット文字列です。
DicIdList 辞書のIDの一覧です。Guidの配列で指定します。
Word 検索文字列です。
ScopeID 検索対象のScopeのID(文字列)です。
MatchOption 一致条件(列挙型)です。
MaxCount 検索語候補を最大何個取得するかを指定します。

戻り値

文字列の配列が返されます。

制限事項

Method の性質上、検索語・検索条件は1種類しか指定できない仕様になっています。

また、全文検索(ScopeID="ANYWHERE")の場合にはこの機能自体が意味を持たないので、候補は0件で返ります。

GetItemMapNodes

内部用Methodのため使用しないでください

主な構造体

Scope

指定可能な検索対象をあらわします。

ID ScopeのID
Name Scopeの名称

ScopeOption

推奨する検索方法をあらわします。

Name ScopeOptionの名称
ScopeID ScopeのID
MatchOption マッチ方法の指定
STARTWITH
前方一致
ENDWITH
後方一致
EXACT
完全一致
CONTAIN
部分一致

Query

Words 検索文字列
ScopeID 検索対象のScopeのIDを指定します。
指定可能な ScopeID は辞書によって異なり、GetDicInfo で取得します。(DicInfo構造体のScopeList)。
ただし、見出し語検索(HEADWORD)/全文検索(ANYWHERE)の2つはすべての辞書で使用可能です。
MatchOption 一致条件を指定します。
STARTWITH
前方一致
ENDWITH
後方一致
EXACT
完全一致
CONTAIN
部分一致
MergeOption 検索結果の併合方法を指定します。
AND
それまでの併合結果とAND
OR
それまでの併合結果とOR

ContentProfile

取得データの形式指定のパラメータです。

FormatType テキストデータの形式。
V10ではXHTMLに固定。

DicItem として出力される Title, Head, Body の内容は XML 形式ですが、出力デバイスの都合によって・使用されるタグの種類(スキーマ)・画像や音声データを含むか含まないか・子項目を同時に表示するかリンクした別項目にするかなどの出力形式をカスタマイズすることができます。
FormatTypeはそのカスタマイズの種類を指定します。一般のブラウザ用の出力では、「XHTML」を指定してください。特別なデバイス用にカスタマイズが必要な場合は、別途ご相談ください。いくつかのカスタマイズパターンも用意してありますが、新規のパターンををご用意することも可能です。
ResourceOption DicItem として出力される Title, Head, Body の内容に、画像、音声、動画外字のインライン画像などの外部ファイルへの参照が含まれる場合に、その参照URIをどのように出力するかを指定するものです。img タグの src 属性や、a タグの href 属性などに、ここで指定した形式で表現されたものが入ることになります。
URI
通常はこちらを指定してください。
実際に有効な絶対URIが入ります。
弊社のサーバーの公開URLとなりますが、必ずしも辞書サービスと 同一のサーバーかどうかは保証されません。
一般のブラウザがターゲットであれば、特にこのURIを加工することなく そのまま出力するだけで問題はありません。
ID
通常は使用しないでください。 以下の形式で、リソースセット名とIDのセットが入ります。
NetDicResID:<resSet>:<resID>
クライアント側でこの形式を解釈して処理する必要があります。
リソースセット自体もクライアント側で保持するか、独自の方法で 処理できるようになっている必要があります。
かなり特別のケースのための指定ですので、使用するには別途 ご相談いただく必要があります。
CharsetOption テキストとして使用する文字の範囲。
範囲外の文字は、インライン画像として返されます。
これは決して送受するデータの encoding を指定するものではないので注意してください。
送受するデータは常にUTF-8 となります。

MOJIKYO
UNICODEの文字すべて+EGIX仕様による文字鏡の文字
UNICODE
UNICODEの文字すべて
WINJPENV
日本語Windows環境で表示出来る文字
JIS
JIS範囲の文字のみ 

DicItem

辞書の項目のデータです。

DicID 辞書のID
ItemID 項目のID
LocID 項目内の特定の場所を指定するID
Title 項目の見出し
Head 見出し部の内容
Body 本文の内容

Headの内容の例

Headの値に入っている項目の見出しのXHTMLデータの例です。

<div class="NetDicHead" xml:space="preserve" xmlns="">
    <span class="NetDicHeadTitle">dictionary</span>
</div>

Bodyの内容の例

Bodyの値に入っている項目の内容のXHTMLデータの例です。

<div class="NetDicBody" xml:space="preserve" xmlns="">
    <div>『辞書』,辞典,字引き</div>
</div>