Geocode POST リクエスト
POSTリクエストでは、単一の入力住所または住所リストをバッチ処理用に送信することができます。オプションでマッチングとジオコーディングの優先設定をGeocodeサービスに指定して、関連する緯度/経度座標とロケーション情報を受信することができます。POSTリクエストの優先設定オプションは、使用可能なオプションの完全集合です。
ベース URI
http://<server>:<port>/rest/GlobalGeocode/geocode.[content type]
説明:
- json
- JSONコンテンツ ネゴシエーションによって置き換えられない限り、デフォルトのコンテンツ タイプは HTTP です
- xml
- XMLコンテンツ ネゴシエーションによって置き換えられない限り、デフォルトのコンテンツ タイプは HTTP です
リクエスト パラメータ
- addresses - ジオコーディングする 1 つ以上の住所。必須
- type - ジオコードのタイプ。これはオプションです。
- preferences - マッチングとジオコーディングのオプション。これはオプションです。
パラメータ | タイプ | 説明 |
---|---|---|
注: 次の住所要素の意味、有効値、サポートの有無は、国によって異なります。
また、一部のマッチングおよびジオコーディング オプションは国によって異なります。各国に固有の情報を確認することが重要です。各国の情報については、付録にある国固有の情報セクションを参照してください。 |
||
Addressオブジェクトの addresses 配列。住所配列には、1 つ以上の入力住所を含めることができます。各 Addressオブジェクトには、次の要素を含めることができます。 | ||
placeName | String | 入力住所に関連する建物名、場所名、POI (ポイント情報)、会社または企業名。これはオプションです。例: Pitney Bowes |
mainAddress | String | 単一行入力 — 他のフィールドが全く入力されていない場合、mainAddress の内容は単一行入力として処理され、複数の住所フィールド要素をまとめて入力することができます。住所フィールドの入力順序は、その国の通常の住所書式に従う必要があります。これはオプションです。例: 4750 Walnut St., Boulder CO, 80301 ストリート住所 — 住所フィールド (placeName、lastLine、postalCode など) が個別に入力されている場合、このフィールドの内容はストリート住所として処理され、会社名、家番号、建物名、およびストリート名を含むことができます。これはオプションです。 交差点の入力—交差点を入力するには、2 個のアンパサンド (&&) で区切られた 2 つのストリート名を指定します。 |
lastLine | String | 住所の最終行。これはオプションです。 |
areaName1 | String | 最大の地理的地域を指定します。通常は、州または省です。これはオプションです。 |
areaName2 | String | 二次的な地理的地域を指定します。通常は、郡または地区です。これはオプションです。 |
areaName3 | String | 都市または町の名前を指定します。これはオプションです。 |
areaName4 | String | 都市の下位区分、または地方を指定します。これはオプションです。 |
postCode1 | String | 各国の標準フォーマットで表記された郵便番号。これはオプションです。 |
postCode2 | String | 各国の標準フォーマットで表記された拡張郵便番号。これはオプションです。 |
country | String | ISO 3166-1 Alpha-3 国コード。必須国コードについては、国参照一覧と ISO 3166-1 国コードを参照してください。 |
addressNumber | String | 家または建物番号。 |
streetName | String | ストリート名。 |
unitType | String | ユニット タイプを指定します。Apt.、Ste.、Bldg. など。 |
unitValue | String | ユニットの値/番号を指定します。"3B" など。 |
geocodeTypeタイプの type オブジェクト。 | ||
geocodeType | String |
実行されるジオコード タイプ。これはオプションです。
|
Preferencesタイプの preferences オブジェクト。以下の要素で構成されます。 注: 以下の要素は Geocodeサービスにのみ適用可能です。
注: 特定の国の preferences 要素のデフォルト値をオーバーライドするには、customPreferences オブジェクトにキー/値のペアを、ISO-3166 の 3 文字の国コード、ピリオド、キー定数の形式で指定します。例:
DEU.fallbackToGeographic 。 |
||
returnAllCandidateInfo | Boolean | 各候補に対して使用可能なすべての情報を返すかどうかを指定します。
|
fallbackToGeographic | Boolean | 住所レベルのジオコードを決定できない場合に、地理的セントロイドを決定しようとするかどうかを指定します。これはオプションです。
|
fallbackToPostal | Boolean | 住所レベルのジオコードを決定できない場合に、郵便番号セントロイドを決定しようとするかどうかを指定します。これはオプションです。
|
FALLBACK_TO_WORLD | String | 国ジオコーダがインストールされていないか、国ジオコーダがジオコーディング データセットなしでインストールされている場合に、World Geocoder (XWG) を使用してジオコードを決定するかどうかを指定します。World Geocoder (XWG) は、XWG ジオコーディング データセットのサポート レベルによって、郵便番号ジオコードまたは地理的ジオコードを返します。これはオプションです。
|
maxReturnedCandidates | Integer | 返される候補の最大数。これはオプションです。整数値でなければなりません。デフォルトは 1 です。 |
streetOffset | Double | ストリートレベルのジオコーディングに使うストリートセグメントからのオフセット距離を指定します。距離の指定は streetOffsetUnits オプションで指定した単位で行います。デフォルト値は 7 メートルです。 オフセット距離は、ジオコードがストリートの中央に位置付けられるのを防ぐために、ストリートレベルのジオコーディングで使われます。ストリートレベルのジオコーディングを行うと、住所が位置するストリートの中心点の緯度/経度が返されますが、これを補正するのがオフセットです。住所が指し示す建物はストリートの真上に建っているわけではないので、路上のポイントに相当する住所のジオコードが返されるのは不都合です。ジオコードは、ストリートに面して建つ建物の場所を表している必要があります。例えば、50 フィートのオフセットは、ジオコードがストリートの中心から 50 フィート離れた場所を表すことを意味します。距離は、住所のストリートセグメントから垂直方向に計算されます。また、オフセットは、ストリートをはさんで向かい合う住所が同じポイントになるのを防ぐ目的にも使われます。以下に、オフセット ポイントと元のポイントとの比較図を示します。 |
streetOffsetUnits | String | ストリート オフセットの距離単位を指定します。次のいずれかです。
|
cornerOffset | Double | ストリートレベルでのマッチングに使うストリートの終端からのオフセットを指定します。距離の指定は cornerOffsetUnits オプションで指定した単位で行います。この値は、通りの角の住所に交差点と同じジオコードが与えられるのを防ぐために使われます。角に対するジオコード ポイントのオフセット位置を定義します。デフォルト値は 7 メートルです。 以下に、ストリートの終点とオフセット終点の比較図を示します。 |
cornerOffsetUnits | String | コーナーオフセットの距離単位を指定します。次のいずれかです。
|
matchMode | String | マッチ モードにより、入力住所と参照データとの間のマッチングに適用される柔軟性が決まります。入力と求める出力の品質に応じて、マッチ モードを選択します。以下のマッチ モードがあります。
|
clientCoordSysName | String | ジオメトリの変換先の座標系を指定します。形式は、European Petroleum Survey Group (EPSG) コードまたは SRID コードである必要があります。デフォルトは EPSG:4326 です。
|
customPreferences | Map<String key, String value> | 国固有の入力優先設定を指定します。このオブジェクトを使用して、以下の項目を指定できます。
特定の国のデフォルト値をオーバーライドするには、キー定数の前に ISO-3166 の 3 文字の国コードとピリオドを付け、値を指定します。例えば、XML リクエストでは、国のデフォルト値をオーバーライドするための入力は次のようになります。
国のカスタム入力オプションは、以下の国に対して提供されています。
|
preferredDictionaryOrder | List<String> | 複数の辞書がインストールされている場合に、辞書の検索順序を指定します。デフォルトの検索順序は、辞書が設定された順序です。 |
FieldsMatchingタイプの mustMatchFields オブジェクト。一致候補を判断するための一致条件を設定できます。これらのオプションを有効にするには、matchMode フィールドをCustom に設定する必要があります。このオブジェクトは、次の要素で構成されます。 注: 特定の国の mustMatchFields 要素のデフォルト値をオーバーライドするには、customPreferences オブジェクトにキー/値のペアを、ISO-3166 の 3 文字の国コード、ピリオド、キー定数の形式で指定します。例:
CAN.matchOnAddressNumber 。 |
||
matchOnAddressNumber | Boolean |
|
matchOnPostCode1 | Boolean |
|
matchOnAreaName1 | Boolean |
|
matchOnAreaName2 | Boolean |
注: このオプションは、米国ではサポートされていません。
|
matchOnAreaName3 | Boolean |
|
matchOnAreaName4 | Boolean |
|
matchOnAllStreetFields | Boolean |
|
mustMatchInput | Boolean |
|
ReturnsFieldsDescriptorタイプの returnFieldsDescriptor オブジェクト。候補に対して返される追加データを制御します。デフォルトでは、拡張候補情報は返されませんが、追加の情報が使用可能な場合は、以下の方法で制御できます。 注: 特定の国の returnFieldsDescriptor 要素のデフォルト値をオーバーライドするには、customPreferences オブジェクトにキー/値のペアを、ISO-3166 の 3 文字の国コード、ピリオド、キー定数の形式で指定します。例:
AUS.returnAllCustomFields 。 |
||
returnAllCustomFields | Boolean |
|
returnedCustomFieldKeys | List<String> | 候補の customFields 出力で返されるカスタム フィールドを表すキーのリストを指定します。例えば、“CTYST_KEY ” や “DATATYPE ” です。デフォルトは空です。注: 国に対して複数のキー/値のペアを指定するには、返すカスタム フィールドの名前をスペースで区切ります。例:
"USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY" 。この情報を持つ候補の customFields 出力には、これらのキーを含む 3 つのカスタム フィールドがあります。注: カスタム フィールドは国によって異なります。各国の情報については、詳細情報が記載された付録の「国固有の情報」で該当するセクションを参照してください。
|
returnMatchDescriptor | Boolean |
|
returnStreetAddressFields | Boolean |
|
returnUnitInformation | Boolean |
|