Места опроса ordnance (предварительная версия)
API размещения ОС предоставляет подробное представление адреса и его жизненного цикла. Он содержит все записи AddressBase Premium и поэтому предоставляет все сведения, относящиеся к адресу или свойству от создания до выхода на пенсию. Он содержит местный орган, опрос ordnance и королевские почтовые адреса, текущие адреса и альтернативные варианты для текущих адресов, временных адресов (например, разработки планирования) и исторической информации.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Опрос ordnance |
| URL | https://www.ordnancesurvey.co.uk/business-government |
| Адрес электронной почты | technicalservices@os.uk |
| Метаданные соединителя | |
|---|---|
| Publisher | Опрос ordnance |
| Website | https://www.ordnancesurvey.co.uk/business-government |
| Политика конфиденциальности | https://www.ordnancesurvey.co.uk/governance/policies/privacy |
| Категории | Данные; Бизнес-аналитика |
Места опроса ordnance позволяют пользователям точно определять адреса. Поиски допроса местных органов власти и наборов данных королевской почты.
Запросы можно выполнять с помощью полного или частичного адреса, почтового кода или уникального идентификатора свойства. Поиск также может находить адреса, ближайшие к заданной точке, или все адреса, известные в определяемой пользователем области или круге.
Предпосылки
ДЛЯ API мест ОС требуется активная лицензия с помощью опроса ordnance. Клиенты должны зарегистрироваться для получения бесплатной пробной версии или подписки premium, чтобы создать ключ доступа, необходимый для входа в соединитель API.
Получение учетных данных
Чтобы узнать больше о вариантах размещения подписки, обратитесь в опрос Ordnance здесь: https://developer.ordnancesurvey.co.uk/content/contact-us
Начало работы с соединителем
Документация по API см. здесь https://apidocs.os.uk/docs/os-places-overview
Наше руководство по началу работы описывает, как создать приложение на платформе power platform с помощью соединителя "Места" в Ordnance Survey и найти здесь: https://github.com/OrdnanceSurvey/OS-Places-MS-Power-Platform-Connector
Выполните поиск свободного текстового адреса в приложениях power: это можно сделать, добавив текстовое поле и кнопку на простой холст. Задав для кнопки значение OnSelect:
Задайте (searchResults, OSPlaces.Find (панель поиска). Text).results) и UpdateContext({NoSearch: true})
Результаты из панели поиска можно отправить в определение OSPlaces.Find, а результаты хранятся в переменной с именем searchResults. Переменная может отображаться как коллекция или таблица данных на холсте.
Этот подход подходит для определения координат поиска, postcode, UPRN и координат и является хорошим способом приступить к работе с соединителем.
Известные проблемы и ограничения
Ресурсы Match и Очистка не являются частью этого соединителя, так как это основное средство было разработано как средство запроса адресов, а не средство очистки базы данных в Power Platform.
Часто задаваемые вопросы
Если у вас есть вопросы об использовании этого соединителя, ознакомьтесь с нашими часто задаваемыми вопросами: https://developer.ordnancesurvey.co.uk/os-apis-developer-portal-faqs
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Ключ API для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Ближайшая операция |
Принимает пару координат (X и Y) в качестве входных данных, чтобы определить ближайший адрес. |
| Операция postcode |
Поиск на основе почтового кода свойства. Минимумом для ресурса является область и район, например SO16, и будет принимать полный почтовый код, состоящий из области, района, сектора и единицы, например SO16 0AS |
| Операция radius |
Принимает пару координат в качестве центра круга и возвращает все адреса, пересекаемые им. |
| Операция UPRN |
Поиск, который принимает уникальный номер ссылки на свойства (UPRN) в качестве параметра поиска. |
| Операция многоугольника |
Запрос POST, который принимает многоугольник geoJSON или объект с несколькими многоугольниками и возвращает все адреса, которые находятся в объекте. |
| Операция ограничивающего прямоугольника |
Принимает две точки и создает ограничивающий прямоугольник. Затем возвращаются все адреса в этом ограничивающем поле. |
| Операция поиска |
Бесплатный текстовый поиск, предназначенный для быстрого использования, например заполнение формы. |
Ближайшая операция
Принимает пару координат (X и Y) в качестве входных данных, чтобы определить ближайший адрес.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Набор координат, разделенных запятыми
|
point | True | string |
Один набор координат, разделенный запятыми, указывающий координату, к которой должна находиться ближайшая запись в прямой строке. Максимальное расстояние, попробуемого поиска, составляет 1000 метров. Точность координат составляет до двух десятичных разрядов (то есть 1 см точности). |
|
Радиус поиска
|
radius | integer |
Радиус в метрах для поиска внутри. Максимальное значение составляет 1000 метров. Если радиус превышает этот объем, будет возвращено сообщение об ошибке (см. ниже). Точность расстояния составляет до двух десятичных разрядов (то есть 1 см точности). Значение по умолчанию: 100. |
|
|
Формат результата
|
format | string |
Формат, в котором будет возвращен ответ. Значение по умолчанию: JSON. Принятые значения: JSON, XML |
|
|
Результаты адресов локального центра (LPI) и /или Royal Mail (DPA)
|
dataset | string |
Возвращаемый набор данных адреса. Можно отправить несколько значений, разделенных запятой. По умолчанию: DPA. Принятые значения: DPA, LPI |
|
|
Language
|
lr | string |
Какой язык адресов следует возвращать. Допустимые языки: английский и валлийский. Фильтруйте только набор данных DPA. Значение по умолчанию — оба языка. По умолчанию: EN, CY |
|
|
Filter
|
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" |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
УРИ
|
header.uri | string |
УРИ |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
сопоставление
|
header.matchprecision | integer |
сопоставление |
|
эпоха
|
header.epoch | string |
эпоха |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
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 |
|
ПОЧТОВЫЙ ИНДЕКС
|
results.DPA.POSTCODE | string |
ПОЧТОВЫЙ ИНДЕКС |
|
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 |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
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 |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Операция postcode
Поиск на основе почтового кода свойства. Минимумом для ресурса является область и район, например SO16, и будет принимать полный почтовый код, состоящий из области, района, сектора и единицы, например SO16 0AS
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Почтовый код стиля Великобритании
|
postcode | True | string |
Параметр поиска postcode. |
|
Формат результата
|
format | string |
Формат, в котором будет возвращен ответ. Значение по умолчанию: JSON. Принятые значения: JSON, XML |
|
|
Ограничение результатов
|
maxresults | integer |
Максимальное количество возвращаемых результатов. По умолчанию: 100 |
|
|
Смещение результата
|
offset | integer |
Смещение списка возвращенных этим количеством. |
|
|
Результаты адресов локального центра (LPI) и /или Royal Mail (DPA)
|
dataset | string |
Возвращаемый набор данных адреса. Можно отправить несколько значений, разделенных запятой. По умолчанию: DPA. Принятые значения: DPA, LPI |
|
|
Language
|
lr | string |
Какой язык адресов следует возвращать. Допустимые языки: английский и валлийский. Фильтруйте только набор данных DPA. Значение по умолчанию — оба языка. По умолчанию: EN, CY. |
|
|
Filter
|
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 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
УРИ
|
header.uri | string |
УРИ |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
сопоставление
|
header.matchprecision | integer |
сопоставление |
|
эпоха
|
header.epoch | string |
эпоха |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
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 |
|
ПОЧТОВЫЙ ИНДЕКС
|
results.DPA.POSTCODE | string |
ПОЧТОВЫЙ ИНДЕКС |
|
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 |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
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 |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Операция radius
Принимает пару координат в качестве центра круга и возвращает все адреса, пересекаемые им.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Набор координат, разделенных запятыми
|
point | True | string |
Одна разделенная запятыми координата в BNG, указывающая координату в центре круга поиска. Точность координат составляет два десятичных разряда (то есть точность 1 см). |
|
Радиус поиска
|
radius | integer |
Радиус для поиска в метрах. Максимальный радиус составляет 1000 метров. Если указано выше, возвращается сообщение об ошибке. Точность расстояния составляет до двух десятичных разрядов (то есть 1 см точности). Значение по умолчанию: 100. Принятые значения: 0,01 – 1000 |
|
|
Формат результата
|
format | string |
Формат, в котором будет возвращен ответ. Значение по умолчанию: JSON. Принятые значения JSON, XML |
|
|
Ограничение результатов
|
maxresults | integer |
Максимальное количество возвращаемых результатов. По умолчанию: 100 |
|
|
Смещение результата
|
offset | integer |
Смещение списка возвращенных этим количеством. |
|
|
Результаты адресов локального центра (LPI) и /или Royal Mail (DPA)
|
dataset | string |
Возвращаемый набор данных адреса. Можно отправить несколько значений, разделенных запятой. По умолчанию: DPA. Принятые значения: DPA, LPI |
|
|
Language
|
lr | string |
Какой язык адресов следует возвращать. Допустимые языки: английский и валлийский. Фильтруйте только набор данных DPA. Значение по умолчанию — оба языка. По умолчанию: EN, CY |
|
|
Filter
|
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" |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
УРИ
|
header.uri | string |
УРИ |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
сопоставление
|
header.matchprecision | integer |
сопоставление |
|
эпоха
|
header.epoch | string |
эпоха |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
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 |
|
ПОЧТОВЫЙ ИНДЕКС
|
results.DPA.POSTCODE | string |
ПОЧТОВЫЙ ИНДЕКС |
|
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 |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
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 |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Операция UPRN
Поиск, который принимает уникальный номер ссылки на свойства (UPRN) в качестве параметра поиска.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Допустимый UPRN
|
uprn | True | integer |
Целое число в формате уникального номера ссылки на свойства (UPRN) |
|
Формат результата
|
format | string |
Формат, в котором будет возвращен ответ. Значение по умолчанию: JSON. Принятые значения: JSON, XML |
|
|
Результаты адресов локального центра (LPI) и /или Royal Mail (DPA)
|
dataset | string |
Возвращаемый набор данных адреса. Можно отправить несколько значений, разделенных запятой. По умолчанию: DPA. Принятые значения: DPA, LPI |
|
|
Language
|
lr | string |
Какой язык адресов следует возвращать. Допустимые языки: английский и валлийский. Фильтруйте только набор данных DPA. Значение по умолчанию — оба языка. По умолчанию: EN, CY. |
|
|
Filter
|
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 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
УРИ
|
header.uri | string |
УРИ |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
сопоставление
|
header.matchprecision | integer |
сопоставление |
|
эпоха
|
header.epoch | string |
эпоха |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
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 |
|
ПОЧТОВЫЙ ИНДЕКС
|
results.DPA.POSTCODE | string |
ПОЧТОВЫЙ ИНДЕКС |
|
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 |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
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 |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Операция многоугольника
Запрос POST, который принимает многоугольник geoJSON или объект с несколькими многоугольниками и возвращает все адреса, которые находятся в объекте.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ориентир
|
referencepoint | integer |
Геометрия точки ссылки — это основа, из которой вычисляется значение расстояния. Выходные данные упорядочены по возрастанию от заданной эталонной точки только в том случае, если был указан параметр. |
|
|
Ограничение результатов
|
maxresults | integer |
Максимальное количество возвращаемых результатов. По умолчанию: 100 |
|
|
Результаты адресов локального центра (LPI) и /или Royal Mail (DPA)
|
dataset | string |
Возвращаемый набор данных адреса. Можно отправить несколько значений, разделенных запятой. По умолчанию: DPA. Принятые значения: DPA, LPI |
|
|
Смещение результата
|
offset | integer |
Смещение списка возвращенных этим количеством. |
|
|
Language
|
lr | string |
Какой язык адресов следует возвращать. Допустимые языки: английский и валлийский. Фильтруйте только набор данных DPA. Значение по умолчанию — оба языка. По умолчанию: EN, CY. |
|
|
Filter
|
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 |
Заголовок Content-Type. Принятые значения: application/json |
|
type
|
type | True | string |
Первая пара name:value для многоугольника geoJSON. Принятые значения: функция |
|
geometry
|
geometry | True | string |
Здесь находится объект многоугольника. Принятые значения: объект многоугольника |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
УРИ
|
header.uri | string |
УРИ |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
сопоставление
|
header.matchprecision | integer |
сопоставление |
|
эпоха
|
header.epoch | string |
эпоха |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
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 |
|
ПОЧТОВЫЙ ИНДЕКС
|
results.DPA.POSTCODE | string |
ПОЧТОВЫЙ ИНДЕКС |
|
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 |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
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 |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Операция ограничивающего прямоугольника
Принимает две точки и создает ограничивающий прямоугольник. Затем возвращаются все адреса в этом ограничивающем поле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ограничивающий прямоугольник
|
bbox | True | string |
Пара координат с разделителями-запятыми с точностью двух десятичных разрядов или меньше, указывающая координаты нижнего левого и верхнего правых полей ограничивающего прямоугольника. Максимальный размер ограничивающего прямоугольника составляет 1 км2. Если ограничивающий прямоугольник превышает это, возвращается сообщение об ошибке. Точность координат составляет 8 метров. |
|
Формат результата
|
format | string |
Формат, в котором будет возвращен ответ. Значение по умолчанию: JSON. Принятые значения: JSON, XML |
|
|
Ограничение результатов
|
maxresults | integer |
Максимальное количество возвращаемых результатов. По умолчанию: 100 |
|
|
Смещение результата
|
offset | integer |
Смещение списка возвращенных этим количеством. |
|
|
Результаты адресов локального центра (LPI) и /или Royal Mail (DPA)
|
dataset | string |
Возвращаемый набор данных адреса. Можно отправить несколько значений, разделенных запятой. По умолчанию: DPA. Принятые значения: DPA, LPI |
|
|
Language
|
lr | string |
Какой язык адресов следует возвращать. Допустимые языки: английский и валлийский. Фильтруйте только набор данных DPA. Значение по умолчанию — оба языка. По умолчанию: EN, CY. |
|
|
Filter
|
fq | string |
Фильтр, позволяющий фильтровать результаты по коду классификации и /или логическому коду состояния. Фильтрация по коду классификации будет принимать подстановочные знаки (*). Можно выполнить несколько поисков по коду классификации, разделяя параметр кода классификации пробелом. Фильтры кода классификации можно запускать с фильтрами кода логического состояния с помощью параметра несколько раз: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Выходная система пространственной ссылки
|
output_srs | string |
Предназначенная система пространственной ссылки на выходные данные. По умолчанию: EPSG:27700. |
|
|
Эталонная система координат ввода
|
srs | string |
Система пространственной ссылки для входного набора координат. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
УРИ
|
header.uri | string |
УРИ |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
сопоставление
|
header.matchprecision | integer |
сопоставление |
|
эпоха
|
header.epoch | string |
эпоха |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
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 |
|
ПОЧТОВЫЙ ИНДЕКС
|
results.DPA.POSTCODE | string |
ПОЧТОВЫЙ ИНДЕКС |
|
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 |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
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 |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
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 |
|
|
Language
|
lr | string |
Какой язык адресов следует возвращать. Допустимые языки: английский и валлийский. Фильтруйте только набор данных DPA. Значение по умолчанию — оба языка. По умолчанию: EN, CY. |
|
|
Ограничение результатов на основе оценки сопоставления адресов
|
minmatch | number |
Минимальная оценка соответствия результату должна быть возвращена. Принятые значения: 0.1 – 1.0 (включительно) |
|
|
Точность оценки соответствия
|
matchprecision | integer |
Десятичная точка, по которой значение оценки соответствия должно быть усечено. Принятые значения: 1-10 |
|
|
Filter
|
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 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
УРИ
|
header.uri | string |
УРИ |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
сопоставление
|
header.matchprecision | integer |
сопоставление |
|
эпоха
|
header.epoch | string |
эпоха |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
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 |
|
ПОЧТОВЫЙ ИНДЕКС
|
results.DPA.POSTCODE | string |
ПОЧТОВЫЙ ИНДЕКС |
|
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 |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
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 |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |