2.3.7 住所辞書/KUIN住所辞書

名称	説明	値についての制約
CHARACTERCODEs	文字コード2次元配列。	日本語資源管理に従う。
GLYPHCODEs	字形コード2次元配列。	字形コードについては、文字辞書の字形コードに従う。配列個数に関しては、日本語資源管理に従う。
ZIPCODE	郵便番号。7桁の10進数で表す。KUIN住所辞書の場合にのみ使用可能。	0以上。
AREACODE	地区コード。5桁の10進数で表す。値の内容は次のとおり。住所辞書の場合：全国地方公共団体コード KUIN住所辞書の場合：住所コードの上位5桁	0以上。
NOTBOTTOM	最下層でない場合はtrue、最下層の場合はfalse。

この検索機能では、住所辞書またはKUIN住所辞書を対象にした検索をし、結果レコードセットやレコード数をCSV形式で返却します。

◆リクエスト先のURL

住所辞書の場合

http://SERVERNAME:PORT/WEBAPL/csv/getAddresses

KUIN住所辞書の場合

http://SERVERNAME:PORT/WEBAPL/csv/getAddressesByKuin

◆リクエストパラメーター

検索方法に共通で使用するパラメーター

通常の検索で使用するパラメーター

名称	説明	値についての制約
characterCodes	文字コード1次元配列。部分一致文字列として使われる。例）{栃, 木}の文字コード配列を指定すると、{栃, 木}、{栃, 木, 県}、{栃, 木, 市}などのパターンで階層検索される("栃木"を指定すると、"栃木県"、"栃木市"、"栃木"などが検索される)。	任意。文字コード2次元配列制約に従う。
yomi	読み。部分一致読みとして使われる。例）"とちぎ"と指定すると、"とちぎけん"、"とちぎし"、"とちぎ"などのパターンで階層検索される。	任意。単語辞書のよみ制約と同じ。
zipCodeRanges	郵便番号範囲を1次元配列で指定する。KUIN住所辞書の場合にのみ使用可能。	任意。郵便番号制約に従う。
areaCodeRanges	地区コード範囲を1次元配列で指定する。	任意。地区コード制約に従う。

階層アクセスの時に使用するパラメーター

名称	説明	値についての制約
hierarchyCharacterCodes	都道府県レベルから該当階層までの文字コード2次元配列を指定する。例){{栃, 木, 県}, {那, 須, 塩, 原, 市}}の文字コード配列を指定すると、この階層自身が検索される。	任意。文字コード2次元配列制約に従う。
targetIsSubAddress	hierarchyCharacterCodesで特定された階層配下の住所を取得する場合はtrue、hierarchyCharacterCodesで指定された階層自身を取得する場合はfalseを指定する。	任意。

名称

説明

値についての制約

hierarchyCharacterCodes

都道府県レベルから該当階層までの文字コード2次元配列を指定する。

例){{栃, 木, 県}, {那, 須, 塩, 原, 市}}の文字コード配列を指定すると、この階層自身が検索される。

任意。文字コード2次元配列制約に従う。

targetIsSubAddress

hierarchyCharacterCodesで特定された階層配下の住所を取得する場合はtrue、hierarchyCharacterCodesで指定された階層自身を取得する場合はfalseを指定する。

任意。

◆リクエストの例

運用文字コードがUnicodeの場合に、「栃木県」の階層配下の住所の、1～10番目を取得する場合のリクエスト。

http://SERVERNAME:PORT/WEBAPL/csv/getAddresses?limitRange=1-10&hierarchyCharacterCodes=6803,6728,770C&targetIsSubAddress=true