BuscarCep

BuscarCep

A função BuscarCep recebe um CEP e retorna os dados de endereço associados a este CEP.

Tipo de Retorno

tBuscaCep

Pacote

A função BuscarCep está definida dentro do pacote BuscarCep.pkg.

Sintaxe

Move (BuscarCep({sCEP},{sChave},{sIdentificador})) to {vRet}

Onde:

• {sCEP} é o CEP que será consultado e pode ser passado com ou sem o “-“;
• {sChave} é a chave que será fornecida pelo site http://www.BuscarCep.com.br após efetuar o cadastro;
• {sIdentificador} pode ser usado como controle para identificar quem está chamando a função, e caso não seja desejado utilizar este parâmetro, basta passar o mesmo em branco. Este parâmetro pode ser útil quando houver uma única conta no site http://www.BuscarCep.com.br para todos os clientes, sendo que neste caso poderia ser usado o {sIdentificador} para passar uma identificação de cada cliente que está usando a função;
• {vRet} é uma variável do tipo tBuscaCep onde serão devolvidas as informações da consulta feita.

Exemplo

O projeto de exemplo que acompanha o MenuFlex possui uma View ExemploBuscarCEP.vw que mostra a utilização desta função:

Observações

• Deve ser verificado o valor do campo iResultado da estrutura do retorno para saber se a consulta foi bem sucedida. Os valores possíveis para iResultado são:
  • 1 – Sucesso, CEP encontrado;
  • -1 – CEP não encontrado;
  • -2 – Formato de CEP inválido;
  • -3 – Limite de buscas de IP por minuto excedido;
  • -4 – IP banido, contate o administrador;
  • -5 – Chave banida, contate o administrador;
  • -6 – Entre 0 e 6 horas da madrugada todas as buscas são limitadas a 5 buscas por minuto;
  • -7 – Chave inválida, cadastre-se para continuar utilizando o servico;
  • -8 – Chave inativa;
  • -995 – Falha na leitura dos dados devolvidos pelo serviço Web (http://www.BuscarCep.com.br);
  • -996 – Falha na conexão com o serviço Web (http://www.BuscarCep.com.br). Verifique sua conexão com a internet e tente novamente;
  • -997 – É obrigatório informar o CEP para a consulta;
  • -998 – É obrigatório informar a chave de utilização para consulta, obtenha esta chave cadastrando-se no site http://www.BuscarCep.com.br;
  • -999 – Erro na criação de objeto cXMLDOMDocument;
• Esta função usa o serviço do site http://www.BuscarCep.com.br;
• É necessário se cadastrar no site e obter uma chave que precisará ser passada como parâmetro nesta função para utilizar o serviço;
• Nós não nos responsabilizamos por este serviço e nem podemos garantir sua disponibilidade ininterrupta;
• Recomendamos a assinatura de um plano pago do http://www.BuscarCep.com.br para uso em seus sistemas.