Locais de Levantamento de Munições (Pré-visualização)
A API do OS Places fornece uma visão detalhada de um endereço e seu ciclo de vida. Ele contém todos os registros de AddressBase Premium e, portanto, fornece todas as informações relacionadas a um endereço ou propriedade desde a criação até a aposentadoria. Ele contém autoridades locais, endereços Ordnance Survey e Royal Mail, endereços atuais e alternativas para endereços atuais, endereços provisórios (como desenvolvimentos de planejamento) e informações históricas.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Levantamento de Munições |
| URL | https://www.ordnancesurvey.co.uk/business-government |
| technicalservices@os.uk |
| Metadados do conector | |
|---|---|
| Editora | Levantamento de Munições |
| Sítio Web | https://www.ordnancesurvey.co.uk/business-government |
| Política de privacidade | https://www.ordnancesurvey.co.uk/governance/policies/privacy |
| Categorias | Dados; Inteligência de Negócios |
O Ordnance Survey Places permite que os usuários identifiquem endereços com precisão. As pesquisas interrogam a Autoridade Local e os conjuntos de dados de endereços do Royal Mail.
As solicitações podem ser feitas usando um endereço completo ou parcial, um código postal ou um ID de propriedade exclusivo. As pesquisas também podem encontrar endereços mais próximos de um determinado ponto ou todos os endereços conhecidos dentro de uma área ou círculo definido pelo usuário.
Pré-requisitos
A API OS Places requer uma licença ativa com o Ordnance Survey. Os clientes devem se inscrever para uma avaliação gratuita ou assinaturas premium para gerar a chave de acesso necessária login para o API Connector.
Como obter credenciais
Para saber mais sobre as opções de lugar de assinatura, entre em contato com a Ordnance Survey aqui: https://developer.ordnancesurvey.co.uk/content/contact-us
Introdução ao conector
A documentação da API pode ser encontrada aqui https://apidocs.os.uk/docs/os-places-overview
Nosso guia de introdução aborda como criar um aplicativo na plataforma de energia usando o conector Places do Ordnance Survey e pode ser encontrado aqui: https://github.com/OrdnanceSurvey/OS-Places-MS-Power-Platform-Connector
Realizar uma pesquisa de endereço de texto livre em aplicativos avançados: isso pode ser feito adicionando uma caixa de texto e um botão a uma tela simples. Definindo o botão OnSelect para:
Set (searchResults, OSPlaces.Find ('Barra de pesquisa'. Text).results) & UpdateContext({NoSearch: true})
Os resultados da barra de pesquisa podem ser enviados para a definição OSPlaces.Find e os resultados são armazenados em uma variável chamada searchResults. A variável pode ser exibida como uma galeria ou tabela de dados na tela.
Esta abordagem é adequada para Find, Postcode, UPRN e definições de coordenadas e é uma boa maneira de começar a usar o conector.
Problemas conhecidos e limitações
Os recursos Corresponder e Limpar não fazem parte desse conector, pois ele foi projetado principalmente como uma ferramenta de consulta de endereço e não como uma ferramenta de limpeza de banco de dados dentro da Power Platform.
FAQ
Se você tiver alguma dúvida sobre o uso deste conector, consulte nossas perguntas frequentes: https://developer.ordnancesurvey.co.uk/os-apis-developer-portal-faqs
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | securestring | A chave de API para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Encontrar Operação |
Uma pesquisa de texto livre concebida para utilização rápida, por exemplo, preenchimento de formulários. |
| Operação da caixa delimitadora |
Leva dois pontos e cria uma caixa delimitadora. Todos os endereços dentro dessa caixa delimitadora são retornados. |
| Operação de código postal |
Uma pesquisa com base no código postal de uma propriedade. O mínimo para o recurso é a área e o distrito, por exemplo, SO16, e aceitará um código postal completo composto pela área, distrito, setor e unidade, por exemplo, SO16 0AS |
| Operação de raio |
Toma um par de coordenadas como o centro de um círculo e retorna todos os endereços que são cruzados por ele. |
| Operação do Polígono |
Uma solicitação POST que usa um polígono geoJSON ou um objeto multipolígono e retorna todos os endereços que estão no objeto. |
| Operação mais próxima |
Usa um par de coordenadas (X e Y) como entrada para determinar o endereço mais próximo. |
| Operação UPRN |
Uma pesquisa que usa um UPRN (Unique Property Reference Number) como parâmetro de pesquisa. |
Encontrar Operação
Uma pesquisa de texto livre concebida para utilização rápida, por exemplo, preenchimento de formulários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
A consulta de endereço.
|
query | True | string |
O parâmetro de pesquisa de texto livre. |
|
Formato dos resultados
|
format | string |
O formato em que a resposta será retornada. Padrão: JSON. Valores aceites: 'JSON', 'XML' |
|
|
Limitar resultados
|
maxresults | integer |
O número máximo de resultados a serem retornados. Padrão: 100 |
|
|
Compensar o resultado
|
offset | integer |
Compensar a lista de devolvidos por este montante. |
|
|
Resultados do endereço da Autoridade Local (LPI) e/ou Royal Mail (DPA)
|
dataset | string |
O conjunto de dados de endereço a ser retornado. Vários valores podem ser enviados, separados por uma vírgula. Padrão: DPA. Valores aceitos: DPA, LPI |
|
|
Linguagem
|
lr | string |
Qual o idioma dos endereços a devolver. As línguas válidas são o inglês e o galês. Filtro aplicável apenas ao conjunto de dados DPA. O valor padrão é ambos os idiomas. Padrão: EN, CY. |
|
|
Limitar os resultados com base na pontuação de correspondência de endereço
|
minmatch | number |
A pontuação mínima de um resultado tem de ser devolvida. Valores aceites: 0,1 - 1,0 (inclusive) |
|
|
Precisão da pontuação da partida
|
matchprecision | integer |
A posição decimal na qual o valor da pontuação de correspondência deve ser truncado. Valores aceites: 1-10 |
|
|
Filter
|
fq | string |
Um filtro que permite filtrar os resultados por código de classificação e/ou código de estado lógico. A filtragem do código de classificação aceitará pesquisas curinga (*). Várias pesquisas podem ser feitas no código de classificação separando o parâmetro do código de classificação com um espaço. Os filtros de código de classificação podem ser executados com filtros de código de status lógico usando o parâmetro várias vezes: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Sistema de referência espacial de saída
|
output_srs | string |
O sistema de referência espacial de saída pretendido. Padrão: EPSG:27700. Valores aceites: BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258 |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URI
|
header.uri | string |
URI |
|
consulta
|
header.query | string |
consulta |
|
offset
|
header.offset | integer |
offset |
|
resultados totais
|
header.totalresults | integer |
resultados totais |
|
format
|
header.format | string |
format |
|
conjunto de dados
|
header.dataset | string |
conjunto de dados |
|
LR
|
header.lr | string |
LR |
|
maxresultados
|
header.maxresults | integer |
maxresultados |
|
precisão de correspondência
|
header.matchprecision | integer |
precisão de correspondência |
|
época
|
header.epoch | string |
época |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ENDEREÇO
|
results.DPA.ADDRESS | string |
ENDEREÇO |
|
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 |
|
CÓDIGO POSTAL
|
results.DPA.POSTCODE | string |
CÓDIGO POSTAL |
|
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 |
|
ENDEREÇO
|
results.LPI.ADDRESS | string |
ENDEREÇO |
|
URSS
|
results.LPI.USRN | string |
URSS |
|
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 |
Operação da caixa delimitadora
Leva dois pontos e cria uma caixa delimitadora. Todos os endereços dentro dessa caixa delimitadora são retornados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Caixa delimitadora
|
bbox | True | string |
Um par de coordenadas separadas por vírgulas com uma precisão de duas casas decimais ou menos, que especificam as coordenadas inferior esquerda e superior direita da caixa delimitadora. O tamanho máximo da caixa delimitadora é de 1 km2. Se a caixa delimitadora exceder isso, uma mensagem de erro será retornada. A precisão das coordenadas é de 8 metros. |
|
Formato dos resultados
|
format | string |
O formato em que a resposta será retornada. Padrão: JSON. Valores aceites: JSON, XML |
|
|
Limitar resultados
|
maxresults | integer |
O número máximo de resultados a serem retornados. Padrão: 100 |
|
|
Compensar o resultado
|
offset | integer |
Compensar a lista de devolvidos por este montante. |
|
|
Resultados do endereço da Autoridade Local (LPI) e/ou Royal Mail (DPA)
|
dataset | string |
O conjunto de dados de endereço a ser retornado. Vários valores podem ser enviados, separados por uma vírgula. Padrão: DPA. Valores aceites: DPA, LPI |
|
|
Linguagem
|
lr | string |
Qual o idioma dos endereços a devolver. As línguas válidas são o inglês e o galês. Filtro aplicável apenas ao conjunto de dados DPA. O valor padrão é ambos os idiomas. Padrão: EN, CY. |
|
|
Filter
|
fq | string |
Um filtro que permite filtrar os resultados por código de classificação e/ou código de estado lógico. A filtragem do código de classificação aceitará pesquisas curinga (*). Várias pesquisas podem ser feitas no código de classificação separando o parâmetro do código de classificação com um espaço. Os filtros de código de classificação podem ser executados com filtros de código de status lógico usando o parâmetro várias vezes: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Sistema de referência espacial de saída
|
output_srs | string |
O sistema de referência espacial de saída pretendido. Padrão: EPSG:27700. |
|
|
Sistema de referência de coordenadas de entrada
|
srs | string |
O sistema de referência espacial para o conjunto de coordenadas de entrada. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URI
|
header.uri | string |
URI |
|
consulta
|
header.query | string |
consulta |
|
offset
|
header.offset | integer |
offset |
|
resultados totais
|
header.totalresults | integer |
resultados totais |
|
format
|
header.format | string |
format |
|
conjunto de dados
|
header.dataset | string |
conjunto de dados |
|
LR
|
header.lr | string |
LR |
|
maxresultados
|
header.maxresults | integer |
maxresultados |
|
precisão de correspondência
|
header.matchprecision | integer |
precisão de correspondência |
|
época
|
header.epoch | string |
época |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ENDEREÇO
|
results.DPA.ADDRESS | string |
ENDEREÇO |
|
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 |
|
CÓDIGO POSTAL
|
results.DPA.POSTCODE | string |
CÓDIGO POSTAL |
|
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 |
|
ENDEREÇO
|
results.LPI.ADDRESS | string |
ENDEREÇO |
|
URSS
|
results.LPI.USRN | string |
URSS |
|
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 |
Operação de código postal
Uma pesquisa com base no código postal de uma propriedade. O mínimo para o recurso é a área e o distrito, por exemplo, SO16, e aceitará um código postal completo composto pela área, distrito, setor e unidade, por exemplo, SO16 0AS
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Um código postal ao estilo do Reino Unido
|
postcode | True | string |
O parâmetro de pesquisa de código postal. |
|
Formato dos resultados
|
format | string |
O formato em que a resposta será retornada. Padrão: JSON. Valores aceites: 'JSON', 'XML' |
|
|
Limitar resultados
|
maxresults | integer |
O número máximo de resultados a serem retornados. Padrão: 100 |
|
|
Compensar o resultado
|
offset | integer |
Compensar a lista de devolvidos por este montante. |
|
|
Resultados do endereço da Autoridade Local (LPI) e/ou Royal Mail (DPA)
|
dataset | string |
O conjunto de dados de endereço a ser retornado. Vários valores podem ser enviados, separados por uma vírgula. Padrão: DPA. Valores aceites: DPA, LPI |
|
|
Linguagem
|
lr | string |
Qual o idioma dos endereços a devolver. As línguas válidas são o inglês e o galês. Filtro aplicável apenas ao conjunto de dados DPA. O valor padrão é ambos os idiomas. Padrão: EN, CY. |
|
|
Filter
|
fq | string |
Um filtro que permite filtrar os resultados por código de classificação e/ou código de estado lógico. A filtragem do código de classificação aceitará pesquisas curinga (*). Várias pesquisas podem ser feitas no código de classificação separando o parâmetro do código de classificação com um espaço. Os filtros de código de classificação podem ser executados com filtros de código de status lógico usando o parâmetro várias vezes: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Sistema de referência espacial de saída
|
output_srs | string |
O sistema de referência espacial de saída pretendido. Padrão: EPSG:27700. Valores aceites: BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258 |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URI
|
header.uri | string |
URI |
|
consulta
|
header.query | string |
consulta |
|
offset
|
header.offset | integer |
offset |
|
resultados totais
|
header.totalresults | integer |
resultados totais |
|
format
|
header.format | string |
format |
|
conjunto de dados
|
header.dataset | string |
conjunto de dados |
|
LR
|
header.lr | string |
LR |
|
maxresultados
|
header.maxresults | integer |
maxresultados |
|
precisão de correspondência
|
header.matchprecision | integer |
precisão de correspondência |
|
época
|
header.epoch | string |
época |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ENDEREÇO
|
results.DPA.ADDRESS | string |
ENDEREÇO |
|
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 |
|
CÓDIGO POSTAL
|
results.DPA.POSTCODE | string |
CÓDIGO POSTAL |
|
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 |
|
ENDEREÇO
|
results.LPI.ADDRESS | string |
ENDEREÇO |
|
URSS
|
results.LPI.USRN | string |
URSS |
|
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 |
Operação de raio
Toma um par de coordenadas como o centro de um círculo e retorna todos os endereços que são cruzados por ele.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Um conjunto de coordenadas separadas por vírgulas
|
point | True | string |
Um conjunto de coordenadas separadas por vírgulas no BNG que especifica a coordenada no centro do círculo de pesquisa. A precisão das coordenadas é de duas casas decimais (ou seja, precisão de 1 cm). |
|
Raio de pesquisa
|
radius | integer |
O raio para procurar dentro em metros. O raio máximo é de 1.000 metros. Se acima, uma mensagem de erro é retornada. A precisão da distância é de duas casas decimais (ou seja, precisão de 1 cm). Padrão: 100. Valores aceites: 0,01 - 1000 |
|
|
Formato dos resultados
|
format | string |
O formato em que a resposta será retornada. Padrão: JSON. Valores aceitos JSON, XML |
|
|
Limitar resultados
|
maxresults | integer |
O número máximo de resultados a serem retornados. Padrão: 100 |
|
|
Compensar o resultado
|
offset | integer |
Compensar a lista de devolvidos por este montante. |
|
|
Resultados do endereço da Autoridade Local (LPI) e/ou Royal Mail (DPA)
|
dataset | string |
O conjunto de dados de endereço a ser retornado. Vários valores podem ser enviados, separados por uma vírgula. Padrão: DPA. Valores aceites: DPA, LPI |
|
|
Linguagem
|
lr | string |
Qual o idioma dos endereços a devolver. As línguas válidas são o inglês e o galês. Filtro aplicável apenas ao conjunto de dados DPA. O valor padrão é ambos os idiomas. Padrão: EN, CY |
|
|
Filter
|
fq | string |
Um filtro que permite filtrar os resultados por código de classificação e/ou código de estado lógico. A filtragem do código de classificação aceitará pesquisas curinga (*). Várias pesquisas podem ser feitas no código de classificação separando o parâmetro do código de classificação com um espaço. Os filtros de código de classificação podem ser executados com filtros de código de status lógico usando o parâmetro várias vezes: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Sistema de referência espacial de saída
|
output_srs | string |
O sistema de referência espacial de saída pretendido. Padrão: EPSG:27700. Valores aceites: «BNG», «EPSG:27700», «WGS84», «EPSG:4326», «EPSG:3857», «EPSG:4258» |
|
|
Sistema de referência espacial de entrada
|
srs | string |
O sistema de referência espacial para o conjunto de coordenadas de entrada. Valores aceites: «BNG», «EPSG:27700», «WGS84», «EPSG:4326», «EPSG:3857», «EPSG:4258» |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URI
|
header.uri | string |
URI |
|
consulta
|
header.query | string |
consulta |
|
offset
|
header.offset | integer |
offset |
|
resultados totais
|
header.totalresults | integer |
resultados totais |
|
format
|
header.format | string |
format |
|
conjunto de dados
|
header.dataset | string |
conjunto de dados |
|
LR
|
header.lr | string |
LR |
|
maxresultados
|
header.maxresults | integer |
maxresultados |
|
precisão de correspondência
|
header.matchprecision | integer |
precisão de correspondência |
|
época
|
header.epoch | string |
época |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ENDEREÇO
|
results.DPA.ADDRESS | string |
ENDEREÇO |
|
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 |
|
CÓDIGO POSTAL
|
results.DPA.POSTCODE | string |
CÓDIGO POSTAL |
|
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 |
|
ENDEREÇO
|
results.LPI.ADDRESS | string |
ENDEREÇO |
|
URSS
|
results.LPI.USRN | string |
URSS |
|
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 |
Operação do Polígono
Uma solicitação POST que usa um polígono geoJSON ou um objeto multipolígono e retorna todos os endereços que estão no objeto.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Ponto de referência
|
referencepoint | integer |
A geometria do ponto de referência é a base a partir da qual o valor da distância é calculado. A saída é ordenada por distância crescente de determinado ponto de referência somente se o parâmetro tiver sido especificado. |
|
|
Limitar resultados
|
maxresults | integer |
O número máximo de resultados a serem retornados. Padrão: 100 |
|
|
Resultados do endereço da Autoridade Local (LPI) e/ou Royal Mail (DPA)
|
dataset | string |
O conjunto de dados de endereço a ser retornado. Vários valores podem ser enviados, separados por uma vírgula. Padrão: DPA. Valores aceites: DPA, LPI |
|
|
Compensar o resultado
|
offset | integer |
Compensar a lista de devolvidos por este montante. |
|
|
Linguagem
|
lr | string |
Qual o idioma dos endereços a devolver. As línguas válidas são o inglês e o galês. Filtro aplicável apenas ao conjunto de dados DPA. O valor padrão é ambos os idiomas. Padrão: EN, CY. |
|
|
Filter
|
fq | string |
Um filtro que permite filtrar os resultados por código de classificação e/ou código de estado lógico. A filtragem do código de classificação aceitará pesquisas curinga (*). Várias pesquisas podem ser feitas no código de classificação separando o parâmetro do código de classificação com um espaço. Os filtros de código de classificação podem ser executados com filtros de código de status lógico usando o parâmetro várias vezes: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Sistema de referência espacial de saída
|
output_srs | string |
O sistema de referência espacial de saída pretendido. Padrão: EPSG:27700. Valores aceites: «BNG», «EPSG:27700», «WGS84», «EPSG:4326», «EPSG:3857», «EPSG:4258» |
|
|
Sistema de referência de coordenadas de entrada
|
srs | string |
O sistema de referência espacial para o conjunto de coordenadas de entrada. |
|
|
Tipo de conteúdo
|
Content-type | True | string |
O cabeçalho Content-Type. Valores aceites: 'application/json' |
|
tipo
|
type | True | string |
O par nome:valor para o polígono geoJSON. Valores aceitos: um recurso |
|
geometria
|
geometry | True | string |
Aqui é onde o objeto de polígono é colocado. Valores aceitos: um objeto de polígono |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URI
|
header.uri | string |
URI |
|
consulta
|
header.query | string |
consulta |
|
offset
|
header.offset | integer |
offset |
|
resultados totais
|
header.totalresults | integer |
resultados totais |
|
format
|
header.format | string |
format |
|
conjunto de dados
|
header.dataset | string |
conjunto de dados |
|
LR
|
header.lr | string |
LR |
|
maxresultados
|
header.maxresults | integer |
maxresultados |
|
precisão de correspondência
|
header.matchprecision | integer |
precisão de correspondência |
|
época
|
header.epoch | string |
época |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ENDEREÇO
|
results.DPA.ADDRESS | string |
ENDEREÇO |
|
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 |
|
CÓDIGO POSTAL
|
results.DPA.POSTCODE | string |
CÓDIGO POSTAL |
|
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 |
|
ENDEREÇO
|
results.LPI.ADDRESS | string |
ENDEREÇO |
|
URSS
|
results.LPI.USRN | string |
URSS |
|
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 |
Operação mais próxima
Usa um par de coordenadas (X e Y) como entrada para determinar o endereço mais próximo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Um conjunto de coordenadas separadas por vírgulas
|
point | True | string |
Um conjunto de coordenadas separado por vírgulas que especifica a coordenada na qual o registro mais próximo em uma linha reta deve ser encontrado. A distância máxima que a busca tentará é de 1.000 metros. A precisão das coordenadas é de duas casas decimais (ou seja, precisão de 1 cm). |
|
Raio de pesquisa
|
radius | integer |
O raio em metros para procurar dentro. O máximo é de 1.000 metros. Se o raio exceder esse valor, uma mensagem de erro será retornada (veja abaixo). A precisão da distância é de duas casas decimais (ou seja, precisão de 1 cm). Padrão: 100. |
|
|
Formato dos resultados
|
format | string |
O formato em que a resposta será retornada. Padrão: JSON. Valores aceites: JSON, XML |
|
|
Resultados do endereço da Autoridade Local (LPI) e/ou Royal Mail (DPA)
|
dataset | string |
O conjunto de dados de endereço a ser retornado. Vários valores podem ser enviados, separados por uma vírgula. Padrão: DPA. Valores aceites: DPA, LPI |
|
|
Linguagem
|
lr | string |
Qual o idioma dos endereços a devolver. As línguas válidas são o inglês e o galês. Filtro aplicável apenas ao conjunto de dados DPA. O valor padrão é ambos os idiomas. Padrão: EN, CY |
|
|
Filter
|
fq | string |
Um filtro que permite filtrar os resultados por código de classificação e/ou código de estado lógico. A filtragem do código de classificação aceitará pesquisas curinga (*). Várias pesquisas podem ser feitas no código de classificação separando o parâmetro do código de classificação com um espaço. Os filtros de código de classificação podem ser executados com filtros de código de status lógico usando o parâmetro várias vezes: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Sistema de referência espacial de saída
|
output_srs | string |
O sistema de referência espacial de saída pretendido. Padrão: EPSG:27700. Valores aceites: BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258 |
|
|
Sistema de referência espacial de entrada
|
srs | string |
O sistema de referência espacial para o conjunto de coordenadas de entrada. Valores aceites: «BNG», «EPSG:27700», «WGS84», «EPSG:4326», «EPSG:3857», «EPSG:4258» |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URI
|
header.uri | string |
URI |
|
consulta
|
header.query | string |
consulta |
|
offset
|
header.offset | integer |
offset |
|
resultados totais
|
header.totalresults | integer |
resultados totais |
|
format
|
header.format | string |
format |
|
conjunto de dados
|
header.dataset | string |
conjunto de dados |
|
LR
|
header.lr | string |
LR |
|
maxresultados
|
header.maxresults | integer |
maxresultados |
|
precisão de correspondência
|
header.matchprecision | integer |
precisão de correspondência |
|
época
|
header.epoch | string |
época |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ENDEREÇO
|
results.DPA.ADDRESS | string |
ENDEREÇO |
|
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 |
|
CÓDIGO POSTAL
|
results.DPA.POSTCODE | string |
CÓDIGO POSTAL |
|
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 |
|
ENDEREÇO
|
results.LPI.ADDRESS | string |
ENDEREÇO |
|
URSS
|
results.LPI.USRN | string |
URSS |
|
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 |
Operação UPRN
Uma pesquisa que usa um UPRN (Unique Property Reference Number) como parâmetro de pesquisa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
UPRN válido
|
uprn | True | integer |
Inteiro no formato de um UPRN (Número de Referência de Propriedade Único) |
|
Formato dos resultados
|
format | string |
O formato em que a resposta será retornada. Padrão: JSON. Valores aceites: JSON, XML |
|
|
Resultados do endereço da Autoridade Local (LPI) e/ou Royal Mail (DPA)
|
dataset | string |
O conjunto de dados de endereço a ser retornado. Vários valores podem ser enviados, separados por uma vírgula. Padrão: DPA. Valores aceites: DPA, LPI |
|
|
Linguagem
|
lr | string |
Qual o idioma dos endereços a devolver. As línguas válidas são o inglês e o galês. Filtro aplicável apenas ao conjunto de dados DPA. O valor padrão é ambos os idiomas. Padrão: EN, CY. |
|
|
Filter
|
fq | string |
Um filtro que permite filtrar os resultados por código de classificação e/ou código de estado lógico. A filtragem do código de classificação aceitará pesquisas curinga (*). Várias pesquisas podem ser feitas no código de classificação separando o parâmetro do código de classificação com um espaço. Os filtros de código de classificação podem ser executados com filtros de código de status lógico usando o parâmetro várias vezes: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6" |
|
|
Sistema de referência espacial de saída
|
output_srs | string |
O sistema de referência espacial de saída pretendido. Padrão: EPSG:27700. Valores aceites: BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258 |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URI
|
header.uri | string |
URI |
|
consulta
|
header.query | string |
consulta |
|
offset
|
header.offset | integer |
offset |
|
resultados totais
|
header.totalresults | integer |
resultados totais |
|
format
|
header.format | string |
format |
|
conjunto de dados
|
header.dataset | string |
conjunto de dados |
|
LR
|
header.lr | string |
LR |
|
maxresultados
|
header.maxresults | integer |
maxresultados |
|
precisão de correspondência
|
header.matchprecision | integer |
precisão de correspondência |
|
época
|
header.epoch | string |
época |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ENDEREÇO
|
results.DPA.ADDRESS | string |
ENDEREÇO |
|
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 |
|
CÓDIGO POSTAL
|
results.DPA.POSTCODE | string |
CÓDIGO POSTAL |
|
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 |
|
ENDEREÇO
|
results.LPI.ADDRESS | string |
ENDEREÇO |
|
URSS
|
results.LPI.USRN | string |
URSS |
|
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 |