Você está na página 1de 18

BC CORREIO SISTEMA DE CORREIO ELETRNICO DO BANCO CENTRAL DO BRASIL

Manual do Web Service

SUMRIO

Introduo ............................................................................................................... 3 Informaes tcnicas ............................................................................................. 4 Servios................................................................................................................... 5


ConsultarPastasAutorizadas ..................................................................................................................... 5 ConsultarCorreiosPorPasta ....................................................................................................................... 6 LerCorreio ................................................................................................................................................... 9 TransmitirCorreio ..................................................................................................................................... 11 ConsultarComunicacaoGeralDocumentoDivulgacao ............................................................................ 13 LerComunicacaoGeralDocumentoDivulgacao ....................................................................................... 15 ObterAnexo ............................................................................................................................................... 17

Introduo
Web Service uma soluo para integrar aplicaes. Por meio dele, qualquer sistema, escrito em qualquer linguagem, pode conectar-se para consulta ou insero de dados. um padro de interconexo entre sistemas heterogneos, que usa a web e a XML como linguagem para troca de informaes (dados e metadados).

Assim, instituies financeiras que disponham de sistemas prprios para consulta de mensagens e normativos ou transmisso de correios eletrnicos podem ser beneficiadas pela integrao desses sistemas com o BC Correio, usando Web Service. Entretanto, o uso do Web Service facultado s instituies financeiras, no compulsrio. Todas as funcionalidades disponibilizadas via Web Service tambm podem ser acessadas atravs da aplicao com o uso do navegador. Esse servio apenas mais um canal oferecido para interao com o BC Correio.

As seguintes operaes esto disponveis no Web Service do BC Correio: 1. ConsultarPastasAutorizadas Retorna as pastas de correio eletrnico e os setores que o usurio tem permisso de acessar; 2. ConsultarCorreiosPorPasta Retorna uma lista com os cabealhos dos correios eletrnicos contidos em uma pasta; 3. LerCorreio Retorna o contedo de um correio eletrnico; 4. TransmitirCorreio Transmite correio eletrnico submetido pelo usurio. Para ter sucesso na transmisso de correio eletrnico, o usurio deve ter permisso para transmisso do tipo de correio solicitado; 5. ConsultarComunicacaoGeralDocumentoDivulgacao Retorna uma lista com os cabealhos das comunicaes gerais e dos documentos de divulgao transmitidos pelo BC Correio; 6. LerComunicacaoGeralDocumentoDivulgacao Retorna o contedo de uma comunicao geral ou de um documento de divulgao; 7. ObterAnexo Retorna o contedo do anexo de um correio eletrnico.

Assim como ocorre na interface web, o acesso ao Web Service do BC Correio exige autenticao, com usurio e senha. O usurio deve fornecer seus dados no formato:

UUUUUDDDD.OOOOO, onde UUUUU a unidade, DDDD a dependncia (se houver) e OOOOO o cdigo do operador.

necessrio que o usurio esteja associado a um perfil com permisso de acesso ao servio solicitado. Assim, um usurio que tenha permisso para transmitir mensagens no BC Correio, ter permisso para faz-lo por meio do Web Service.

Para saber mais sobre autenticao, consulte o item Acesso Autenticao no Manual do BC Correio. Sobre perfis de acesso consulte Acesso Perfis e transaes tambm nesse manual.

Informaes tcnicas
O Web Service do BC Correio pode ser acessado em: Produo: <https://www3.bcb.gov.br/bccorreiows/CorreioWS.asmx> Homologao: <https://www9.bcb.gov.br/bccorreiows/CorreioWS.asmx>

Aps autenticao, a tela seguinte ser apresentada. Ela exibe todas as operaes (ou servios) disponveis no Web Service do BC Correio. Ao clicar no nome dos servios, pode-se ver exemplos de requisio e resposta elaboradas em um protocolo de troca de informaes estruturadas (SOAP).

A descrio formal dos servios (WSDL) pode ser acessada pela opo Service Description ou diretamente em:

Produo: <https://www3.bcb.gov.br/bccorreiows/CorreioWS.asmx?WSDL> Homologao: <https://www9.bcb.gov.br/bccorreiows/CorreioWS.asmx?WSDL>

Servios
Ao tentar acessar os servios disponveis, possvel receber como resposta uma mensagem de erro. Sempre que o atributo de retorno OcorreuErro estiver configurado como true, o atributo MensagemErro conter uma mensagem com informao sobre o motivo do erro encontrado. Exemplo de resposta com mensagem de erro Dados de retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ConsultarCorreiosPorPastaResponse xmlns="http://www.bcb.gov.br/correiows"> <ConsultarCorreiosPorPastaResult> <MensagemErro>Campo Unidade remetente invlido.</MensagemErro> <OcorreuErro>true</OcorreuErro> <QuantidadeCorreios>0</QuantidadeCorreios> <Correios/> </ConsultarCorreiosPorPastaResult> </ConsultarCorreiosPorPastaResponse> </soap:Body> </soap:Envelope>

ConsultarPastasAutorizadas
O servio ConsultarPastasAutorizadas informa ao usurio todas as pastas s quais tem acesso para leitura de correios. Deve ser usado em conjunto com ConsultarCorreiosPorPasta, de modo que as pastas retornadas sirvam de parmetro no servio de consulta de correios. Parmetros de entrada e dados de retorno do servio ConsultarPastasAutorizadas Atributo Parmetros de entrada
No necessrio nenhum parmetro de entrada para consultar as pastas autorizadas ao usurio.

Tipo

Significado

Dados de retorno
QuantidadePastasAutorizadas int Quantidade de pastas retornadas na consulta. Lista de elementos do tipo PastaAutorizada. Cada pasta contm: Unidade Unidade Unidade da pasta. Esse elemento composto por nome da unidade, indica se a unidade est ativa e apresenta o tipo da unidade, que pode ser UnidadeBanco, UnidadeExterna ou InstituicaoFinanceira. Dependncia da pasta. Tipo da pasta, que pode ser: CaixaEntrada, Destinados, Arquivados, Reservados, Transmitidos, Cancelados ou Setor Setor da pasta. Esse elemento s apresentado quando a

Dependencia Tipo Setor

string string Setor

pasta do tipo Setor. composto por informaes de nome do setor e indica se o setor est ativo.

Exemplo do servio ConsultarPastasAutorizadas Parmetros de entrada


<?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> <ConsultarPastasAutorizadas xmlns="http://www.bcb.gov.br/correiows" /> </soap:Body> </soap:Envelope>

Dados de retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ConsultarPastasAutorizadasResponse xmlns="http://www.bcb.gov.br/correiows"> <ConsultarPastasAutorizadasResult> <OcorreuErro>false</OcorreuErro> <PastasAutorizadas> <PastaAutorizadaWSDTO> <Unidade> <Nome>deinf</Nome> <Ativa>true</Ativa> <Tipo>UnidadeBanco</Tipo> </Unidade> <Dependencia/> <Tipo>CaixaEntrada</Tipo> </PastaAutorizadaWSDTO> <PastaAutorizadaWSDTO> <Unidade> <Nome>deinf</Nome> <Ativa>true</Ativa> <Tipo>UnidadeBanco</Tipo> </Unidade> <Dependencia/> <Setor> <Nome>Disin</Nome> <Ativo>true</Ativo> </Setor> <Tipo>Setor</Tipo> </PastaAutorizadaWSDTO> </PastasAutorizadas> <QuantidadePastasAutorizadas>2</QuantidadePastasAutorizadas> </ConsultarPastasAutorizadasResult> </ConsultarPastasAutorizadasResponse> </soap:Body> </soap:Envelope>

ConsultarCorreiosPorPasta
O servio ConsultarCorreiosPorPasta informa ao usurio os correios das pastas s quais tem acesso. Para consulta, o usurio pode usar filtros por data de transmisso, numerao ou assunto e contedo dos correios.

Os resumos (ou cabealhos) dos correios consultados so retornados por esse servio, com paginao de 10 em 10. Deve-se usar corretamente o elemento de retorno QuantidadeCorreios e o parmetro Pagina, para se obterem todos os resumos de correio filtrados na consulta. Para ler o contedo de um correio eletrnico, esse servio deve ser usado em conjunto com LerCorreio, de modo que os resumos (ou cabealhos) de correios retornados pelo servio de consulta sejam usados como parmetro no servio de leitura. Parmetros de entrada e dados de retorno do servio ConsultarCorreiosPorPasta Atributo Parmetros de entrada
Pasta PastaAutorizada Pasta na qual se deseja consultar os correios. Esse elemento pode ser obtido no retorno do servio ConsultarPastasAutorizadas. Setor destinatrio do correio. Parmetro a ser usado como filtro. Data e hora limite inferior para consulta de correios. Parmetro a ser usado como filtro. Data e hora limite superior para consulta de correios. Parmetro a ser usado como filtro. Nmero do correio. Parmetro a ser usado como filtro. Expresso que deve estar contida no assunto ou no contedo do correio. Parmetro a ser usado como filtro. Unidade do correio. Parmetro a ser usado como filtro. Dependendo da pasta a ser consultada, esse campo funciona como filtro para a unidade remetente ou para a unidade destinatria do correio. Indica se apenas mensagens devem ser retornadas na consulta. Parmetro a ser usado como filtro. Indica se a consulta deve ser realizada em todas as pastas autorizadas para o usurio. Se esse elemento for marcado como true, o elemento unidade, se informado, passa a ser usado como unidade remetente do correio para todas as pastas. Indica a pgina a ser consultada. Levando-se em considerao que o resultado do servio ConsultarCorreiosPorPasta retornado em pginas com limite de 10 correios, deve-se analisar o valor retornado pelo elemento QuantidadeCorreios e usar o elemento Pagina para navegar entre as pginas da consulta.

Tipo

Significado

Setor DataInicial DataFinal NumeroCorreio AssuntoConteudo Unidade

string dateTime dateTime string string string

ApenasMensagens PesquisarEmTodasAsPastas

boolean boolean

Pagina

int

Dados de retorno
QuantidadeCorreios int Quantidade de correios filtrados pela consulta. Se, por exemplo, esse elemento indicar 25 correios filtrados, deve-se usar o elemento Pagina de 0 a 2 para se obterem todos os correios filtrados pela consulta.

Lista de elementos do tipo ResumoCorreio. Cada resumo contm: Assunto Data UnidadeDestinataria DependenciaDestinataria string dateTime string string Assunto do correio. Data de transmisso do correio. Unidade qual o correio foi destinado. Dependncia qual o correio foi destinado. Caso o correio no tenha sido destinado a uma dependncia, esse campo no ser retornado.

UnidadeRemetente DependenciaRemetente Grupo Status TipoCorreio

string string string string Tipo

Unidade do usurio que transmitiu o correio. Dependncia do usurio que transmitiu o correio. Nome do grupo ao qual o correio foi destinado. Status do correio. Tipo do correio, que pode ser um dos valores: MENSAGEM, COMUNICACAO, COMUNICACAOGERAL, INFORMATIVO, COMUNICACAOSOCIAL, LINHADIRETA, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO, COMUNICADOCONJUNTO, DECISAOCONJUNTA, ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO, PORTARIAINTERMINISTERIAL ou INDEFINIDO. Nmero do correio. Pasta na qual o correio est armazenado. Esse elemento til especialmente quando o parmetro PesquisarEmTodasAsPastas for utilizado como true. Setor da unidade destinatria escolhida pelo remetente na transmisso do correio. Transio do correio. Informao relevante para identificar corretamente um correio eletrnico no momento de leitura. Verso do correio. Informao relevante para identificar corretamente um correio eletrnico no momento de leitura.

NumeroCorreio. Pasta

int Pasta

Setor Transicao Versao

string int int

Exemplo do servio ConsultarCorreiosPorPasta Parmetros de entrada


<?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> <ConsultarCorreiosPorPasta xmlns="http://www.bcb.gov.br/correiows"> <consulta> <Pasta> <Unidade> <Nome>DEINF</Nome> <Ativa>true</Ativa> <Tipo>UnidadeBanco</Tipo> </Unidade> <Dependencia/> <Setor> <Nome>Disin</Nome> <Ativo>true</Ativo> </Setor> <Tipo>Setor</Tipo> </Pasta> <Setor>Disin</Setor> <DataInicial>2011-07-02T16:11:10</DataInicial> <DataFinal>2011-07-04T16:31:10</DataFinal> <AssuntoConteudo>Correio</AssuntoConteudo> <Unidade>SECRE</Unidade> <ApenasMensagens>true</ApenasMensagens> <PesquisarEmTodasAsPastas>false</PesquisarEmTodasAsPastas> <Pagina>0</Pagina> </consulta> </ConsultarCorreiosPorPasta>

</soap:Body> </soap:Envelope>

Dados de retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ConsultarCorreiosPorPastaResponse xmlns="http://www.bcb.gov.br/correiows"> <ConsultarCorreiosPorPastaResult> <OcorreuErro>false</OcorreuErro> <QuantidadeCorreios>1</QuantidadeCorreios> <Correios> <ResumoCorreioWSDTO> <Assunto>Homologao do BC Correio</Assunto> <Data>2011-07-04T16:23:18.76</Data> <UnidadeDestinataria>DEINF</UnidadeDestinataria> <UnidadeRemetente>SECRE</UnidadeRemetente> <Status>Destinado Lido</Status> <TipoCorreio>MENSAGEM</TipoCorreio> <NumeroCorreio>111045165</NumeroCorreio> <Pasta> <Tipo>Setor</Tipo> </Pasta> <Setor>DISIN</Setor> <Transicao>111729</Transicao> <Versao>0</Versao> </ResumoCorreioWSDTO> </Correios> </ConsultarCorreiosPorPastaResult> </ConsultarCorreiosPorPastaResponse> </soap:Body> </soap:Envelope>

LerCorreio
O servio LerCorreio fornece ao usurio o contedo dos correios previamente consultados. Esse servio deve ser usado em conjunto com o servio ConsultarCorreiosPorPasta, de modo que os resumos (ou cabealhos) de correios consultados sejam usados como parmetro nesse servio de leitura. Parmetros de entrada e dados de retorno do servio LerCorreio Atributo Parmetros de entrada
Correio ResumoCorreio Elemento que representa o cabealho de um correio eletrnico. Esse elemento retornado pelo servio ConsultarCorreiosPorPasta e deve ser usado como parmetro para leitura de um correio.

Tipo

Significado

Dados de retorno
NumeroCorreio Transicao Versao int int Nmero do correio. Transio do correio. Informao relevante para identificar corretamente um correio eletrnico. Verso do correio. Informao relevante para identificar

corretamente um correio eletrnico. Assunto Ementa Conteudo TipoCorreio string string string Tipo Assunto do correio. Ementa do correio, no caso de ser um normativo. Contedo do correio. Representa o texto principal do correio eletrnico. Tipo do correio, que pode ser um dos valores: MENSAGEM, COMUNICACAO, COMUNICACAOGERAL, INFORMATIVO, COMUNICACAOSOCIAL, LINHADIRETA, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO, COMUNICADOCONJUNTO, DECISAOCONJUNTA, ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO, PORTARIAINTERMINISTERIAL ou INDEFINIDO. Unidade e dependncia remetentes do correio. Unidade e dependncia destinatrias do correio. No caso de correio enviado para grupo, o nome da unidade vir acompanhado do texto (Transmisso para grupo). Usurio remetente do correio. Data de transmisso do correio. Usurio que realizou a primeira leitura do contedo do correio (apenas correios do tipo Mensagem possuem controle de recebimento). Data da primeira leitura do contedo do correio (informao que somente registrada para correios do tipo Mensagem). Um correio pode ter vrios despachos, como so chamadas as operaes subsequentes a transmisso. Cada despacho possui as informaes de envio e recebimento, alm do contedo, que representa o texto escrito pelo usurio no momento de cada operao. Um correio pode ter vrios arquivos anexados. Cada anexo possui informaes referentes ao arquivo, como id e nome. O contedo dos arquivos anexados deve ser recuperado pelo servio ObterAnexo.

De Para

string string

EnviadaPor EnviadaEm RecebidaPor

string dateTime string

RecebidaEm Lista de elementos do tipo Despacho

dateTime

Lista de elementos do tipo Anexo

Exemplo do servio LerCorreio Parmetros de entrada


<?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> <LerCorreio xmlns="http://www.bcb.gov.br/correiows"> <parametros> <Correio> <Assunto>Homologao do BC Correio</Assunto> <Data>2011-07-04T16:23:18.76</Data> <UnidadeDestinataria>DEINF</UnidadeDestinataria> <UnidadeRemetente>SECRE</UnidadeRemetente> <Status>Destinado Lido</Status> <TipoCorreio>MENSAGEM</TipoCorreio> <NumeroCorreio>111045165</NumeroCorreio> <Pasta> <Tipo>Setor</Tipo> </Pasta>

<Setor>DISIN</Setor> <Transicao>111729</Transicao> <Versao>0</Versao> </Correio> </parametros> </LerCorreio> </soap:Body> </soap:Envelope>

Dados de retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <LerCorreioResponse xmlns="http://www.bcb.gov.br/correiows"> <LerCorreioResult> <OcorreuErro>false</OcorreuErro> <DetalheCorreio> <NumeroCorreio>111045165</NumeroCorreio> <Transicao>111729</Transicao> <Versao>0</Versao> <Assunto> Homologao do BC Correio </Assunto> <Conteudo> <![CDATA[<p>O BC Correio, novo sistema de correio eletrnico do Banco Central do Brasil, est em fase de Homologao.</p>]]> </Conteudo> <TipoCorreio>MENSAGEM</TipoCorreio> <De>SECRE</De> <Para>DEINF/DISIN</Para> <EnviadaPor>SECRE.XXXXX</EnviadaPor> <EnviadaEm>2011-07-04T16:23:18</EnviadaEm> <RecebidaPor>DEINF.YYYYY</RecebidaPor> <RecebidaEm>2011-07-04T16:27:43</RecebidaEm> <Despachos> <DespachoWSDTO> <De>DEINF</De> <Para>DEINF/DISIN</Para> <EnviadaPor>DEINF.YYYYY</EnviadaPor> <EnviadaEm>2011-07-04T16:28:48</EnviadaEm> <RecebidaPor>DEINF.ZZZZZ</RecebidaPor> <RecebidaEm>2011-07-04T16:40:25</RecebidaEm> <Conteudo> <p>Mensagem recebida na Caixa de Entrada do Deinf.</p> <p>Destinando mensagem para o setor Disin...</p> </Conteudo> </DespachoWSDTO> </Despachos> <Anexos> <AnexoWSDTO> <IdAnexo>4</IdAnexo> <NomeAnexo>arquivo.txt</NomeAnexo> </AnexoWSDTO> </Anexos> </DetalheCorreio> </LerCorreioResult> </LerCorreioResponse> </soap:Body> </soap:Envelope>

TransmitirCorreio

O servio TransmitirCorreio possibilita ao usurio transmitir correios eletrnicos. Para usar esse servio, necessrio que o usurio tenha permisso de transmisso para o tipo de correio solicitado. Parmetros de entrada e os dados de retorno do servio TransmitirCorreio: Atributo Parmetros de entrada
Destino string Unidade, Unidade/Setor, UnidadeDependncia ou Grupo que receber, em sua caixa de entrada, o correio a ser transmitido. Contedo do correio. Representa o texto principal do correio eletrnico a ser transmitido. Ementa do correio a ser transmitido. Informao necessria apenas se o correio for um normativo. Palavras-chave do correio a ser transmitido. Informao necessria apenas se o correio for um normativo. string Tipo Assunto do correio a ser transmitido. No precisa ser informado no caso de o correio ser um normativo. Tipo do correio a ser transmitido, que pode ser um dos valores: MENSAGEM, COMUNICACAO, COMUNICACAOGERAL, INFORMATIVO, COMUNICACAOSOCIAL, LINHADIRETA, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO, COMUNICADOCONJUNTO, DECISAOCONJUNTA, ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO ou PORTARIAINTERMINISTERIAL. Elemento que, quando configurado como true, indica que o elemento Destino do correio a ser transmitido um grupo. Elemento que representa os arquivos que devero ser anexados ao correio a ser transmitido. Por enquanto, essa funo est habilitada apenas para usurios pertencentes s unidades do Banco Central do Brasil. O contedo do anexo um elemento do tipo Base64Binary.

Tipo

Significado

Conteudo Ementa Lista de elementos do tipo PalavraChave Assunto TipoCorreio

string string

Grupo Lista de elementos do tipo Anexo

boolean

Dados de retorno
NumeroCorreio int Nmero que o correio recebe ao ser transmitido.

Exemplo do servio TransmitirCorreio Parmetros de entrada


<?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> <TransmitirCorreio xmlns="http://www.bcb.gov.br/correiows"> <parametros> <Destino>DEINF</Destino> <Conteudo>Contedo de mensagem transmitida via Web Service do BC Correio.</Conteudo> <PalavrasChave> <string>Transmisso</string> <string>WebService</string> </PalavrasChave> <Assunto>Transmisso de mensagem via Web Service</Assunto>

<TipoCorreio>MENSAGEM</TipoCorreio> <Grupo>false</Grupo> </parametros> </TransmitirCorreio> </soap:Body> </soap:Envelope>

Dados de retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <TransmitirCorreioResponse xmlns="http://www.bcb.gov.br/correiows"> <TransmitirCorreioResult> <OcorreuErro>false</OcorreuErro> <NumeroCorreio>111045166</NumeroCorreio> </TransmitirCorreioResult> </TransmitirCorreioResponse> </soap:Body> </soap:Envelope>

ConsultarComunicacaoGeralDocumentoDivulgacao
O servio ConsultarComunicaoGeralDocumentodeDivulgacao possibilita ao usurio consultar as comunicaes gerais e os documentos de divulgao (tambm chamados de normativos, j que, com exceo do Aviso, do Comunicado e do Comunicado conjunto, todos so atos normativos) do Banco Central do Brasil. Para consulta, pode-se usar filtros por data de transmisso, nmero e tipo do documento ou por expresses presentes no contedo dos correios. O resumo (ou cabealho) dos correios consultados que retornam por esse servio, com paginao de 10 em 10. Deve-se usar corretamente o elemento de retorno QuantidadeComGeralDocDivulgacao e o parmetro Pagina, para se obter em todos os resumos de correio filtrados na consulta. Parmetros de entrada e os dados de retorno de ConsultarComunicacaoGeralDocumentoDivulgacao Atributo Parmetros de entrada
Pagina int Indica a pgina a ser consultada. Levando-se em considerao que o resultado do servio ConsultarComunicacaoGeralDocumentoDivulgacao retornado em pginas com limite de 10 correios, deve-se analisar o valor retornado pelo elemento QuantidadeComGeralDocDivulgacao e usar o elemento Pagina para navegar entre as pginas da consulta. Nmero sequencial do normativo. Parmetro a ser usado como filtro. Tipo do correio, que nesse servio poder ser um dos valores: COMUNICACAOGERAL, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO, COMUNICADOCONJUNTO, DECISAOCONJUNTA,

Tipo

Significado

NumeroDocumento TipoDocumento

string Tipo

ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO ou PORTARIAINTERMINISTERIAL. ExpressaoBusca string Expresso textual a ser usada como filtro para os campos Assunto, Contedo e Palavras-chave, caso o elemento PesquisarPalavrasChave seja configurado como true. Data e hora limite inferior para consulta de correios. Parmetro a ser usado como filtro da data de transmisso do correio. Data e hora limite superior para consulta de correios. Parmetro a ser usado como filtro da data de transmisso do correio. Indica se o elemento ExpressaoBusca ser utilizado para encontrar a expresso nas palavras-chave dos correios.

DataInicial

dateTime

DataFinal

dateTime

PesquisarPalavrasChave

boolean

Dados de retorno
QuantidadeComGeralDocDivulgacao Quantidade de correios filtrados pela consulta. Se, por exemplo, esse elemento indicar a quantidade de 25 correios filtrados, deve-se usar o elemento Pagina de 0 a 2 para se obter todos os correios filtrados pela consulta.

Lista de elementos do tipo ComunicacaoGeralDocumentoDivulgacao. Cada elemento contm: NumeroCorreio SequencialNormativo TipoDocumento int int Tipo Nmero do correio. Nmero sequencial do normativo, caso o correio retornado seja um normativo. Tipo do correio, que nesse servio poder ser um dos valores: COMUNICACAOGERAL, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO, COMUNICADOCONJUNTO, DECISAOCONJUNTA, ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO, PORTARIAINTERMINISTERIAL ou INDEFINIDO. Data e hora de transmisso do correio. Unidade responsvel pela transmisso do correio. Assunto do correio. Ementa do correio. Indica se o correio comunicao geral (valor true) ou documento de divulgao (valor false).

DataHora Responsavel Assunto Ementa EComunicacaoGeral

dateTime string string string boolean

Exemplo do servio ConsultarComunicacaoGeralDocumentoDivulgacao Parmetros de entrada


<?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> <ConsultarComunicacaoGeralDocumentoDivulgacao xmlns="http://www.bcb.gov.br/correiows"> <parametros> <Pagina>0</Pagina> <ExpressaoBusca></ExpressaoBusca> <DataInicial>2011-06-29T18:00:07</DataInicial> <DataFinal>2011-06-30T08:20:07</DataFinal> <TipoDocumento>RESOLUCAO</TipoDocumento> <PesquisarPalavrasChave>false</PesquisarPalavrasChave> </parametros> </ConsultarComunicacaoGeralDocumentoDivulgacao>

</soap:Body> </soap:Envelope>

Dados de retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ConsultarComunicacaoGeralDocumentoDivulgacaoResponse xmlns="http://www.bcb.gov.br/correiows"> <ConsultarComunicacaoGeralDocumentoDivulgacaoResult> <OcorreuErro>false</OcorreuErro> <ComGeraisDocDivulgacao> <ComunicacaoGeralDocumentoDivulgacao> <NumeroCorreio>111044905</NumeroCorreio> <Versao>0</Versao> <SequencialNormativo>3983</SequencialNormativo> <TipoDocumento>RESOLUCAO</TipoDocumento> <DataHora>2011-06-29T20:00:00</DataHora> <Assunto>RESOLUCAO N. 003983</Assunto> <Ementa>Define a Taxa de Juros de Longo Prazo (TJLP) para o terceiro trimestre de 2011.</Ementa> <EComunicacaoGeral>false</EComunicacaoGeral> </ComunicacaoGeralDocumentoDivulgacao> </ComGeraisDocDivulgacao> <QuantidadeComGeralDocDivulgacao>1</QuantidadeComGeralDocDivulgacao> </ConsultarComunicacaoGeralDocumentoDivulgacaoResult> </ConsultarComunicacaoGeralDocumentoDivulgacaoResponse> </soap:Body> </soap:Envelope>

LerComunicacaoGeralDocumentoDivulgacao
O servio LerComunicacaoGeraDocumentoDivulgacao oferece ao usurio o contedo das comunicaes gerais e dos documentos de divulgao (tambm chamados de normativos) previamente consultados. Deve ser usado em conjunto com ConsultarComunicacaoGeralDocumentoDivulgacao, de modo que o nmero dos correios consultado seja usado como parmetro nesse servio de leitura. Parmetros de entrada e dados de retorno de LerComunicacaoGeralDocumentoDivulgacao: Atributo Parmetros de entrada
NumeroCorreio AssuntoCorreio int string Nmero do correio. Parmetro a ser usado como filtro. Opcionalmente, pode-se utilizar o assunto do correio como filtro para essa consulta. No caso de os dois elementos serem informados, apenas o NumeroCorreio ser usado.

Tipo

Significado

Dados de retorno
NumeroCorreio SequencialNormativo TipoDocumento int int Tipo Nmero do correio. Nmero sequencial do normativo, caso o correio retornado seja um normativo. Tipo do correio, que nesse servio poder ser um dos valores: COMUNICACAOGERAL, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO,

COMUNICADOCONJUNTO, DECISAOCONJUNTA, ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO, PORTARIAINTERMINISTERIAL ou INDEFINIDO. DataHora Remetente Responsavel Assunto Conteudo Ementa EComunicacaoGeral Documento dateTime string string string string string boolean string Data e hora de transmisso do correio. Unidade remetente do correio. Unidade responsvel pelo correio. A unidade responsvel, na maior parte das vezes, prpria unidade remetente. Assunto do correio. Contedo do correio. Representa o texto principal do correio eletrnico. Ementa do correio, no caso de ser um normativo. Indica se o correio uma comunicao geral (valor true) ou um documento de divulgao (valor false). Esse elemento apresenta as mesmas informaes do elemento Assunto com formatao diferente.

Exemplo do servio LerComunicacaoGeralDocumentoDivulgacao Parmetros de entrada


<?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> <LerComunicacaoGeralDocumentoDivulgacao xmlns="http://www.bcb.gov.br/correiows"> <Parametros> <NumeroCorreio>111044905</NumeroCorreio> </Parametros> </LerComunicacaoGeralDocumentoDivulgacao> </soap:Body> </soap:Envelope>

Dados de retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <LerComunicacaoGeralDocumentoDivulgacaoResponse xmlns="http://www.bcb.gov.br/correiows"> <LerComunicacaoGeralDocumentoDivulgacaoResult> <OcorreuErro>false</OcorreuErro> <DadosComunicacaoGeralDocumentoDivulgacao> <NumeroCorreio>111044905</NumeroCorreio> <SequencialNormativo>3983</SequencialNormativo> <TipoDocumento>RESOLUCAO</TipoDocumento> <DataHora>2011-06-29T20:00:14.1</DataHora> <Remetente>SECRE</Remetente> <Responsavel>SECRE</Responsavel> <Assunto>RESOLUCAO N. 003983</Assunto> <Conteudo> RESOLUCAO N. 003983 ------------------Define a Taxa de Juros de Longo Prazo (TJLP) para o terceiro trimestre de 2011.

O Banco Central do Brasil, na forma do art. 9 da Lei n 4.595, de 31 de dezembro de 1964, torna pblico que o Conselho Monetrio Nacional, em sesso extraordinria realizada em 29 de junho de 2011, com base nas disposies da Lei n 9.365, de 16 de dezembro de 1996, com as alteraes introduzidas pela Lei n 10.183, de 12 de fevereiro de 2001, RESOLVE: Art. 1 fixada em 6% a.a. (seis por cento ao ano) a Taxa de Juros de Longo Prazo (TJLP) a vigorar no perodo de 1 de julho a 30 de setembro de 2011, inclusive. Art. 2 Esta Resoluo entra em vigor na data de sua publicao. Art. 3 Fica revogada, a partir de 1 julho de 2011, a Resoluo n 3.957, de 30 de maro de 2011. Braslia, 29 de junho de 2011. Alexandre Antonio Tombini Presidente do Banco Central </Conteudo> <Ementa>Define a Taxa de Juros de Longo Prazo (TJLP) para o terceiro trimestre de 2011.</Ementa> <EComunicacaoGeral>false</EComunicacaoGeral> <Documento>Resoluo N 3.983</Documento> <Anexos/> </DadosComunicacaoGeralDocumentoDivulgacao> </LerComunicacaoGeralDocumentoDivulgacaoResult> </LerComunicacaoGeralDocumentoDivulgacaoResponse> </soap:Body> </soap:Envelope>

ObterAnexo
O servio ObterAnexo oferece ao usurio o contedo dos arquivos anexos aos correios eletrnicos para os quais tem permisso de leitura. Deve ser usado em conjunto com LerCorreio e LerComunicacaoGeralDocumentoDivulgacao, de modo que as informaes retornadas por esses servios devem ser usadas como parmetros na obteno dos anexos. Parmetros de entrada e os dados de retorno do servio ObterAnexo Atributo Parmetros de entrada
NumeroCorreio Transicao int int Nmero do correio. Parmetro a ser usado como filtro. Transio do correio. Informao relevante para identificar corretamente um correio eletrnico. No necessrio fornecer essa informao para obteno de anexos de comunicaes gerais e normativos. Versao int Verso do correio. Informao relevante para identificar corretamente um correio eletrnico. No necessrio fornecer essa informao para obteno de anexos de comunicaes gerais e normativos.

Tipo

Significado

Pasta

Pasta

Informao da pasta em que o correio eletrnico se encontra. Pode-se usar o elemento Pasta informado como parmetro na leitura do correio. No necessrio passar essa informao para obteno de anexos de comunicaes gerais e normativos.

Anexo

Anexo

Informao sobre o nome do arquivo que se deseja obter.

Dados de retorno
Anexo Anexo Informaes do arquivo obtido, que abrange id, nome e contedo do arquivo em Base64Binary.

Exemplo do servio ObterAnexo Parmetros de entrada


<?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> <ObterAnexo xmlns="http://www.bcb.gov.br/correiows"> <parametros> <NumeroCorreio>111045165</NumeroCorreio> <Versao>0</Versao> <Transicao>111729</Transicao> <Pasta> <Tipo>Setor</Tipo> </Pasta> <Anexo> <IdAnexo>4</IdAnexo> <NomeAnexo>arquivo.txt</NomeAnexo> </Anexo> </parametros> </ObterAnexo> </soap:Body> </soap:Envelope>

Dados de retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ObterAnexoResponse xmlns="http://www.bcb.gov.br/correiows"> <ObterAnexoResult> <OcorreuErro>false</OcorreuErro> <Anexo> <IdAnexo>4</IdAnexo> <NomeAnexo>arquivo.txt</NomeAnexo> <Conteudo>...</Conteudo> </Anexo> </ObterAnexoResult> </ObterAnexoResponse> </soap:Body> </soap:Envelope>