Método de consulta que retorna informações de um logradouro.
Chamada
GET [URLAPI]/ConectorDadosGlobaisAPI/Enderecos/api/v1/logradouro
Informações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
Logradouro | Nome do Logradouro à ser pesquisado | string | Obrigatório. |
Município | Nome ou Identificador IBGE do município que deseja buscar. | string | Obrigatório. |
| UF | UF ou Identificador IBGE da UF - Algumas UFs possuem municípios com nomes iguais, nesse caso, se a UF for nula serão retornados todos os municípios do filtro. | string | Obrigatório. |
Parâmetros do Corpo (Body Parameters)
Não há.
Informações para Resposta (Response Information)
Códigos do Recurso (Response Codes)
Formatos de Resposta (Response Formats)
application/json, text/json
CODE 200 - SUCCESS
[ { "cep": "string", "logradouro": "string", "complemento": "string", "bairro": "string", "municipio": "string", "uf": "string", "ibgeMunicipio": "string" }
] |
application/json, text/json
CODE 400 - BAD
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"notificationType": 0,
"code": "string",
"message": "string",
"detailedMessage": "string",
"status": 0
}
]
}
|