Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Método de consulta que retorna informações de um logradouro.

Chamada

GET [URLAPI]/EnderecosAPI/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.
UFUF 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.stringObrigatório.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

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"
    }
]

...