次の方法で共有


Ordnance Survey Places (プレビュー)

OS Places API は、住所とライフ サイクルの詳細ビューを提供します。 これには、AddressBase Premium のすべてのレコードが含まれているため、作成から廃止までの住所またはプロパティに関連するすべての情報が提供されます。 これには、地方自治体、Ordnance Survey および Royal Mail の住所、現在の住所、現在の住所の代替、暫定的な住所 (計画の作成など)、および履歴情報が含まれています。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Ordnance Survey
[URL] https://www.ordnancesurvey.co.uk/business-government
メール technicalservices@os.uk
Connector Metadata
発行者 Ordnance Survey
Web サイト https://www.ordnancesurvey.co.uk/business-government
プライバシー ポリシー https://www.ordnancesurvey.co.uk/governance/policies/privacy
カテゴリ データ、ビジネス インテリジェンス

Ordnance Survey Places を使用して、ユーザーは住所を正確に特定できます。 検索では、地方自治体と Royal Mail の住所データセットに問い合わせます。

要求には、完全または部分的な住所、郵便番号、または一意のプロパティ ID を使用できます。 検索では、特定のポイントに最も近い住所、またはユーザーが定義した領域または円の中で既知のすべての住所を探すこともできます。

前提条件

OS Places API には、Ordnance Survey のアクティブなライセンスが必要です。 顧客は、無料試用版またはプレミアム サブスクリプションにサインアップして、API コネクタへのログインに必要なアクセス キーを生成する必要があります。

資格情報の入手方法

サブスクリプションの場所のオプションの詳細については、こちらから Ordnance Survey にお問い合わせください。https://developer.ordnancesurvey.co.uk/content/contact-us

コネクタの使用を開始する

API ドキュメントはこちらを参照してください。https://apidocs.os.uk/docs/os-places-overview

ファースト ステップ ガイドでは、Ordnance Survey の Places コネクタを使用して、Power Platform でアプリを構築する方法について説明しています。こちらをご覧ください。https://github.com/OrdnanceSurvey/OS-Places-MS-Power-Platform-Connector

  • Power Apps で自由形式の住所検索を実行する: シンプルなキャンバスにテキスト ボックスとボタンを追加することで実行できます。 ボタンの OnSelect を次のように設定します。

    Set (searchResults, OSPlaces.Find ('Search Bar'.Text).results) & UpdateContext({NoSearch: true})

    検索バーからの結果は OSPlaces.Find 定義に送信でき、結果は searchResults という変数に保存されます。 変数は、キャンバスにギャラリーまたはデータ テーブルとして表示できます。

    この方法は、検索、郵便番号、UPRN、および座標の定義に適しており、コネクタを使い始めるのに良い方法です。

既知の問題と制限事項

リソースのマッチとクレンジングは、このコネクタに含まれていません。これは、主に住所のクエリ ツールとして設計されており、Power Platform 内のデータベース クレンジング ツールとして設計されていないためです。

よくあるご質問

このコネクタの使用についてご質問がある場合は、よくある質問をご覧ください。https://developer.ordnancesurvey.co.uk/os-apis-developer-portal-faqs

接続の作成

コネクタは、次の認証タイプをサポートしています:

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
API キー securestring この API の API キー True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

UPRN 操作

一意の不動産参照番号 (UPRN) を検索パラメーターとして使用する検索。

ポリゴンの操作

geoJSON ポリゴンまたはマルチ ポリゴン オブジェクトを受け取り、オブジェクト内にあるすべての住所を返す POST リクエスト。

半径操作

円の中心として座標のペアを取り、交差するすべての住所を返します。

境界ボックス操作

2 点を指定して、境界ボックスを作成します。 その後、この境界ボックス内のすべての住所が返されます。

操作の検索

フォーム入力など、すばやく使用できるように設計された自由書式の検索。

最も近い操作

座標のペア (X と Y) を入力として受け取り、最も近い住所を特定します。

郵便番号の操作

プロパティの郵便番号に基づく検索。 リソースの最小値は、SO16 などの地域および地区であり、SO16 0AS など、地域、地区、区域、および番地で構成される完全な郵便番号を受け入れます

UPRN 操作

一意の不動産参照番号 (UPRN) を検索パラメーターとして使用する検索。

パラメーター

名前 キー 必須 説明
有効な UPRN
uprn True integer

一意の不動産参照番号 (UPRN) の形式の整数

結果の形式
format string

応答が返される形式。 既定: JSON。 指定できる値: JSON、XML

地方自治体 (LPI) や Royal Mail (DPA) の住所結果
dataset string

返される住所データセット。 コンマ区切りで、複数の値を送信できます。 既定: DPA。 指定できる値: DPA、LPI

言語
lr string

返される住所の言語。 有効な言語は英語とウェールズ語です。 フィルターは DPA データセットにのみ適用可能です。 既定値は両方の言語です。 既定値: EN、CY。

フィルター​​
fq string

分類コードや論理状態コードによる結果のフィルター処理ができるフィルター。 分類コードのフィルター処理は、ワイルドカード (*) 検索を受け入れます。 分類コード パラメーターをスペースで区切って、分類コードに対して複数の検索を実行できます。 分類コード フィルターは、パラメーターを複数回使用することにより、論理状態コード フィルターで実行できます。fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6"

出力の空間参照系
output_srs string

出力の空間参照系を示します。 既定値: EPSG:27700。 指定できる値: BNG、EPSG:27700、WGS84、EPSG:4326、EPSG:3857、EPSG:4258

戻り値

名前 パス 説明
URI
header.uri string

URI

クエリ
header.query string

クエリ

オフセット
header.offset integer

オフセット

totalresults
header.totalresults integer

totalresults

形式
header.format string

形式

データセット
header.dataset string

データセット

lr
header.lr string

lr

maxresults
header.maxresults integer

maxresults

matchprecision
header.matchprecision integer

matchprecision

エポック
header.epoch string

エポック

output_srs
header.output_srs string

output_srs

結果
results array of object

結果

UPRN
results.DPA.UPRN string

UPRN

住所
results.DPA.ADDRESS string

住所

ORGANISATION_NAME
results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME

BUILDING_NUMBER
results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER

THOROUGHFARE_NAME
results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME

DEPENDENT_LOCALITY
results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY

POST_TOWN
results.DPA.POST_TOWN string

POST_TOWN

POSTCODE
results.DPA.POSTCODE string

POSTCODE

RPC
results.DPA.RPC string

RPC

X_COORDINATE
results.DPA.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.DPA.Y_COORDINATE float

Y_COORDINATE

STATUS
results.DPA.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE
results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE

BLPU_STATE_CODE_DESCRIPTION
results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.DPA.ENTRY_DATE string

ENTRY_DATE

BLPU_STATE_DATE
results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE

言語
results.DPA.LANGUAGE string

言語

MATCH
results.DPA.MATCH float

MATCH

MATCH_DESCRIPTION
results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

UPRN
results.LPI.UPRN string

UPRN

住所
results.LPI.ADDRESS string

住所

USRN
results.LPI.USRN string

USRN

LPI_KEY
results.LPI.LPI_KEY string

LPI_KEY

PAO_START_NUMBER
results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER

STREET_DESCRIPTION
results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION

TOWN_NAME
results.LPI.TOWN_NAME string

TOWN_NAME

ADMINISTRATIVE_AREA
results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA

POSTCODE_LOCATOR
results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR

RPC
results.LPI.RPC string

RPC

X_COORDINATE
results.LPI.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.LPI.Y_COORDINATE float

Y_COORDINATE

STATUS
results.LPI.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE_DESCRIPTION
results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.LPI.ENTRY_DATE string

ENTRY_DATE

STREET_STATE_CODE
results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE

STREET_STATE_CODE_DESCRIPTION
results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION

STREET_CLASSIFICATION_CODE
results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE

STREET_CLASSIFICATION_CODE_DESCRIPTION
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION

LPI_LOGICAL_STATUS_CODE
results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION

言語
results.LPI.LANGUAGE string

言語

MATCH
results.LPI.MATCH float

MATCH

MATCH_DESCRIPTION
results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

ポリゴンの操作

geoJSON ポリゴンまたはマルチ ポリゴン オブジェクトを受け取り、オブジェクト内にあるすべての住所を返す POST リクエスト。

パラメーター

名前 キー 必須 説明
参照点
referencepoint integer

参照点のジオメトリは、距離の値が計算される基準です。 パラメーターが指定されている場合にのみ、出力は指定された基準点からの距離の昇順で並べ替えられます。

結果の制限
maxresults integer

返される結果の最大数。 既定値: 100

地方自治体 (LPI) や Royal Mail (DPA) の住所結果
dataset string

返される住所データセット。 コンマ区切りで、複数の値を送信できます。 既定: DPA。 指定できる値: DPA、LPI

結果のオフセット
offset integer

返されるリストをこの数量でオフセットします。

言語
lr string

返される住所の言語。 有効な言語は英語とウェールズ語です。 フィルターは DPA データセットにのみ適用可能です。 既定値は両方の言語です。 既定値: EN、CY。

フィルター​​
fq string

分類コードや論理状態コードによる結果のフィルター処理ができるフィルター。 分類コードのフィルター処理は、ワイルドカード (*) 検索を受け入れます。 分類コード パラメーターをスペースで区切って、分類コードに対して複数の検索を実行できます。 分類コード フィルターは、パラメーターを複数回使用することにより、論理状態コード フィルターで実行できます。fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6

出力の空間参照系
output_srs string

出力の空間参照系を示します。 既定値: EPSG:27700。 指定できる値: 'BNG'、'EPSG:27700'、'WGS84'、'EPSG:4326'、'EPSG:3857'、'EPSG:4258'

入力の座標参照系
srs string

入力座標セットの空間参照系。

コンテンツ タイプ
Content-type True string

コンテンツ タイプ ヘッダー。 指定できる値: 'application/json'

種類
type True string

名: geoJSON ポリゴンの値のペア。 指定できる値: 機能

ジオメトリ
geometry True string

ここにポリゴン オブジェクトが配置されます。 指定できる値: ポリゴン オブジェクト

戻り値

名前 パス 説明
URI
header.uri string

URI

クエリ
header.query string

クエリ

オフセット
header.offset integer

オフセット

totalresults
header.totalresults integer

totalresults

形式
header.format string

形式

データセット
header.dataset string

データセット

lr
header.lr string

lr

maxresults
header.maxresults integer

maxresults

matchprecision
header.matchprecision integer

matchprecision

エポック
header.epoch string

エポック

output_srs
header.output_srs string

output_srs

結果
results array of object

結果

UPRN
results.DPA.UPRN string

UPRN

住所
results.DPA.ADDRESS string

住所

ORGANISATION_NAME
results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME

BUILDING_NUMBER
results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER

THOROUGHFARE_NAME
results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME

DEPENDENT_LOCALITY
results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY

POST_TOWN
results.DPA.POST_TOWN string

POST_TOWN

POSTCODE
results.DPA.POSTCODE string

POSTCODE

RPC
results.DPA.RPC string

RPC

X_COORDINATE
results.DPA.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.DPA.Y_COORDINATE float

Y_COORDINATE

STATUS
results.DPA.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE
results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE

BLPU_STATE_CODE_DESCRIPTION
results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.DPA.ENTRY_DATE string

ENTRY_DATE

BLPU_STATE_DATE
results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE

言語
results.DPA.LANGUAGE string

言語

MATCH
results.DPA.MATCH float

MATCH

MATCH_DESCRIPTION
results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

UPRN
results.LPI.UPRN string

UPRN

住所
results.LPI.ADDRESS string

住所

USRN
results.LPI.USRN string

USRN

LPI_KEY
results.LPI.LPI_KEY string

LPI_KEY

PAO_START_NUMBER
results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER

STREET_DESCRIPTION
results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION

TOWN_NAME
results.LPI.TOWN_NAME string

TOWN_NAME

ADMINISTRATIVE_AREA
results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA

POSTCODE_LOCATOR
results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR

RPC
results.LPI.RPC string

RPC

X_COORDINATE
results.LPI.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.LPI.Y_COORDINATE float

Y_COORDINATE

STATUS
results.LPI.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE_DESCRIPTION
results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.LPI.ENTRY_DATE string

ENTRY_DATE

STREET_STATE_CODE
results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE

STREET_STATE_CODE_DESCRIPTION
results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION

STREET_CLASSIFICATION_CODE
results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE

STREET_CLASSIFICATION_CODE_DESCRIPTION
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION

LPI_LOGICAL_STATUS_CODE
results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION

言語
results.LPI.LANGUAGE string

言語

MATCH
results.LPI.MATCH float

MATCH

MATCH_DESCRIPTION
results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

半径操作

円の中心として座標のペアを取り、交差するすべての住所を返します。

パラメーター

名前 キー 必須 説明
コンマ区切りの座標のセット
point True string

検索円の中心の座標を指定する、BNG で設定された 1 つのコンマ区切り座標。 座標の精度は小数点以下 2 桁です (1cm の精度)。

検索半径
radius integer

検索する半径 (メートル単位)。 最大半径は 1,000 メートルです。 超える場合には、エラーメッセージが返されます。 距離の精度は小数点以下 2 桁までです (1cm の精度)。 既定: 100 指定できる値: 0.01 - 1000

結果の形式
format string

応答が返される形式。 既定: JSON。 指定できる値 JSON、XML

結果の制限
maxresults integer

返される結果の最大数。 既定値: 100

結果のオフセット
offset integer

返されるリストをこの数量でオフセットします。

地方自治体 (LPI) や Royal Mail (DPA) の住所結果
dataset string

返される住所データセット。 コンマ区切りで、複数の値を送信できます。 既定: DPA。 指定できる値: DPA、LPI

言語
lr string

返される住所の言語。 有効な言語は英語とウェールズ語です。 フィルターは DPA データセットにのみ適用可能です。 既定値は両方の言語です。 既定値: EN、CY

フィルター​​
fq string

分類コードや論理状態コードによる結果のフィルター処理ができるフィルター。 分類コードのフィルター処理は、ワイルドカード (*) 検索を受け入れます。 分類コード パラメーターをスペースで区切って、分類コードに対して複数の検索を実行できます。 分類コード フィルターは、パラメーターを複数回使用することにより、論理状態コード フィルターで実行できます。fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6

出力の空間参照系
output_srs string

出力の空間参照系を示します。 既定値: EPSG:27700。 指定できる値: 'BNG'、'EPSG:27700'、'WGS84'、'EPSG:4326'、'EPSG:3857'、'EPSG:4258'

入力の空間参照系
srs string

入力座標セットの空間参照系。 指定できる値: 'BNG'、'EPSG:27700'、'WGS84'、'EPSG:4326'、'EPSG:3857'、'EPSG:4258'

戻り値

名前 パス 説明
URI
header.uri string

URI

クエリ
header.query string

クエリ

オフセット
header.offset integer

オフセット

totalresults
header.totalresults integer

totalresults

形式
header.format string

形式

データセット
header.dataset string

データセット

lr
header.lr string

lr

maxresults
header.maxresults integer

maxresults

matchprecision
header.matchprecision integer

matchprecision

エポック
header.epoch string

エポック

output_srs
header.output_srs string

output_srs

結果
results array of object

結果

UPRN
results.DPA.UPRN string

UPRN

住所
results.DPA.ADDRESS string

住所

ORGANISATION_NAME
results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME

BUILDING_NUMBER
results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER

THOROUGHFARE_NAME
results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME

DEPENDENT_LOCALITY
results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY

POST_TOWN
results.DPA.POST_TOWN string

POST_TOWN

POSTCODE
results.DPA.POSTCODE string

POSTCODE

RPC
results.DPA.RPC string

RPC

X_COORDINATE
results.DPA.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.DPA.Y_COORDINATE float

Y_COORDINATE

STATUS
results.DPA.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE
results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE

BLPU_STATE_CODE_DESCRIPTION
results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.DPA.ENTRY_DATE string

ENTRY_DATE

BLPU_STATE_DATE
results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE

言語
results.DPA.LANGUAGE string

言語

MATCH
results.DPA.MATCH float

MATCH

MATCH_DESCRIPTION
results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

UPRN
results.LPI.UPRN string

UPRN

住所
results.LPI.ADDRESS string

住所

USRN
results.LPI.USRN string

USRN

LPI_KEY
results.LPI.LPI_KEY string

LPI_KEY

PAO_START_NUMBER
results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER

STREET_DESCRIPTION
results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION

TOWN_NAME
results.LPI.TOWN_NAME string

TOWN_NAME

ADMINISTRATIVE_AREA
results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA

POSTCODE_LOCATOR
results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR

RPC
results.LPI.RPC string

RPC

X_COORDINATE
results.LPI.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.LPI.Y_COORDINATE float

Y_COORDINATE

STATUS
results.LPI.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE_DESCRIPTION
results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.LPI.ENTRY_DATE string

ENTRY_DATE

STREET_STATE_CODE
results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE

STREET_STATE_CODE_DESCRIPTION
results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION

STREET_CLASSIFICATION_CODE
results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE

STREET_CLASSIFICATION_CODE_DESCRIPTION
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION

LPI_LOGICAL_STATUS_CODE
results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION

言語
results.LPI.LANGUAGE string

言語

MATCH
results.LPI.MATCH float

MATCH

MATCH_DESCRIPTION
results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

境界ボックス操作

2 点を指定して、境界ボックスを作成します。 その後、この境界ボックス内のすべての住所が返されます。

パラメーター

名前 キー 必須 説明
境界ボックス
bbox True string

境界ボックスの左下と右上の座標を指定する、精度が小数点以下 2 桁までのコンマ区切りの座標のペア。 境界ボックスの最大サイズは、1 km2 です。 境界ボックスがこれを超えると、エラー メッセージが返されます。 座標の精度は 8 メートルの精度です。

結果の形式
format string

応答が返される形式。 既定: JSON。 指定できる値: JSON、XML

結果の制限
maxresults integer

返される結果の最大数。 既定値: 100

結果のオフセット
offset integer

返されるリストをこの数量でオフセットします。

地方自治体 (LPI) や Royal Mail (DPA) の住所結果
dataset string

返される住所データセット。 コンマ区切りで、複数の値を送信できます。 既定: DPA。 指定できる値: DPA、LPI

言語
lr string

返される住所の言語。 有効な言語は英語とウェールズ語です。 フィルターは DPA データセットにのみ適用可能です。 既定値は両方の言語です。 既定値: EN、CY。

フィルター​​
fq string

分類コードや論理状態コードによる結果のフィルター処理ができるフィルター。 分類コードのフィルター処理は、ワイルドカード (*) 検索を受け入れます。 分類コード パラメーターをスペースで区切って、分類コードに対して複数の検索を実行できます。 分類コード フィルターは、パラメーターを複数回使用することにより、論理状態コード フィルターで実行できます。fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6

出力の空間参照系
output_srs string

出力の空間参照系を示します。 既定値: EPSG:27700。

入力の座標参照系
srs string

入力座標セットの空間参照系。

戻り値

名前 パス 説明
URI
header.uri string

URI

クエリ
header.query string

クエリ

オフセット
header.offset integer

オフセット

totalresults
header.totalresults integer

totalresults

形式
header.format string

形式

データセット
header.dataset string

データセット

lr
header.lr string

lr

maxresults
header.maxresults integer

maxresults

matchprecision
header.matchprecision integer

matchprecision

エポック
header.epoch string

エポック

output_srs
header.output_srs string

output_srs

結果
results array of object

結果

UPRN
results.DPA.UPRN string

UPRN

住所
results.DPA.ADDRESS string

住所

ORGANISATION_NAME
results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME

BUILDING_NUMBER
results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER

THOROUGHFARE_NAME
results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME

DEPENDENT_LOCALITY
results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY

POST_TOWN
results.DPA.POST_TOWN string

POST_TOWN

POSTCODE
results.DPA.POSTCODE string

POSTCODE

RPC
results.DPA.RPC string

RPC

X_COORDINATE
results.DPA.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.DPA.Y_COORDINATE float

Y_COORDINATE

STATUS
results.DPA.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE
results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE

BLPU_STATE_CODE_DESCRIPTION
results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.DPA.ENTRY_DATE string

ENTRY_DATE

BLPU_STATE_DATE
results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE

言語
results.DPA.LANGUAGE string

言語

MATCH
results.DPA.MATCH float

MATCH

MATCH_DESCRIPTION
results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

UPRN
results.LPI.UPRN string

UPRN

住所
results.LPI.ADDRESS string

住所

USRN
results.LPI.USRN string

USRN

LPI_KEY
results.LPI.LPI_KEY string

LPI_KEY

PAO_START_NUMBER
results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER

STREET_DESCRIPTION
results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION

TOWN_NAME
results.LPI.TOWN_NAME string

TOWN_NAME

ADMINISTRATIVE_AREA
results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA

POSTCODE_LOCATOR
results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR

RPC
results.LPI.RPC string

RPC

X_COORDINATE
results.LPI.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.LPI.Y_COORDINATE float

Y_COORDINATE

STATUS
results.LPI.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE_DESCRIPTION
results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.LPI.ENTRY_DATE string

ENTRY_DATE

STREET_STATE_CODE
results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE

STREET_STATE_CODE_DESCRIPTION
results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION

STREET_CLASSIFICATION_CODE
results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE

STREET_CLASSIFICATION_CODE_DESCRIPTION
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION

LPI_LOGICAL_STATUS_CODE
results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION

言語
results.LPI.LANGUAGE string

言語

MATCH
results.LPI.MATCH float

MATCH

MATCH_DESCRIPTION
results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

操作の検索

フォーム入力など、すばやく使用できるように設計された自由書式の検索。

パラメーター

名前 キー 必須 説明
住所のクエリ。
query True string

自由書式の検索のパラメーター。

結果の形式
format string

応答が返される形式。 既定: JSON。 指定できる値: 'JSON'、'XML'

結果の制限
maxresults integer

返される結果の最大数。 既定値: 100

結果のオフセット
offset integer

返されるリストをこの数量でオフセットします。

地方自治体 (LPI) や Royal Mail (DPA) の住所結果
dataset string

返される住所データセット。 コンマ区切りで、複数の値を送信できます。 既定: DPA。 指定できる値: DPA、LPI

言語
lr string

返される住所の言語。 有効な言語は英語とウェールズ語です。 フィルターは DPA データセットにのみ適用可能です。 既定値は両方の言語です。 既定値: EN、CY。

住所マッチング スコアに基づいて結果を制限する
minmatch number

返される必要のある結果の最小一致スコア。 指定できる値: 0.1 - 1.0 (境界値を含む)

一致スコアの精度
matchprecision integer

一致スコア値が切り捨てられる小数点位置。 指定できる値: 1 - 10

フィルター​​
fq string

分類コードや論理状態コードによる結果のフィルター処理ができるフィルター。 分類コードのフィルター処理は、ワイルドカード (*) 検索を受け入れます。 分類コード パラメーターをスペースで区切って、分類コードに対して複数の検索を実行できます。 分類コード フィルターは、パラメーターを複数回使用することにより、論理状態コード フィルターで実行できます。fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6

出力の空間参照系
output_srs string

出力の空間参照系を示します。 既定値: EPSG:27700。 指定できる値: BNG、EPSG:27700、WGS84、EPSG:4326、EPSG:3857、EPSG:4258

戻り値

名前 パス 説明
URI
header.uri string

URI

クエリ
header.query string

クエリ

オフセット
header.offset integer

オフセット

totalresults
header.totalresults integer

totalresults

形式
header.format string

形式

データセット
header.dataset string

データセット

lr
header.lr string

lr

maxresults
header.maxresults integer

maxresults

matchprecision
header.matchprecision integer

matchprecision

エポック
header.epoch string

エポック

output_srs
header.output_srs string

output_srs

結果
results array of object

結果

UPRN
results.DPA.UPRN string

UPRN

住所
results.DPA.ADDRESS string

住所

ORGANISATION_NAME
results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME

BUILDING_NUMBER
results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER

THOROUGHFARE_NAME
results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME

DEPENDENT_LOCALITY
results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY

POST_TOWN
results.DPA.POST_TOWN string

POST_TOWN

POSTCODE
results.DPA.POSTCODE string

POSTCODE

RPC
results.DPA.RPC string

RPC

X_COORDINATE
results.DPA.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.DPA.Y_COORDINATE float

Y_COORDINATE

STATUS
results.DPA.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE
results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE

BLPU_STATE_CODE_DESCRIPTION
results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.DPA.ENTRY_DATE string

ENTRY_DATE

BLPU_STATE_DATE
results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE

言語
results.DPA.LANGUAGE string

言語

MATCH
results.DPA.MATCH float

MATCH

MATCH_DESCRIPTION
results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

UPRN
results.LPI.UPRN string

UPRN

住所
results.LPI.ADDRESS string

住所

USRN
results.LPI.USRN string

USRN

LPI_KEY
results.LPI.LPI_KEY string

LPI_KEY

PAO_START_NUMBER
results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER

STREET_DESCRIPTION
results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION

TOWN_NAME
results.LPI.TOWN_NAME string

TOWN_NAME

ADMINISTRATIVE_AREA
results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA

POSTCODE_LOCATOR
results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR

RPC
results.LPI.RPC string

RPC

X_COORDINATE
results.LPI.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.LPI.Y_COORDINATE float

Y_COORDINATE

STATUS
results.LPI.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE_DESCRIPTION
results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.LPI.ENTRY_DATE string

ENTRY_DATE

STREET_STATE_CODE
results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE

STREET_STATE_CODE_DESCRIPTION
results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION

STREET_CLASSIFICATION_CODE
results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE

STREET_CLASSIFICATION_CODE_DESCRIPTION
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION

LPI_LOGICAL_STATUS_CODE
results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION

言語
results.LPI.LANGUAGE string

言語

MATCH
results.LPI.MATCH float

MATCH

MATCH_DESCRIPTION
results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

最も近い操作

座標のペア (X と Y) を入力として受け取り、最も近い住所を特定します。

パラメーター

名前 キー 必須 説明
コンマ区切りの座標のセット
point True string

直線で最も近いレコードを見つける座標を指定する1 つのコンマ区切りの座標セット。 検索で試行する最大距離は 1,000 メートルです。 座標の精度は小数点以下 2 桁までです (1cm の精度)。

検索半径
radius integer

検索する半径 (メートル単位)。 最大値は 1,000 メートルです。 半径がこの長さを超過すると、エラーメッセージが返されます (下記を参照)。 距離の精度は小数点以下 2 桁までです (1cm の精度)。 既定: 100

結果の形式
format string

応答が返される形式。 既定: JSON。 指定できる値: JSON、XML

地方自治体 (LPI) や Royal Mail (DPA) の住所結果
dataset string

返される住所データセット。 コンマ区切りで、複数の値を送信できます。 既定: DPA。 指定できる値: DPA、LPI

言語
lr string

返される住所の言語。 有効な言語は英語とウェールズ語です。 フィルターは DPA データセットにのみ適用可能です。 既定値は両方の言語です。 既定値: EN、CY

フィルター​​
fq string

分類コードや論理状態コードによる結果のフィルター処理ができるフィルター。 分類コードのフィルター処理は、ワイルドカード (*) 検索を受け入れます。 分類コード パラメーターをスペースで区切って、分類コードに対して複数の検索を実行できます。 分類コード フィルターは、パラメーターを複数回使用することにより、論理状態コード フィルターで実行できます。fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6

出力の空間参照系
output_srs string

出力の空間参照系を示します。 既定値: EPSG:27700。 指定できる値: BNG、EPSG:27700、WGS84、EPSG:4326、EPSG:3857、EPSG:4258

入力の空間参照系
srs string

入力座標セットの空間参照系。 指定できる値: 'BNG'、'EPSG:27700'、'WGS84'、'EPSG:4326'、'EPSG:3857'、'EPSG:4258'

戻り値

名前 パス 説明
URI
header.uri string

URI

クエリ
header.query string

クエリ

オフセット
header.offset integer

オフセット

totalresults
header.totalresults integer

totalresults

形式
header.format string

形式

データセット
header.dataset string

データセット

lr
header.lr string

lr

maxresults
header.maxresults integer

maxresults

matchprecision
header.matchprecision integer

matchprecision

エポック
header.epoch string

エポック

output_srs
header.output_srs string

output_srs

結果
results array of object

結果

UPRN
results.DPA.UPRN string

UPRN

住所
results.DPA.ADDRESS string

住所

ORGANISATION_NAME
results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME

BUILDING_NUMBER
results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER

THOROUGHFARE_NAME
results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME

DEPENDENT_LOCALITY
results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY

POST_TOWN
results.DPA.POST_TOWN string

POST_TOWN

POSTCODE
results.DPA.POSTCODE string

POSTCODE

RPC
results.DPA.RPC string

RPC

X_COORDINATE
results.DPA.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.DPA.Y_COORDINATE float

Y_COORDINATE

STATUS
results.DPA.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE
results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE

BLPU_STATE_CODE_DESCRIPTION
results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.DPA.ENTRY_DATE string

ENTRY_DATE

BLPU_STATE_DATE
results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE

言語
results.DPA.LANGUAGE string

言語

MATCH
results.DPA.MATCH float

MATCH

MATCH_DESCRIPTION
results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

UPRN
results.LPI.UPRN string

UPRN

住所
results.LPI.ADDRESS string

住所

USRN
results.LPI.USRN string

USRN

LPI_KEY
results.LPI.LPI_KEY string

LPI_KEY

PAO_START_NUMBER
results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER

STREET_DESCRIPTION
results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION

TOWN_NAME
results.LPI.TOWN_NAME string

TOWN_NAME

ADMINISTRATIVE_AREA
results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA

POSTCODE_LOCATOR
results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR

RPC
results.LPI.RPC string

RPC

X_COORDINATE
results.LPI.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.LPI.Y_COORDINATE float

Y_COORDINATE

STATUS
results.LPI.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE_DESCRIPTION
results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.LPI.ENTRY_DATE string

ENTRY_DATE

STREET_STATE_CODE
results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE

STREET_STATE_CODE_DESCRIPTION
results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION

STREET_CLASSIFICATION_CODE
results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE

STREET_CLASSIFICATION_CODE_DESCRIPTION
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION

LPI_LOGICAL_STATUS_CODE
results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION

言語
results.LPI.LANGUAGE string

言語

MATCH
results.LPI.MATCH float

MATCH

MATCH_DESCRIPTION
results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

郵便番号の操作

プロパティの郵便番号に基づく検索。 リソースの最小値は、SO16 などの地域および地区であり、SO16 0AS など、地域、地区、区域、および番地で構成される完全な郵便番号を受け入れます

パラメーター

名前 キー 必須 説明
英国式の郵便番号
postcode True string

郵便番号検索パラメーター。

結果の形式
format string

応答が返される形式。 既定: JSON。 指定できる値: 'JSON'、'XML'

結果の制限
maxresults integer

返される結果の最大数。 既定値: 100

結果のオフセット
offset integer

返されるリストをこの数量でオフセットします。

地方自治体 (LPI) や Royal Mail (DPA) の住所結果
dataset string

返される住所データセット。 コンマ区切りで、複数の値を送信できます。 既定: DPA。 指定できる値: DPA、LPI

言語
lr string

返される住所の言語。 有効な言語は英語とウェールズ語です。 フィルターは DPA データセットにのみ適用可能です。 既定値は両方の言語です。 既定値: EN、CY。

フィルター​​
fq string

分類コードや論理状態コードによる結果のフィルター処理ができるフィルター。 分類コードのフィルター処理は、ワイルドカード (*) 検索を受け入れます。 分類コード パラメーターをスペースで区切って、分類コードに対して複数の検索を実行できます。 分類コード フィルターは、パラメーターを複数回使用することにより、論理状態コード フィルターで実行できます。fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6

出力の空間参照系
output_srs string

出力の空間参照系を示します。 既定値: EPSG:27700。 指定できる値: BNG、EPSG:27700、WGS84、EPSG:4326、EPSG:3857、EPSG:4258

戻り値

名前 パス 説明
URI
header.uri string

URI

クエリ
header.query string

クエリ

オフセット
header.offset integer

オフセット

totalresults
header.totalresults integer

totalresults

形式
header.format string

形式

データセット
header.dataset string

データセット

lr
header.lr string

lr

maxresults
header.maxresults integer

maxresults

matchprecision
header.matchprecision integer

matchprecision

エポック
header.epoch string

エポック

output_srs
header.output_srs string

output_srs

結果
results array of object

結果

UPRN
results.DPA.UPRN string

UPRN

住所
results.DPA.ADDRESS string

住所

ORGANISATION_NAME
results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME

BUILDING_NUMBER
results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER

THOROUGHFARE_NAME
results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME

DEPENDENT_LOCALITY
results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY

POST_TOWN
results.DPA.POST_TOWN string

POST_TOWN

POSTCODE
results.DPA.POSTCODE string

POSTCODE

RPC
results.DPA.RPC string

RPC

X_COORDINATE
results.DPA.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.DPA.Y_COORDINATE float

Y_COORDINATE

STATUS
results.DPA.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE
results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE

BLPU_STATE_CODE_DESCRIPTION
results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.DPA.ENTRY_DATE string

ENTRY_DATE

BLPU_STATE_DATE
results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE

言語
results.DPA.LANGUAGE string

言語

MATCH
results.DPA.MATCH float

MATCH

MATCH_DESCRIPTION
results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

UPRN
results.LPI.UPRN string

UPRN

住所
results.LPI.ADDRESS string

住所

USRN
results.LPI.USRN string

USRN

LPI_KEY
results.LPI.LPI_KEY string

LPI_KEY

PAO_START_NUMBER
results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER

STREET_DESCRIPTION
results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION

TOWN_NAME
results.LPI.TOWN_NAME string

TOWN_NAME

ADMINISTRATIVE_AREA
results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA

POSTCODE_LOCATOR
results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR

RPC
results.LPI.RPC string

RPC

X_COORDINATE
results.LPI.X_COORDINATE float

X_COORDINATE

Y_COORDINATE
results.LPI.Y_COORDINATE float

Y_COORDINATE

STATUS
results.LPI.STATUS string

STATUS

LOGICAL_STATUS_CODE
results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE

CLASSIFICATION_CODE
results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE

CLASSIFICATION_CODE_DESCRIPTION
results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION

LOCAL_CUSTODIAN_CODE
results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE

LOCAL_CUSTODIAN_CODE_DESCRIPTION
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION

POSTAL_ADDRESS_CODE
results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE

POSTAL_ADDRESS_CODE_DESCRIPTION
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION

BLPU_STATE_CODE_DESCRIPTION
results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION

TOPOGRAPHY_LAYER_TOID
results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID

LAST_UPDATE_DATE
results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE

ENTRY_DATE
results.LPI.ENTRY_DATE string

ENTRY_DATE

STREET_STATE_CODE
results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE

STREET_STATE_CODE_DESCRIPTION
results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION

STREET_CLASSIFICATION_CODE
results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE

STREET_CLASSIFICATION_CODE_DESCRIPTION
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION

LPI_LOGICAL_STATUS_CODE
results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION

言語
results.LPI.LANGUAGE string

言語

MATCH
results.LPI.MATCH float

MATCH

MATCH_DESCRIPTION
results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION