Notas de Implementação:
Método parar dados de endereço através do CEP informado em formato EnderecoDTO.
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
Modelo:
Informar o CEP pelo qual será realizado a busca das informações.
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| Cep |
CEP do endereço. |
integer |
Obrigatório |
| Municipio |
Município do endereço. |
string |
Opcional |
| Endereco |
descrição do endereço. |
string |
Opcional |
| Bairro |
Bairro do endereço. |
string |
Opcional |
| Uf |
UF do endereço. |
string |
Opcional |
| CodigoPais |
Código do país. |
string |
Opcional |
| TipoLogradouro |
Tipo de logradouro do endereço. |
string |
Opcional |
| VerificarTabela |
Define se a busca do CEP é feita através da tabela GECEP. |
boolean |
Opcional |
Formato de Envio:
application/json, text/json
{
"Cep": 1,
"Municipio": "string 2",
"Endereco": "string 3",
"Bairro": "string 4",
"Uf": "string 5",
"CodigoPais": "string 6",
"TipoLogradouro": "string 7",
"VerificarTabela": true
}
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:
| Nome | Descrição | Tipo | Informaçã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 |
Opcional |
Formato de Resposta:
Classe de Resposta (Status 200)
Objeto JSON com lista dos dados de endereço a partir do CEP informado.
application/json, text/json
{
"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"
}
}