GET

api/genericos/ge/Cep/Buscar

Notas de Implementação:

Método para buscar os dados referente ao CEP.

Esse método suporta a passagem de parâmetros de consultas OData para restringir os resultados. Mais informações em: https://learn.microsoft.com/pt-br/odata/overview

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

Cep

NomeDescriçãoTipoInformação Adicional
CepNovo

integer

Opcional
CepAntigo

integer

Opcional
NomeRua

string

Opcional
Cidade

string

Opcional
BairroInicial

string

Opcional
BairroFinal

string

Opcional
Estado

string

Opcional
TipoLogradouro

string

Opcional
Regiao

string

Opcional
CodigoLocalidade

decimal number

Opcional
Id

decimal number

Opcional
Municipio

Municipio

Opcional

Formato de Resposta:

Classe de Resposta (Status 200)

Objeto JSON com lista dos dados referente ao CEP.

application/json, text/json

Exemplo: 
[
  {
    "CepNovo": 1,
    "CepAntigo": 2,
    "NomeRua": "string 3",
    "Cidade": "string 4",
    "BairroInicial": "string 5",
    "BairroFinal": "string 6",
    "Estado": "string 7",
    "TipoLogradouro": "string 8",
    "Regiao": "string 9",
    "CodigoLocalidade": 10.1,
    "Id": 11.1,
    "Municipio": {
      "NomeMunicipio": "string 1",
      "UF": "string 2",
      "Codigo": "string 3",
      "CodigoGiaEstadual": "string 4",
      "CEPInicial": 5,
      "CEPFinal": 6,
      "CodigoPais": "string 7"
    }
  }
]