BC CORREIO SISTEMA DE CORREIO ELETRÔNICO DO BANCO … · Correio ResumoCorreio Elemento que...

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 ................................................................... 5

Serviços ........................................................................................ 6

ConsultarPastasAutorizadas ........................................................................................................... 6

ConsultarCorreiosPorPasta ............................................................................................................. 8

LerCorreio ..................................................................................................................................... 12

TransmitirCorreio ........................................................................................................................... 15

ConsultarComunicacaoGeralDocumentoDivulgacao .................................................................... 16

LerComunicacaoGeralDocumentoDivulgacao ............................................................................... 19

ObterAnexo ................................................................................................................................... 22

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.

4

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:

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.

5

Informações técnicas

O Web Service do BC Correio pode ser acessado em:

Produção:<https://bccorreio.bcb.gov.br/bccorreiows/CorreioWS.asmx>

Homologação: <https://www9.bcb.gov.br/bccorreiows/CorreioWS.asmx>

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:

Produção: <https://bccorreio.bcb.gov.br/bccorreiows/CorreioWS.asmx?WSDL>

Homologação: <https://www9.bcb.gov.br/bccorreiows/CorreioWS.asmx?WSDL>

6

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:

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 inválido.</MensagemErro>

<OcorreuErro>true</OcorreuErro>

<QuantidadeCorreios>0</QuantidadeCorreios>

<Correios/>

</ConsultarCorreiosPorPastaResult>

</ConsultarCorreiosPorPastaResponse>

</soap:Body>

</soap:Envelope>

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.

Parâmetros de entrada e dados de retorno do serviço “ConsultarPastasAutorizadas”:

Atributo Tipo Significado

Parâmetros de entrada

Não é necessário nenhum parâmetro de entrada para consultar as pastas autorizadas ao usuário.

Dados de retorno

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

http://schemas.xmlsoap.org/soap/envelope/

http://www.w3.org/2001/XMLSchema-instance

http://www.w3.org/2001/XMLSchema

http://www.bcb.gov.br/correiows

7

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 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="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: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>


</Unidade>

<Dependencia/>

<Setor>

<Nome>Disin</Nome>

<Ativo>true</Ativo>

</Setor>

<Tipo>Setor</Tipo>

</PastaAutorizadaWSDTO>

</PastasAutorizadas>

<QuantidadePastasAutorizadas>2</QuantidadePastasAutorizadas>

</ConsultarPastasAutorizadasResult> </ConsultarPastasAutorizadasResponse>

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

8

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.

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.

Parâmetros de entrada e dados de retorno do serviço “ConsultarCorreiosPorPasta”:



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.

9

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.

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 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.

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 AVISO CARTACIRCULAR CIRCULAR COMUNICACAO COMUNICACAOGERAL COMUNICACAOSOCIAL COMUNICADO COMUNICADOCONJUNTO DECISAOCONJUNTA INFORMATIVO INSTRUCAONORMATIVABCB INSTRUCAONORMATIVACONJUNTA LINHADIRETA MENSAGEM ORDEMDESERVICO PORTARIA PORTARIACONJUNTA PORTARIAINTERMINISTERIAL RESOLUCAO RESOLUCAOBCB RESOLUCAOCONJUNTA

ser

um dos valores:

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.

10

Exemplo do serviço “ConsultarCorreiosPorPasta”:





<soap:Body>

<ConsultarCorreiosPorPasta xmlns="http://www.bcb.gov.br/correiows">

<consulta>

<Pasta>

<Unidade>

<Nome>DEINF</Nome>

<Ativa>true</Ativa>


</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:Body>

<ConsultarCorreiosPorPastaResponse xmlns="http://www.bcb.gov.br/correiows">

<ConsultarCorreiosPorPastaResult>


<QuantidadeCorreios>1</QuantidadeCorreios>

<Correios>

<ResumoCorreioWSDTO>

<Assunto>Homologação 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>

11

<Versao>0</Versao>

</ResumoCorreioWSDTO>

</Correios>

</ConsultarCorreiosPorPastaResult>

</ConsultarCorreiosPorPastaResponse> </soap:Body>

</soap:Envelope>

12

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.

Parâmetros de entrada e dados de retorno do serviço “LerCorreio”:



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.

Dados de retorno

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 corretamente um correio eletrônico.


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 AVISO CARTACIRCULAR CIRCULAR COMUNICACAO COMUNICACAOGERAL COMUNICACAOSOCIAL COMUNICADO COMUNICADOCONJUNTO DECISAOCONJUNTA INFORMATIVO INSTRUCAONORMATIVABCB INSTRUCAONORMATIVACONJUNTA LINHADIRETA MENSAGEM ORDEMDESERVICO PORTARIA PORTARIACONJUNTA PORTARIAINTERMINISTERIAL RESOLUCAO RESOLUCAOBCB RESOLUCAOCONJUNTA

ser

um dos valores:

De String Unidade e dependência remetentes do correio.

13

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

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.

Lista de elementos do tipo Anexo

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="http://www.w3.org/2001/XMLSchema-instance"


<soap:Body>

<LerCorreio xmlns="http://www.bcb.gov.br/correiows">

<parametros>

<Correio>

<Assunto>Homologação do BC Correio</Assunto>

<Data>2011-07-04T16:23:18.76</Data> <UnidadeDestinataria>DEINF</UnidadeDestinataria>

<UnidadeRemetente>SECRE</UnidadeRemetente>

<Status>Destinado Lido</Status>



<Pasta>

<Tipo>Setor</Tipo> </Pasta>

<Setor>DISIN</Setor>


<Versao>0</Versao>

</Correio>

</parametros>

</LerCorreio>

14

Dados de retorno



<soap:Body>

<LerCorreioResponse xmlns="http://www.bcb.gov.br/correiows"> <LerCorreioResult>


<DetalheCorreio>



<Versao>0</Versao>

<Assunto> Homologação do BC Correio </Assunto> <Conteudo>

<![CDATA[O BC Correio, novo sistema de correio eletrônico do Banco Central do Brasil, está em fase

de Homologação.]]>

</Conteudo>


<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>

Mensagem recebida na Caixa de Entrada do Deinf.

Destinando mensagem para o setor Disin...

</Conteudo>

</DespachoWSDTO>

</Despachos>

<Anexos>

<AnexoWSDTO>

<IdAnexo>4</IdAnexo>

<NomeAnexo>arquivo.txt</NomeAnexo>

</AnexoWSDTO>

</Anexos>

</DetalheCorreio>

</LerCorreioResult>

</LerCorreioResponse>

</soap:Body>

</soap:Envelope>

15

TransmitirCorreio

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.

Parâmetros de entrada e os dados de retorno do serviço “TransmitirCorreio”:



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: AVISO CARTACIRCULAR CIRCULAR COMUNICACAO COMUNICACAOGERAL COMUNICACAOSOCIAL COMUNICADO COMUNICADOCONJUNTO DECISAOCONJUNTA INFORMATIVO INSTRUCAONORMATIVABCB INSTRUCAONORMATIVACONJUNTA LINHADIRETA MENSAGEM ORDEMDESERVICO PORTARIA PORTARIACONJUNTA PORTARIAINTERMINISTERIAL RESOLUCAO RESOLUCAOBCB RESOLUCAOCONJUNTA

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.

16

Dados de retorno

NumeroCorreio int Número que o correio recebe ao ser transmitido.

Exemplo do serviço “TransmitirCorreio”:





<soap:Body>

<TransmitirCorreio xmlns="http://www.bcb.gov.br/correiows">

<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>


<Grupo>false</Grupo>

</parametros> </TransmitirCorreio>

</soap:Body>

</soap:Envelope>

Dados de retorno



<soap:Body>

<TransmitirCorreioResponse xmlns="http://www.bcb.gov.br/correiows">

<TransmitirCorreioResult>



</TransmitirCorreioResult>

</TransmitirCorreioResponse>

</soap:Body>

</soap:Envelope>

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.

17

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.

Parâmetros de entrada e os dados de retorno de

“ConsultarComunicacaoGeralDocumentoDivulgacao”:



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: AVISO CARTACIRCULAR CIRCULAR COMUNICACAO COMUNICACAOGERAL COMUNICACAOSOCIAL COMUNICADO COMUNICADOCONJUNTO DECISAOCONJUNTA INFORMATIVO INSTRUCAONORMATIVABCB INSTRUCAONORMATIVACONJUNTA LINHADIRETA MENSAGEM ORDEMDESERVICO PORTARIA PORTARIACONJUNTA PORTARIAINTERMINISTERIAL RESOLUCAO RESOLUCAOBCB RESOLUCAOCONJUNTA

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.

18

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 contém:


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: AVISO CARTACIRCULAR CIRCULAR COMUNICACAO COMUNICACAOGERAL COMUNICACAOSOCIAL COMUNICADO COMUNICADOCONJUNTO DECISAOCONJUNTA INFORMATIVO INSTRUCAONORMATIVABCB INSTRUCAONORMATIVACONJUNTA LINHADIRETA MENSAGEM ORDEMDESERVICO PORTARIA PORTARIACONJUNTA PORTARIAINTERMINISTERIAL RESOLUCAO RESOLUCAOBCB RESOLUCAOCONJUNTA

DataHora DateTime Data e hora de transmissão do correio.

Responsavel String Unidade responsável pela transmissão 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”:





<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>RESOLUCAOBCB</TipoDocumento>

<PesquisarPalavrasChave>false</PesquisarPalavrasChave>

19

</parametros>

</ConsultarComunicacaoGeralDocumentoDivulgacao>

</soap:Body>

</soap:Envelope>

Dados de retorno



<soap:Body>

<ConsultarComunicacaoGeralDocumentoDivulgacaoResponse xmlns="http://www.bcb.gov.br/correiows">

<ConsultarComunicacaoGeralDocumentoDivulgacaoResult>


<ComGeraisDocDivulgacao>

<ComunicacaoGeralDocumentoDivulgacao>


<Versao>0</Versao>

<SequencialNormativo>3983</SequencialNormativo>

<TipoDocumento>RESOLUCAOBCB</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 serviço LerComunicacaoGeralDocumentoDivulgacao 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.

Parâmetros de entrada e dados de retorno de “LerComunicacaoGeralDocumentoDivulgacao”:



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.

Dados de retorno

20

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:

AVISO CARTACIRCULAR CIRCULAR COMUNICACAO COMUNICACAOGERAL COMUNICACAOSOCIAL COMUNICADO COMUNICADOCONJUNTO DECISAOCONJUNTA INFORMATIVO INSTRUCAONORMATIVABCB INSTRUCAONORMATIVACONJUNTA LINHADIRETA MENSAGEM ORDEMDESERVICO PORTARIA PORTARIACONJUNTA PORTARIAINTERMINISTERIAL RESOLUCAO RESOLUCAOBCB RESOLUCAOCONJUNTA

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.


Conteudo String Conteúdo do correio. correio eletrônico.

Representa o texto principal do

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”:





<soap:Body>

<LerComunicacaoGeralDocumentoDivulgacao xmlns="http://www.bcb.gov.br/correiows">

<Parametros>


</Parametros>

</LerComunicacaoGeralDocumentoDivulgacao>

</soap:Body>

</soap:Envelope>

21

Dados de retorno



<soap:Body>

<LerComunicacaoGeralDocumentoDivulgacaoResponse xmlns="http://www.bcb.gov.br/correiows">

<LerComunicacaoGeralDocumentoDivulgacaoResult> <OcorreuErro>false</OcorreuErro>

<DadosComunicacaoGeralDocumentoDivulgacao>


<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 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º 10.183, 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 2011.

Brasília, 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>Resolução Nº 3.983</Documento>

<Anexos/>

</DadosComunicacaoGeralDocumentoDivulgacao>

</LerComunicacaoGeralDocumentoDivulgacaoResult>

</LerComunicacaoGeralDocumentoDivulgacaoResponse>

22

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.

Parâmetros de entrada e os dados de retorno do serviço “ObterAnexo”:



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.

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.

Dados de retorno

Anexo Anexo Informações do arquivo obtido, que abrange id, nome e conteúdo do arquivo em Base64Binary.

Exemplo do serviço “ObterAnexo”:

Parâmetros de entrada <?xml version="1.0" encoding="utf-8"?>



<soap:Body>

<ObterAnexo xmlns="http://www.bcb.gov.br/correiows">

<parametros>


<Versao>0</Versao>


<Pasta>

<Tipo>Setor</Tipo>

</Pasta>

<Anexo>


<NomeAnexo>arquivo.txt</NomeAnexo>

23

</Anexo> </parametros>

</ObterAnexo>

</soap:Body>

</soap:Envelope>

Dados de retorno



<soap:Body>

<ObterAnexoResponse xmlns="http://www.bcb.gov.br/correiows">

<ObterAnexoResult>


<Anexo>


<NomeAnexo>arquivo.txt</NomeAnexo> <Conteudo>...</Conteudo>

</Anexo>

</ObterAnexoResult>

</ObterAnexoResponse>

</soap:Body>

</soap:Envelope>

BC CORREIO SISTEMA DE CORREIO ELETRÔNICO DO BANCO … · Correio ResumoCorreio Elemento que...

Documents

Transcript of BC CORREIO SISTEMA DE CORREIO ELETRÔNICO DO BANCO … · Correio ResumoCorreio Elemento que...