POST

api/genericos/ge/Pessoa/ConsultarCepGestor

Notas de Implementação:

Método para consultar informações referente a CEP informado.

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 as informações de CEP em formato de DTO.

EnderecoDTO

NomeDescriçãoTipoInformaçã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

Exemplo: 
{
  "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:

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Objeto JSON com os dados do CEP retornados na consulta.

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo: 
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
401 Não autorizado

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
500 Requisição falhou

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}