辞書検索サービス(REST版)
機能を限定してパラメータを少なくした「REST版」は
HTTP GET によっても呼び出すことができます。
フル機能の辞書Webサービスはをご利用になる場合はSOAP版APIをお使いください。
サービスのURL
無償公開用
http://btonic.est.co.jp/NetDic/NetDicV09.asmx
無償公開サービスのURLです。365日24時間動作していますが稼働保証はございません。
本運用のサービスは多重化されたサーバで常時稼動させています。商用サービスのURLは契約にしたがって開示させていただいております。
メソッド
メソッドは「検索メソッド」と「内容取得メソッド」の二つです。
パラメータは、URL の最後につける Query String で指定します。
出力は SOAP と同じ XML形式です。
検索メソッド
リクエストURL
リクエストパラメータ
不要なパラメータでも省略はできません。
| パラメータ名 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Dic | 辞書ID
商用の辞書の辞書IDは契約にしたがってお知らせします。 | ||||||||
| Word | 検索語 ( UTF-8 文字列をURL encoding したものです。 日本語の場合、 「%E3%83%86%E3%83%AD=テロ」 「%E6%A0%AA=株」 といった文字列になります。) | ||||||||
| Scope | 検索対象(見出し語 or 全文) の指定(HEADWORD/ANYWHERE) | ||||||||
| Match | 一致指定 前方・後方・部分・完全 (STARTWITH/ENDWITH/CONTAIN/EXACT) | ||||||||
| Merge | 複数条件指定時の結合方法指定 (AND/OR) | ||||||||
| Prof | コンテンツ形式指定(例: XHTML ) | ||||||||
| PageSize | 一度に取得する検索結果の数 | ||||||||
| PageIndex | 取得する検索結果の開始位置 (PageSize*指定値が開始インデックス:通常は0) |
戻りのXMLデータの例
<?xml version="1.0" encoding="utf-8"?>
<SearchDicItemResult xmlns:xsd=" ・・・・・・・・・・
<ErrorMessage />
<TotalHitCount>1</TotalHitCount>
<ItemCount>1</ItemCount>
<TitleList>
<DicItemTitle>
<ItemID>0001360</ItemID>
<LocID />
<Title>
<span class="NetDicTitle" xmlns="">
<b>ab・sent</b>
</span>
</Title>
</DicItemTitle>
<DicItemTitle>
<ItemID>0001380</ItemID>
<LocID />
<Title>
<span class="NetDicTitle" xmlns="">
<b>ab・sen・tee</b>
</span>
</Title>
</DicItemTitle>
・・・・・
・・・・・
<DicItemTitle>
<ItemID>0001420</ItemID>
<LocID />
<Title>
<span class="NetDicTitle" xmlns="">
<b>ab・sent-mind・ed</b>
</span>
</Title>
</DicItemTitle>
</TitleList>
</SearchDicItemResult>
戻りのXMLのタグ
| タグ名 | 説明 |
|---|---|
| ErrorMessage | エラーの場合のエラーメッセージ |
| TotalHitCount | 総ヒット数 |
| ItemCount | この呼び出しで返される項目数 |
| TitleList | この配下に<DicItemTitle>が複数並ぶ |
| DicItemTitle | ひとつの項目をまとめるタグ |
| ItemID | 項目のID |
| LocID | 項目内の注目位置ID(特別な辞書を除き、常に空要素) |
| Title | 検索結果一覧表示用の XHTML データ (直下にある <span> タグ以下をそのまま見出しとして HTML ページにはめ込むことを想定しています。) |
リクエスト例
EJDICT英和辞典で「dict」を前方一致で検索した場合のリクエストURLです。
内容取得メソッド
リクエストURL
リクエストパラメータ
不要なパラメータでも省略はできません。
| パラメータ名 | 説明 |
|---|---|
| Dic | 辞書ID (例: DailyEJ, DailyJE, DailyJJ など ) |
| Item | 辞書項目のID(検索method で返される値です) |
| Loc | 辞書項目内の注目位置(特別な辞書を除き、指定は不要) |
| Prof | コンテンツ形式指定(通常は XHTML) |
戻りのXMLデータの例
<?xml version="1.0" encoding="utf-8"?>
<GetDicItemResult xmlns:xsd=" ・・・・・・・・・・
<ErrorMessage />
<Head>
<div class="NetDicHead" xml:space="preserve" xmlns="">
<b>ab・sent</b>
・・・・・
・・・・・
</div>
</Head>
<Body>
<div class="NetDicBody" xml:space="preserve" xmlns="">
<br />
━━ a. 不在の,欠席の; ない; ぼんやりした.
<br />
<br />
━━ [absent] vt.
<br />
・・・・・
・・・・・
</div>
</Body>
</GetDicItemResult>
戻りのXMLのタグ
| タグ名 | 説明 |
|---|---|
| ErrorMessage | エラーの場合のエラーメッセージ |
| Head | 「見出し」表示用の XHTML データ |
| Body | 「本文」表示用の XHTML データ ( Head, Body とも、直下にある <div> タグ以下をそのまま見出しや本文 として HTMLページにはめ込むことを想定しています。) |
リクエスト例
EJDICT英和辞典の「dictionary」の項目を取得した場合のリクエストURLの例です。
http://btonic.est.co.jp/NetDic/NetDicV09.asmx/GetDicItemLite?Dic=EJdict&Item=011357&Loc=&Prof=XHTML
項目内リンクの処理について
<Title><Head><Body>の配下の要素として返される XHTMLデータは、 ブラウザ依存などがないような、極力シンプルなものになっており、 そのままHTMLのページにはめ込んで頂くことを想定しています。 ただし、一点だけ加工処理が必要なところがあります。 本文内に他の辞書項目を参照するようなリンクが埋め込まれている 場合です。
これは、以下のような形になっています。
--------------------------------------------------------------------------
<span class="NetDicItemLink" ItemID="01010340">→「デル・モデル」</span>
--------------------------------------------------------------------------
「NetDicItemLink」は固定値で、「ItemID」が参照先の辞書項目IDです。
「他項目リンク」をサポートしないのであれば、何もしなくてもただの文字列として
表示されるようになっています。
「他項目リンク」をサポートする場合は、「class="NetDicItemLink"」をキーに
してこのようなspan要素を探していただき、それを加工していただくことに
なります。どう加工すればよいかは表示ページの実装によります。
例えば、
--------------------------------------------------------------------------
<a href="DicItemView?item=01010340">→「デル・モデル」</a>
--------------------------------------------------------------------------
<a href="javascript:ChangeItem('01010340')">→「デル・モデル」</a>
--------------------------------------------------------------------------
といった形がよくある実装例です。