BC CORREIO SISTEMA DE CORREIO ELETRÔNICO DO BANCO CENTRAL DO BRASIL. Manual do Web Service

Transcrição

1 BC CORREIO SISTEMA DE CORREIO ELETRÔNICO DO BANCO CENTRAL DO BRASIL Manual do Web Service

2 SUMÁRIO Introdução... 3 Informações técnicas... 4 Serviços... 5 ConsultarPastasAutorizadas... 5 ConsultarCorreiosPorPasta... 6 LerCorreio... 9 TransmitirCorreio ConsultarComunicacaoGeralDocumentoDivulgacao LerComunicacaoGeralDocumentoDivulgacao ObterAnexo... 17

3 Introdução Web Service é uma solução para integrar aplicações. Por meio dele, qualquer sistema, escrito em qualquer linguagem, pode conectar-se para consulta ou inserção de dados. É um padrão de interconexão entre sistemas heterogêneos, que usa a web e a XML como linguagem para troca de informações (dados e metadados). Assim, instituições financeiras que disponham de sistemas próprios para consulta de mensagens e normativos ou transmissão de correios eletrônicos podem ser beneficiadas pela integração desses sistemas com o BC Correio, usando Web Service. Entretanto, o uso do Web Service é facultado às instituições financeiras, não é compulsório. Todas as funcionalidades disponibilizadas via Web Service também podem ser acessadas através da aplicação com o uso do navegador. Esse serviço é apenas mais um canal oferecido para interação com o BC Correio. As seguintes operações estão disponíveis no Web Service do BC Correio: 1. ConsultarPastasAutorizadas Retorna as pastas de correio eletrônico e os setores que o usuário tem permissão de acessar; 2. ConsultarCorreiosPorPasta Retorna uma lista com os cabeçalhos dos correios eletrônicos contidos em uma pasta; 3. LerCorreio Retorna o conteúdo de um correio eletrônico; 4. TransmitirCorreio Transmite correio eletrônico submetido pelo usuário. Para ter sucesso na transmissão de correio eletrônico, o usuário deve ter permissão para transmissão do tipo de correio solicitado; 5. ConsultarComunicacaoGeralDocumentoDivulgacao Retorna uma lista com os cabeçalhos das comunicações gerais e dos documentos de divulgação transmitidos pelo BC Correio; 6. LerComunicacaoGeralDocumentoDivulgacao Retorna o conteúdo de uma comunicação geral ou de um documento de divulgação; 7. ObterAnexo Retorna o conteúdo do anexo de um correio eletrônico. Assim como ocorre na interface web, o acesso ao Web Service do BC Correio exige autenticação, com usuário e senha. O usuário deve fornecer seus dados no formato:

4 UUUUUDDDD.OOOOO, onde UUUUU é a unidade, DDDD é a dependência (se houver) e OOOOO é o código do operador. É necessário que o usuário esteja associado a um perfil com permissão de acesso ao serviço solicitado. Assim, um usuário que tenha permissão para transmitir mensagens no BC Correio, terá permissão para fazê-lo por meio do Web Service. Para saber mais sobre autenticação, consulte o item Acesso Autenticação no Manual do BC Correio. Sobre perfis de acesso consulte Acesso Perfis e transações também nesse manual. Informações técnicas O Web Service do BC Correio pode ser acessado em: Produção: < Homologação: < Após autenticação, a tela seguinte será apresentada. Ela exibe todas as operações (ou serviços) disponíveis no Web Service do BC Correio. Ao clicar no nome dos serviços, pode-se ver exemplos de requisição e resposta elaboradas em um protocolo de troca de informações estruturadas (SOAP). A descrição formal dos serviços (WSDL) pode ser acessada pela opção Service Description ou diretamente em:

5 Produção: < Homologação: < Serviços Ao tentar acessar os serviços disponíveis, é possível 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 informação sobre o motivo do erro encontrado. Exemplo de resposta com mensagem de erro <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <ConsultarCorreiosPorPastaResponse xmlns=" <ConsultarCorreiosPorPastaResult> <MensagemErro>Campo Unidade remetente inválido.</mensagemerro> <OcorreuErro>true</OcorreuErro> <QuantidadeCorreios>0</QuantidadeCorreios> <Correios/> </ConsultarCorreiosPorPastaResult> </ConsultarCorreiosPorPastaResponse> ConsultarPastasAutorizadas O serviço ConsultarPastasAutorizadas informa ao usuário 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 parâmetro no serviço de consulta de correios. e dados de retorno do serviço ConsultarPastasAutorizadas Atributo Tipo Significado Não é necessário nenhum parâmetro de entrada para consultar as pastas autorizadas ao usuário. QuantidadePastasAutorizadas int Quantidade de pastas retornadas na consulta. Lista de elementos do tipo PastaAutorizada. Cada pasta contém: 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. Dependencia string Dependência da pasta. Tipo string Tipo da pasta, que pode ser: CaixaEntrada, Destinados, Arquivados, Reservados, Transmitidos, Cancelados ou Setor Setor Setor Setor da pasta. Esse elemento só é apresentado quando a

6 pasta é do tipo Setor. É composto por informações de nome do setor e indica se o setor está ativo. Exemplo do serviço ConsultarPastasAutorizadas <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <ConsultarPastasAutorizadas xmlns=" /> <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <ConsultarPastasAutorizadasResponse xmlns=" <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> ConsultarCorreiosPorPasta O serviço ConsultarCorreiosPorPasta informa ao usuário os correios das pastas às quais tem acesso. Para consulta, o usuário pode usar filtros por data de transmissão, numeração ou assunto e conteúdo dos correios.

7 Os resumos (ou cabeçalhos) dos correios consultados são retornados por esse serviço, com paginação de 10 em 10. Deve-se usar corretamente o elemento de retorno QuantidadeCorreios e o parâmetro Pagina, para se obterem todos os resumos de correio filtrados na consulta. Para ler o conteúdo de um correio eletrônico, esse serviço deve ser usado em conjunto com LerCorreio, de modo que os resumos (ou cabeçalhos) de correios retornados pelo serviço de consulta sejam usados como parâmetro no serviço de leitura. e dados de retorno do serviço ConsultarCorreiosPorPasta Atributo Tipo Significado Pasta PastaAutorizada Pasta na qual se deseja consultar os correios. Esse elemento pode ser obtido no retorno do serviço ConsultarPastasAutorizadas. Setor string Setor destinatário do correio. Parâmetro a ser usado como filtro. DataInicial datetime Data e hora limite inferior para consulta de correios. Parâmetro a ser usado como filtro. DataFinal datetime Data e hora limite superior para consulta de correios. Parâmetro a ser usado como filtro. NumeroCorreio string Número do correio. Parâmetro a ser usado como filtro. AssuntoConteudo string Expressão que deve estar contida no assunto ou no conteúdo do correio. Parâmetro a ser usado como filtro. Unidade string Unidade do correio. Parâmetro a ser usado como filtro. Dependendo da pasta a ser consultada, esse campo funciona como filtro para a unidade remetente ou para a unidade destinatária do correio. ApenasMensagens boolean Indica se apenas mensagens devem ser retornadas na consulta. Parâmetro a ser usado como filtro. PesquisarEmTodasAsPastas boolean Indica se a consulta deve ser realizada em todas as pastas autorizadas para o usuário. 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. Pagina int Indica a página a ser consultada. Levando-se em consideração que o resultado do serviço ConsultarCorreiosPorPasta é retornado em páginas com limite de 10 correios, deve-se analisar o valor retornado pelo elemento QuantidadeCorreios e usar o elemento Pagina para navegar entre as páginas da consulta. 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 contém: Assunto string Assunto do correio. Data datetime Data de transmissão do correio. UnidadeDestinataria string Unidade à qual o correio foi destinado. DependenciaDestinataria string Dependência à qual o correio foi destinado. Caso o correio não tenha sido destinado a uma dependência, esse campo não será retornado.

8 UnidadeRemetente string Unidade do usuário que transmitiu o correio. DependenciaRemetente string Dependência do usuário que transmitiu o correio. Grupo string Nome do grupo ao qual o correio foi destinado. Status string Status do correio. TipoCorreio Tipo 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. NumeroCorreio. int Número do correio. Pasta Pasta Pasta na qual o correio está armazenado. Esse elemento é útil especialmente quando o parâmetro PesquisarEmTodasAsPastas for utilizado como true. Setor string Setor da unidade destinatária escolhida pelo remetente na transmissão do correio. Transicao int Transição do correio. Informação relevante para identificar corretamente um correio eletrônico no momento de leitura. Versao int Versão do correio. Informação relevante para identificar corretamente um correio eletrônico no momento de leitura. Exemplo do serviço ConsultarCorreiosPorPasta <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <ConsultarCorreiosPorPasta xmlns=" <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> T16:11:10</DataInicial> <DataFinal> T16:31:10</DataFinal> <AssuntoConteudo>Correio</AssuntoConteudo> <Unidade>SECRE</Unidade> <ApenasMensagens>true</ApenasMensagens> <PesquisarEmTodasAsPastas>false</PesquisarEmTodasAsPastas> <Pagina>0</Pagina> </consulta> </ConsultarCorreiosPorPasta>

9 <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <ConsultarCorreiosPorPastaResponse xmlns=" <ConsultarCorreiosPorPastaResult> <OcorreuErro>false</OcorreuErro> <QuantidadeCorreios>1</QuantidadeCorreios> <Correios> <ResumoCorreioWSDTO> <Assunto>Homologação do BC Correio</Assunto> <Data> T16:23:18.76</Data> <UnidadeDestinataria>DEINF</UnidadeDestinataria> <UnidadeRemetente>SECRE</UnidadeRemetente> <Status>Destinado Lido</Status> <TipoCorreio>MENSAGEM</TipoCorreio> <NumeroCorreio> </NumeroCorreio> <Pasta> <Tipo>Setor</Tipo> </Pasta> <Setor>DISIN</Setor> <Transicao>111729</Transicao> <Versao>0</Versao> </ResumoCorreioWSDTO> </Correios> </ConsultarCorreiosPorPastaResult> </ConsultarCorreiosPorPastaResponse> LerCorreio O serviço LerCorreio fornece ao usuário o conteúdo dos correios previamente consultados. Esse serviço deve ser usado em conjunto com o serviço ConsultarCorreiosPorPasta, de modo que os resumos (ou cabeçalhos) de correios consultados sejam usados como parâmetro nesse serviço de leitura. e dados de retorno do serviço LerCorreio Atributo Tipo Significado Correio ResumoCorreio Elemento que representa o cabeçalho de um correio eletrônico. Esse elemento é retornado pelo serviço ConsultarCorreiosPorPasta e deve ser usado como parâmetro para leitura de um correio. NumeroCorreio int Número do correio. Transicao Transição do correio. Informação relevante para identificar corretamente um correio eletrônico. Versao int Versão do correio. Informação relevante para identificar

10 corretamente um correio eletrônico. Assunto string Assunto do correio. Ementa string Ementa do correio, no caso de ser um normativo. Conteudo string Conteúdo do correio. Representa o texto principal do correio eletrônico. TipoCorreio Tipo 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. De string Unidade e dependência remetentes do correio. Para string Unidade e dependência destinatárias do correio. No caso de correio enviado para grupo, o nome da unidade virá acompanhado do texto (Transmissão para grupo). EnviadaPor string Usuário remetente do correio. EnviadaEm datetime Data de transmissão do correio. RecebidaPor string Usuário que realizou a primeira leitura do conteúdo do correio (apenas correios do tipo Mensagem possuem controle de recebimento). RecebidaEm datetime Data da primeira leitura do conteúdo do correio (informação que somente é registrada para correios do tipo Mensagem). Lista de elementos do tipo Despacho Lista de elementos do tipo Anexo Um correio pode ter vários despachos, como são chamadas as operações subsequentes a transmissão. Cada despacho possui as informações de envio e recebimento, além do conteúdo, que representa o texto escrito pelo usuário no momento de cada operação. Um correio pode ter vários arquivos anexados. Cada anexo possui informações referentes ao arquivo, como id e nome. O conteúdo dos arquivos anexados deve ser recuperado pelo serviço ObterAnexo. Exemplo do serviço LerCorreio <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <LerCorreio xmlns=" <parametros> <Correio> <Assunto>Homologação do BC Correio</Assunto> <Data> T16:23:18.76</Data> <UnidadeDestinataria>DEINF</UnidadeDestinataria> <UnidadeRemetente>SECRE</UnidadeRemetente> <Status>Destinado Lido</Status> <TipoCorreio>MENSAGEM</TipoCorreio> <NumeroCorreio> </NumeroCorreio> <Pasta> <Tipo>Setor</Tipo> </Pasta>

11 <Setor>DISIN</Setor> <Transicao>111729</Transicao> <Versao>0</Versao> </Correio> </parametros> </LerCorreio> <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <LerCorreioResponse xmlns=" <LerCorreioResult> <OcorreuErro>false</OcorreuErro> <DetalheCorreio> <NumeroCorreio> </NumeroCorreio> <Transicao>111729</Transicao> <Versao>0</Versao> <Assunto> Homologação do BC Correio </Assunto> <Conteudo> <![CDATA[<p>O BC Correio, novo sistema de correio eletrônico do Banco Central do Brasil, está em fase de Homologação.</p>]]> </Conteudo> <TipoCorreio>MENSAGEM</TipoCorreio> <De>SECRE</De> <Para>DEINF/DISIN</Para> <EnviadaPor>SECRE.XXXXX</EnviadaPor> <EnviadaEm> T16:23:18</EnviadaEm> <RecebidaPor>DEINF.YYYYY</RecebidaPor> <RecebidaEm> T16:27:43</RecebidaEm> <Despachos> <DespachoWSDTO> <De>DEINF</De> <Para>DEINF/DISIN</Para> <EnviadaPor>DEINF.YYYYY</EnviadaPor> <EnviadaEm> T16:28:48</EnviadaEm> <RecebidaPor>DEINF.ZZZZZ</RecebidaPor> <RecebidaEm> T16: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> TransmitirCorreio

12 O serviço TransmitirCorreio possibilita ao usuário transmitir correios eletrônicos. Para usar esse serviço, é necessário que o usuário tenha permissão de transmissão para o tipo de correio solicitado. e os dados de retorno do serviço TransmitirCorreio : Atributo Tipo Significado Destino string Unidade, Unidade/Setor, UnidadeDependência ou Grupo que receberá, em sua caixa de entrada, o correio a ser transmitido. Conteudo string Conteúdo do correio. Representa o texto principal do correio eletrônico a ser transmitido. Ementa string Ementa do correio a ser transmitido. Informação necessária apenas se o correio for um normativo. Lista de elementos do tipo PalavraChave Palavras-chave do correio a ser transmitido. Informação necessária apenas se o correio for um normativo. Assunto string Assunto do correio a ser transmitido. Não precisa ser informado no caso de o correio ser um normativo. TipoCorreio Tipo 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. Grupo boolean Elemento que, quando configurado como true, indica que o elemento Destino do correio a ser transmitido é um grupo. Lista de elementos do tipo Anexo Elemento que representa os arquivos que deverão ser anexados ao correio a ser transmitido. Por enquanto, essa função está habilitada apenas para usuários pertencentes às unidades do Banco Central do Brasil. O conteúdo do anexo é um elemento do tipo Base64Binary. NumeroCorreio int Número que o correio recebe ao ser transmitido. Exemplo do serviço TransmitirCorreio <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <TransmitirCorreio xmlns=" <parametros> <Destino>DEINF</Destino> <Conteudo>Conteúdo de mensagem transmitida via Web Service do BC Correio.</Conteudo> <PalavrasChave> <string>transmissão</string> <string>webservice</string> </PalavrasChave> <Assunto>Transmissão de mensagem via Web Service</Assunto>

13 <TipoCorreio>MENSAGEM</TipoCorreio> <Grupo>false</Grupo> </parametros> </TransmitirCorreio> <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <TransmitirCorreioResponse xmlns=" <TransmitirCorreioResult> <OcorreuErro>false</OcorreuErro> <NumeroCorreio> </NumeroCorreio> </TransmitirCorreioResult> </TransmitirCorreioResponse> ConsultarComunicacaoGeralDocumentoDivulgacao O serviço ConsultarComunicaçãoGeralDocumentodeDivulgacao possibilita ao usuário consultar as comunicações gerais e os documentos de divulgação (também chamados de normativos, já que, com exceção do Aviso, do Comunicado e do Comunicado conjunto, todos são atos normativos) do Banco Central do Brasil. Para consulta, pode-se usar filtros por data de transmissão, número e tipo do documento ou por expressões presentes no conteúdo dos correios. O resumo (ou cabeçalho) dos correios consultados é que retornam por esse serviço, com paginação de 10 em 10. Deve-se usar corretamente o elemento de retorno QuantidadeComGeralDocDivulgacao e o parâmetro Pagina, para se obterem todos os resumos de correio filtrados na consulta. e os dados de retorno de ConsultarComunicacaoGeralDocumentoDivulgacao Atributo Tipo Significado Pagina int Indica a página a ser consultada. Levando-se em consideração que o resultado do serviço ConsultarComunicacaoGeralDocumentoDivulgacao é retornado em páginas com limite de 10 correios, deve-se analisar o valor retornado pelo elemento QuantidadeComGeralDocDivulgacao e usar o elemento Pagina para navegar entre as páginas da consulta. NumeroDocumento string Número sequencial do normativo. Parâmetro a ser usado como filtro. TipoDocumento Tipo Tipo do correio, que nesse serviço poderá ser um dos valores: COMUNICACAOGERAL, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO, COMUNICADOCONJUNTO, DECISAOCONJUNTA,

14 ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO ou PORTARIAINTERMINISTERIAL. ExpressaoBusca string Expressão textual a ser usada como filtro para os campos Assunto, Conteúdo e Palavras-chave, caso o elemento PesquisarPalavrasChave seja configurado como true. DataInicial datetime Data e hora limite inferior para consulta de correios. Parâmetro a ser usado como filtro da data de transmissão do correio. DataFinal datetime Data e hora limite superior para consulta de correios. Parâmetro a ser usado como filtro da data de transmissão do correio. PesquisarPalavrasChave boolean Indica se o elemento ExpressaoBusca será utilizado para encontrar a expressão nas palavras-chave dos correios. 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 contém: NumeroCorreio int Número do correio. SequencialNormativo int Número sequencial do normativo, caso o correio retornado seja um normativo. TipoDocumento Tipo Tipo do correio, que nesse serviço poderá ser um dos valores: COMUNICACAOGERAL, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO, COMUNICADOCONJUNTO, DECISAOCONJUNTA, ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO, PORTARIAINTERMINISTERIAL ou INDEFINIDO. DataHora datetime Data e hora de transmissão do correio. Responsavel string Unidade responsável pela transmissão do correio. Assunto string Assunto do correio. Ementa string Ementa do correio. EComunicacaoGeral boolean Indica se o correio é comunicação geral (valor true ) ou documento de divulgação (valor false ). Exemplo do serviço ConsultarComunicacaoGeralDocumentoDivulgacao <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <ConsultarComunicacaoGeralDocumentoDivulgacao xmlns=" <parametros> <Pagina>0</Pagina> <ExpressaoBusca></ExpressaoBusca> <DataInicial> T18:00:07</DataInicial> <DataFinal> T08:20:07</DataFinal> <TipoDocumento>RESOLUCAO</TipoDocumento> <PesquisarPalavrasChave>false</PesquisarPalavrasChave> </parametros> </ConsultarComunicacaoGeralDocumentoDivulgacao>

15 <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <ConsultarComunicacaoGeralDocumentoDivulgacaoResponse xmlns=" <ConsultarComunicacaoGeralDocumentoDivulgacaoResult> <OcorreuErro>false</OcorreuErro> <ComGeraisDocDivulgacao> <ComunicacaoGeralDocumentoDivulgacao> <NumeroCorreio> </NumeroCorreio> <Versao>0</Versao> <SequencialNormativo>3983</SequencialNormativo> <TipoDocumento>RESOLUCAO</TipoDocumento> <DataHora> T20:00:00</DataHora> <Assunto>RESOLUCAO N </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> LerComunicacaoGeralDocumentoDivulgacao O serviço LerComunicacaoGeraDocumentoDivulgacao oferece ao usuário o conteúdo das comunicações gerais e dos documentos de divulgação (também chamados de normativos) previamente consultados. Deve ser usado em conjunto com ConsultarComunicacaoGeralDocumentoDivulgacao, de modo que o número dos correios consultado seja usado como parâmetro nesse serviço de leitura. e dados de retorno de LerComunicacaoGeralDocumentoDivulgacao : Atributo Tipo Significado NumeroCorreio int Número do correio. Parâmetro a ser usado como filtro. AssuntoCorreio string 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. NumeroCorreio int Número do correio. SequencialNormativo int Número sequencial do normativo, caso o correio retornado seja um normativo. TipoDocumento Tipo Tipo do correio, que nesse serviço poderá ser um dos valores: COMUNICACAOGERAL, ATODEDIRETOR, ATONORMATIVOCONJUNTO, ATOPRESI, AVISO, CARTACIRCULAR, CIRCULAR, COMUNICADO,

16 COMUNICADOCONJUNTO, DECISAOCONJUNTA, ORDEMDESERVICO, PORTARIA, PORTARIACONJUNTA, RESOLUCAO, PORTARIAINTERMINISTERIAL ou INDEFINIDO. DataHora datetime Data e hora de transmissão do correio. Remetente string Unidade remetente do correio. Responsavel string Unidade responsável pelo correio. A unidade responsável, na maior parte das vezes, é própria unidade remetente. Assunto string Assunto do correio. Conteudo string Conteúdo do correio. Representa o texto principal do correio eletrônico. Ementa string Ementa do correio, no caso de ser um normativo. EComunicacaoGeral boolean Indica se o correio é uma comunicação geral (valor true ) ou um documento de divulgação (valor false ). Documento string Esse elemento apresenta as mesmas informações do elemento Assunto com formatação diferente. Exemplo do serviço LerComunicacaoGeralDocumentoDivulgacao <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <LerComunicacaoGeralDocumentoDivulgacao xmlns=" <Parametros> <NumeroCorreio> </NumeroCorreio> </Parametros> </LerComunicacaoGeralDocumentoDivulgacao> <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <LerComunicacaoGeralDocumentoDivulgacaoResponse xmlns=" <LerComunicacaoGeralDocumentoDivulgacaoResult> <OcorreuErro>false</OcorreuErro> <DadosComunicacaoGeralDocumentoDivulgacao> <NumeroCorreio> </NumeroCorreio> <SequencialNormativo>3983</SequencialNormativo> <TipoDocumento>RESOLUCAO</TipoDocumento> <DataHora> T20:00:14.1</DataHora> <Remetente>SECRE</Remetente> <Responsavel>SECRE</Responsavel> <Assunto>RESOLUCAO N </Assunto> <Conteudo> RESOLUCAO N Define a Taxa de Juros de Longo Prazo (TJLP) para o terceiro trimestre de 2011.

17 O Banco Central do Brasil, na forma do art. 9º da Lei nº 4.595, de 31 de dezembro de 1964, torna público que o Conselho Monetário Nacional, em sessão extraordinária realizada em 29 de junho de 2011, com base nas disposições da Lei nº 9.365, de 16 de dezembro de 1996, com as alterações introduzidas pela Lei nº , de 12 de fevereiro de 2001, R E S O L V E : Art. 1º É fixada em 6% a.a. (seis por cento ao ano) a Taxa de Juros de Longo Prazo (TJLP) a vigorar no período de 1º de julho a 30 de setembro de 2011, inclusive. Art. 2º Esta Resolução entra em vigor na data de sua publicação. Art. 3º Fica revogada, a partir de 1º julho de 2011, a Resolução nº 3.957, de 30 de março de Brasília, 29 de junho de 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>Resolução Nº 3.983</Documento> <Anexos/> </DadosComunicacaoGeralDocumentoDivulgacao> </LerComunicacaoGeralDocumentoDivulgacaoResult> </LerComunicacaoGeralDocumentoDivulgacaoResponse> ObterAnexo O serviço ObterAnexo oferece ao usuário o conteúdo dos arquivos anexos aos correios eletrônicos para os quais tem permissão de leitura. Deve ser usado em conjunto com LerCorreio e LerComunicacaoGeralDocumentoDivulgacao, de modo que as informações retornadas por esses serviços devem ser usadas como parâmetros na obtenção dos anexos. e os dados de retorno do serviço ObterAnexo Atributo Tipo Significado NumeroCorreio int Número do correio. Parâmetro a ser usado como filtro. Transicao int Transição do correio. Informação relevante para identificar corretamente um correio eletrônico. Não é necessário fornecer essa informação para obtenção de anexos de comunicações gerais e normativos. Versao int Versão do correio. Informação relevante para identificar corretamente um correio eletrônico. Não é necessário fornecer essa informação para obtenção de anexos de comunicações gerais e normativos.

18 Pasta Pasta Informação da pasta em que o correio eletrônico se encontra. Pode-se usar o elemento Pasta informado como parâmetro na leitura do correio. Não é necessário passar essa informação para obtenção de anexos de comunicações gerais e normativos. Anexo Anexo Informação sobre o nome do arquivo que se deseja obter. Anexo Anexo Informações do arquivo obtido, que abrange id, nome e conteúdo do arquivo em Base64Binary. Exemplo do serviço ObterAnexo <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <ObterAnexo xmlns=" <parametros> <NumeroCorreio> </NumeroCorreio> <Versao>0</Versao> <Transicao>111729</Transicao> <Pasta> <Tipo>Setor</Tipo> </Pasta> <Anexo> <IdAnexo>4</IdAnexo> <NomeAnexo>arquivo.txt</NomeAnexo> </Anexo> </parametros> </ObterAnexo> <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <ObterAnexoResponse xmlns=" <ObterAnexoResult> <OcorreuErro>false</OcorreuErro> <Anexo> <IdAnexo>4</IdAnexo> <NomeAnexo>arquivo.txt</NomeAnexo> <Conteudo>...</Conteudo> </Anexo> </ObterAnexoResult> </ObterAnexoResponse>