CEP

CEP

Webservices de CEP

Endpoints

Produção: http://www.soawebservices.com.br/webservices/producao/cep/cep.asmx

Test-Drive: http://www.soawebservices.com.br/webservices/test-drive/cep/cep.asmx

Método: ConsultaCEP

Descrição: Consulta a base de CEP:

Headers:

POST /webservices/producao/cep/cep.asmx HTTP/1.1
Host: www.soawebservices.com.br
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "SOAWebServices/ConsultaCEP"

Requisição SOAP/XML:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConsultaCEP xmlns="SOAWebServices">
      <Credenciais>
        <Email>string</Email>
        <Senha>string</Senha>
      </Credenciais>
      <CEP>string</CEP>
    </ConsultaCEP>
  </soap:Body>
</soap:Envelope>

Resposta SOAP/XML:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConsultaCEPResponse xmlns="SOAWebServices">
      <ConsultaCEPResult>
        <CEP>string</CEP>
        <TipoLogradouro>string</TipoLogradouro>
        <Logradouro>string</Logradouro>
        <Bairro>string</Bairro>
        <UF>string</UF>
        <Estado>string</Estado>
        <Cidade>string</Cidade>
        <CodigoIBGE>string</CodigoIBGE>
        <Mensagem>string</Mensagem>
        <Status>boolean</Status>
        <Transacao>
          <Status>boolean</Status>
          <CodigoStatus>string</CodigoStatus>
          <CodigoStatusDescricao>string</CodigoStatusDescricao>
        </Transacao>
      </ConsultaCEPResult>
    </ConsultaCEPResponse>
  </soap:Body>
</soap:Envelope>

Modelo de Dados:

Item	Tipo	Nome	Descrição
1	varchar(8)	CEP	CEP
2	varchar(30)	TipoLogradouro	Tipo de Logradouro. Ex: RUA, AV
3	varchar(100)	Logradouro	Logradouro
4	varchar(100)	Bairro	Bairro
5	varchar(2)	UF	Unidade Federativa
6	varchar(2)	Estado	Estado
7	varchar(2)	Cidade	Cidade
8	varchar(2)	CodigoIBGE	Codigo IBGE do Municipio
9	varchar(2)	Mensagem	Mensagem da transação(*)
10	boolean	Status	Status da transação(*)
11	XML Node	Transacao	Node contendo mensagem padronizada sobre a transação.
11	varchar(2)	Status	Status da Transação
11	varchar(2)	CodigoStatus	Código de Status
11	varchar(2)	CodigoStatusDescricao	Descrição do Codigo de Status

Método: ConsultaCEPEstendida

Descrição: Consulta a base de CEP com Desmembramento de informações:

Existem algumas situaçãoes onde os correios retornam o bairro ou um distrito com informações extras como por exemplo: Bairro: JARDIM DAS FLORES - PQ INDUSTRIAL.

Neste caso separamos as informacoes em campos complementares.

Headers:

POST /webservices/producao/cep/cep.asmx HTTP/1.1
Host: www.soawebservices.com.br
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "SOAWebServices/ConsultaCEPEstendida"

Requisição SOAP/XML:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConsultaCEPEstendida xmlns="SOAWebServices">
      <Credenciais>
        <Email>string</Email>
        <Senha>string</Senha>
      </Credenciais>
      <CEP>string</CEP>
    </ConsultaCEPEstendida>
  </soap:Body>
</soap:Envelope>

Resposta SOAP/XML:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConsultaCEPEstendidaResponse xmlns="SOAWebServices">
      <ConsultaCEPEstendidaResult>
        <CEP>string</CEP>
        <TipoLogradouro>string</TipoLogradouro>
        <Logradouro>string</Logradouro>
        <LogradouroComplemento>string</LogradouroComplemento>
        <Bairro>string</Bairro>
        <BairroComplemento>string</BairroComplemento>
        <UF>string</UF>
        <Estado>string</Estado>
        <Cidade>string</Cidade>
        <CodigoIBGE>string</CodigoIBGE>
        <Mensagem>string</Mensagem>
        <Status>boolean</Status>
        <Transacao>
          <Status>boolean</Status>
          <CodigoStatus>string</CodigoStatus>
          <CodigoStatusDescricao>string</CodigoStatusDescricao>
        </Transacao>
      </ConsultaCEPEstendidaResult>
    </ConsultaCEPEstendidaResponse>
  </soap:Body>
</soap:Envelope>

Modelo de Dados:

Item	Tipo	Nome	Descrição
1	varchar(8)	CEP	CEP
2	varchar(30)	TipoLogradouro	Tipo de Logradouro. Ex: RUA, AV
3	varchar(100)	Logradouro	Logradouro
4	varchar(100)	LogradouroComplemento	Logradouro Complemento
5	varchar(100)	Bairro	Bairro
6	varchar(100)	BairroComplemento	Bairro Complemento
7	varchar(2)	UF	Unidade Federativa
8	varchar(2)	Estado	Estado
9	varchar(2)	Cidade	Cidade
10	varchar(2)	CodigoIBGE	Codigo IBGE do Municipio
11	varchar(2)	Mensagem	Mensagem da transação(*)
12	boolean	Status	Status da transação(*)
13	XML Node	Transacao	Node contendo mensagem padronizada sobre a transação.
13	varchar(2)	Status	Status da Transação
13	varchar(2)	CodigoStatus	Código de Status
13	varchar(2)	CodigoStatusDescricao	Descrição do Codigo de Status

Atenção(*):

Todas as transações estão vindo agora com o Node XML <Transacao>, este node tem como finalidade padronizar as respostas de status e descrições. Quando estiver integrando suas aplicações nao utilizar as tags <Status> e <Descricao> porque elas serão descontinuadas em breve.

As mensagens de status novas estão documentadas no link abaixo: http://www.soawebservices.com.br/integracao/manuais/mensagens.aspx