Banco de Dados Nacional de Óbitos SINOB. Manual do Produto Versão 3.2

Transcrição

1 Banco de Dados Nacional de Óbitos SINOB Manual do Produto Versão 3.2 Julho/2015

2 Índice 1. INFORMAÇÕES GERAIS SOBRE O PRODUTO CONTEXTO OBJETIVO NOME ENDEREÇO DO ARQUIVO WSDL REQUISITOS E ORIENTAÇÕES PARA O ACESSO INFORMAÇÕES DETALHADAS DO SERVIÇO ACESSO VIA BROWSER Endereço/Link de acesso Telas Envio de Requisição Consulta pelo Código de Requisição Lista de Requisições por Período Exemplos: Exemplo de consultas realizadas com sucesso Envio de Requisição Consulta pelo Código de Requisição Lista de Requisições por Período Exemplo de retorno com erro na consulta Parâmetro Inválido Possíveis retornos com erro na consulta: Retornos específicos deste produto Retornos gerais ACESSO WEBSERVICE Nome das consultas do serviço INFORMAÇÕES SOBRE O RETORNO DAS CONSULTAS Parâmetros de retorno: caso de sucesso Estrutura dos Dados Exemplos de retorno: caso de sucesso Envio de Requisição Consulta pelo Código de Requisição Lista de Requisições por Período Informações de retorno: caso de erro Parâmetros de retorno: caso de erro Exemplo de retorno: caso de erro PARÂMETROS DE ENTRADA DAS CONSULTAS Solicita Requisição Consulta pelo Código de Requisição Lista de Requisições por Período CLASSE WS JAVA PARA CONSULTA MÓDULO CONSULTA EM LOTE CONTEXTO OBJETIVO INFORMAÇÕES DETALHADAS DO MÓDULO CONSULTA EM LOTE CONSIDERAÇÕES GERAIS SOBRE PARÂMETROS DE ENTRADA E/OU SAÍDA Arquivo(s) de entrada Exemplo de arquivo de entrada Arquivo(s) de saída Exemplo de arquivo de retorno FLUXO DE UTILIZAÇÃO FLUXO DE ENVIO DE LOTE... 19

3 5.2 FLUXO DE RETORNO DE LOTE Fluxo de Retorno de Lote (arquivo com inconsistência) Fluxo de Retorno de Lote (arquivo com SUCESSO)

4 1. Informações gerais sobre o produto 1.1 Contexto O SINOB Banco de Dados Nacional de Óbitos foi feito através de convênio com a DATAPREV. Sistema que permite realizar consultas à base de dados de óbitos da DATAPREV, que registra, processa e centraliza as informações de óbitos dos Cartórios de Registros Civis instalados em todo o território brasileiro. 1.2 Objetivo Tem como objetivo principal registrar, processar e centralizar a base de dados de óbitos, mediante informações oriundas dos Cartórios de Registros Civis instalados em todo território brasileiro. 1.3 Nome SINOB Banco de Dados Nacional de Óbitos 1.4 Endereço do arquivo WSDL Requisitos e orientações para o acesso Para acessar o sistema, a seguradora deverá entrar em contato com o Canal de Atendimento da Central de Serviços através do telefone: ou atendimento@ceser.org.br. 4

5 2. Informações detalhadas do serviço 2.1 Acesso via Browser Endereço/Link de acesso Telas 5

6 Envio de Requisição Os campos Nome do Titular e Data de Nascimento são obrigatórios, os demais campos são opcionais e podem ser informados para melhorar a assertividade do resultado Consulta pelo Código de Requisição 6

7 Lista de Requisições por Período Exemplos: Exemplo de consultas realizadas com sucesso Envio de Requisição 7

8 Consulta pelo Código de Requisição 8

9 Lista de Requisições por Período Exemplo de retorno com erro na consulta Parâmetro Inválido Indica que um ou mais campos estão nulos ou inválidos 9

10 2.1.4 Possíveis retornos com erro na consulta: Retornos específicos deste produto Retorno Requisição inválida para este usuário Resultado informado em <DATA> CPF inválido Web Service temporariamente indisponível. Por favor, aguarde um momento e tente novamente Favor consultar novamente mais tarde. Descrição Indica que o código de requisição é inválido para o usuário Indica que o resultado da requisição já foi informado na data especificada em <DATA> Indica que o valor informado não corresponde a um CPF válido Indica que o Web Service está indisponível Indica que é para tentar novamente a consulta em outro momento Retornos gerais Retorno Usuário ou Senha Inválido Parâmetro inválido Não há retorno para esta consulta Sua consulta não foi realizada, entre em contato com o suporte Cliente não possui permissão para o método Acesso não permitido para o IP Cliente não possui crédito disponível Cliente já utilizou todas as consultas do Contrato de Experiência de Uso para esse método Contrato inativo ou fora do período de vigência Método inválido Produto inválido Produto em desenvolvimento Descrição Indica que o usuário e/ou a senha informada são inválidos Indica que um ou mais campos estão nulos ou inválidos Indica que não foi encontrado nenhum registro para os campos informados Indica que ocorreu um erro inesperado e é preciso entre em contato com o suporte Indica que o usuário não tem permissão para realizar a consulta Indica que a consulta foi realizada a partir de um IP não cadastrado para a empresa do usuário Indica que a consulta não pode ser realizada, pois não há crédito suficiente Indica que o contrato da empresa é de Experiência de Uso e a quantidade máxima de consultas permitidas já foi atingida. Indica que a empresa não possui nenhum contrato ativo e/ou vigente para o produto. Indica que esta consulta não está disponível. Indica que esta consulta não está disponível. Indica que esta consulta não está disponível. 2.2 Acesso WebService Nome das consultas do serviço A tabela a seguir apresenta as consultas disponíveis para consumo e o nome da operação na interface do serviço. 10

11 Descrição da Consulta Envio de Requisição Consulta pelo Código de Requisição Lista de Requisições por Período Nome da Operação SolicitaRequisicao ConsultaResultadoMultiplo ConsultaReqCliente 2.3 Informações sobre o retorno das consultas Esta seção apresenta estruturas e exemplos dos retornos de cada consulta Parâmetros de retorno: caso de sucesso Informações detalhadas sobre os parâmetros de retorno para consultas ao SINOB realizadas com sucesso Estrutura dos Dados Nome do Campo Tipo Tamanho Descrição do Campo Consulta Char 10 Número da Requisição Data_Obito Char 50 Data do Óbito Resultado Char 50 Mensagem de resultado MunicipioNascimentoCodigo Char 10 Código do município de nascimento MunicipioNascimento Char 50 Município de nascimento Cpf_Obito Char 11 Cpf do óbito Nome_Obito Char 50 Nome do óbito Mae_Obito Char 50 Nome da mãe do óbito Identidade Char 14 Identidade do óbito Ctps Char 10 Número da CTPS do óbito Serie_Ctps Char 10 Número de série da CTPS do óbito Titulo_Eleitor Char 11 Título de eleitor do óbito Dv_Titulo_Eleitor Char 2 Dígito verificador do título de eleitor do óbito Livro Char 10 Livro de registro do óbito Folha Char 10 Folha de registro do óbito Termo Char 10 Termo de registro do óbito Nome_Cartorio Char 50 Nome do cartório de registro do óbito Endereco_Cartorio Char 50 Endereço do cartório de registro do óbito MunicipioCartorioCodigo Char 10 Código do município do cartório de registro do óbito MunicipioCartorio Char 50 Município do cartório de registro do óbito Uf_Cartorio Char 2 UF do cartório de registro do óbito Sexo Char 10 Sexo do óbito EmissordeIdentidade Char 50 Emissor de identidade do óbito DataHora Char 50 Data e Hora do óbito Entrada_NomeDoTitular Char 60 Nome do titular de entrada no óbito Entrada_CPFDoTitular Char 11 CPF do titular de entrada no óbito Entrada_MaeDoTitular Char 50 Nome da mãe do titular de entrada no óbito Entrada_CampoLivre Char 21 Campo livre de entrada no óbito Entrada_DataDeNascimento Char 50 Dara de Nascimento do titular de entrada no óbito Uf_Identidade Char 2 UF da Identidade Uf_Ctps Char 2 UF do CTPS Bairro_Cartorio Char 25 Bairro do cartório de registro do óbito Observação Char 8000 Obervações sobre o registro de óbito NumControle Int Número de controle da consulta NomeTitular Char 50 Nome do Titular 11

12 MaeTitular Char 50 Nome da mãe do titular DataNascTitular Char 10 Data de nascimento DD/MM/AAAA DataSolicitacao Char 10 Data de solicitação DD/MM/AAAA Identificação da Consulta Protocolo Char 20 Número de protocolo da consulta Saldo Decimal 13,2 Saldo só deve ser considerado para contratos Pré-pago Exemplos de retorno: caso de sucesso Exemplos de XML de retorno para consultas realizadas com sucesso Envio de Requisição <Sinob> <Consulta> <Retorno> </Retorno> <saldo>0,00 </saldo> <protocolo> </protocolo> </Consulta> </Sinob> Consulta pelo Código de Requisição <Sinob> <Consulta> <DATA_OBITO>10/10/2010</DATA_OBITO> <Resultado>sucesso</Resultado> <MunicipioNascimentoCodigo /> <MunicipioNascimento>cidade</MunicipioNascimento> <CPF_OBITO> </CPF_OBITO> <NOME_OBITO>Nome</NOME_OBITO> <MAE_OBITO>Nome da mãe</mae_obito> <IDENTIDADE> </IDENTIDADE> <CTPS> </CTPS> <SERIE_CTPS>2</SERIE_CTPS> <TITULO_ELEITOR> </TITULO_ELEITOR> <DV_TITULO_ELEITOR>2</DV_TITULO_ELEITOR> <LIVRO>1</LIVRO> <FOLHA>1</FOLHA> <TERMO>1</TERMO> <NOME_CARTORIO>NOME</NOME_CARTORIO> <ENDERECO_CARTORIO>Rua do Cartorio</ENDERECO_CARTORIO> <MunicipioCartorioCodigo /> <MunicipioCartorio>Municipio do Cartorio</MunicipioCartorio> <UF_CARTORIO /> <SEXO>M</SEXO> <EmissorDeIdentidade>Orgao Emissor</EmissorDeIdentidade> <DATAHORA /> <entrada_nomedotitular>nome</entrada_nomedotitular> <entrada_cpfdotitular> </entrada_cpfdotitular> <entrada_maedotitular>nome da mãe</entrada_maedotitular> <entrada_campolivre>1</entrada_campolivre> <entrada_datadenascimento>01/01/1990</entrada_datadenascimento> <UF_IDENTIDADE>RJ</UF_IDENTIDADE> <UF_CTPS>RJ</UF_CTPS> <BAIRRO_CARTORIO>Bairro</BAIRRO_CARTORIO> <OBSERVACAO /> 12

13 <saldo>0,00</saldo> <protocolo> </protocolo> </Consulta> </Sinob> Lista de Requisições por Período <Sinob> <Consulta> <NumControle>1 </NumControle> <NomeTitular>NOME </NomeTitular> <MaeTitular>MAE </MaeTitular> <DataNascTitular>01/01/2015 </DataNascTitular> <DataSolicitacao>05/01/2015 </DataSolicitacao> </UsrSolicitante> <saldo>0,00 </saldo> <protocolo> </protocolo> </Consulta> <Consulta> <NumControle>1 </NumControle> <NomeTitular>NOME2 </NomeTitular> <MaeTitular>MAE2 </MaeTitular> <DataNascTitular>10/12/1920 </DataNascTitular> <DataSolicitacao>05/01/2015 </DataSolicitacao> </UsrSolicitante> <saldo>0,00 </saldo> <protocolo> </protocolo> </Consulta> <Consulta> <NumControle>9 </NumControle> <NomeTitular>NOME3 </NomeTitular> <MaeTitular>MAE3 </MaeTitular> <DataNascTitular>24/01/1985 </DataNascTitular> <DataSolicitacao>30/12/2014 </DataSolicitacao> </UsrSolicitante> <saldo>0,00 </saldo> <protocolo> </protocolo> </Consulta> </Sinob> Informações de retorno: caso de erro Informações detalhadas de retorno para consultas realizadas com erro Parâmetros de retorno: caso de erro Código Retorno E01 Usuário ou Senha Inválido E04 Parâmetro inválido E06 Não há retorno para esta consulta E00 Sua consulta não foi realizada, entre em contato com o suporte E03 Cliente não possui permissão para o método E05 Acesso não permitido para o IP E02 Cliente não possui crédito disponível E02 Cliente já utilizou todas as consultas do Contrato de Experiência de Uso para esse método E03 Contrato inativo ou fora do período de vigência E03 Método inválido 13

14 E03 E03 E08 ERR ERR ERR ERR Produto inválido Produto em desenvolvimento Requisição inválida para este usuário Resultado informado em <DATA> CPF inválido Web Service temporariamente indisponível. Por favor, aguarde um momento e tente novamente Favor consultar novamente mais tarde Exemplo de retorno: caso de erro <?xml version="1.0" encoding="utf-8"?> <Sinob> <Consulta> <coderro>e00</coderro> <erro>sua consulta não foi realizada, entre em contato com o suporte.</erro> <saldo>0.00</saldo> <protocolo> </protocolo> </Consulta> </Sinob> 2.4 Parâmetros de entrada das consultas Solicita Requisição Parâmetro Tipo Tamanho Obrigatório Observações idusuario Int 255 Sim Informar ID do Usuário Senha Varchar 15 Sim Informar Senha do Usuário wtitular Varchar 60 Sim Informar Nome do titular wmae Varchar 50 Não Informar nome da mãe wcpf Varchar 11 Não Informar número do CPF wnascimento Varchar 10 Sim Informar data de nascimento no formato DD/MM/AAAA Consulta pelo Código de Requisição Parâmetro Tipo Tamanho Obrigatório Observações idusuario Varchar 255 Sim Informar ID do Usuário Senha Varchar 15 Sim Informar Senha do Usuário norequisicao Varchar 10 Sim Informar número de requisição para a consulta Lista de Requisições por Período Parâmetro Tipo Tamanho Obrigatório Observações idusuario Varchar 255 Sim Informar ID do Usuário Senha Varchar 15 Sim Informar Senha do Usuário DataIni Varchar 10 Sim Informar data de início no formato DD/MM/AAAA DataFim VarChar 10 Sim Informar data de fim no formato DD/MM/AAAA 14

15 2.5 Classe WS Java para consulta Exemplo de classe WS Java para consulta ao método Consulta de Processos. Os demais métodos devem seguir este mesmo exemplo, alterando apenas os parâmetros de entrada: package br.org.cnseg; import java.io.bytearrayinputstream; import java.io.bytearrayoutputstream; import java.io.ioexception; import java.net.url; import javax.xml.soap.messagefactory; import javax.xml.soap.mimeheaders; import javax.xml.soap.soapconnection; import javax.xml.soap.soapconnectionfactory; import javax.xml.soap.soapconstants; import javax.xml.soap.soapexception; import javax.xml.soap.soapmessage; public class CNSegSOAP { public static void main(string[] args) { processa("usuario@empresa.com.br", "senha", "norequisicao"); } public static void processa(string usuario, String senha, String norequisicao){ StringBuffer soapmessage = new StringBuffer(); //Cria o XML para envio, pode ser feito usando JDOM soapmessage.append("<soapenv:envelope xmlns:soapenv=\" xmlns:sinob=\" <soapenv:header/>").append(" <soapenv:body>").append(" <sinob:consultaresultadomultiplo>").append(" <idusuario>"+usuario+"</isusuario>").append(" <Senha>"+senha+"</Senha>").append(" <norequisicao>"+norequisicao+"</norequisicao>").append(" </sinob:consultaresultadomultiplo>").append(" </soapenv:body>").append("</soapenv:envelope>"); dosoap(soapmessage.tostring(), " //Realiza chamada SOAP } public static void dosoap(string xml, String urlwsdl){ try { MessageFactory factory = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL); SOAPMessage message; try { MimeHeaders header = new MimeHeaders(); header.addheader("content-type", "application/soap+xml"); message = factory.createmessage(header, new ByteArrayInputStream(xml.getBytes())); SOAPConnection con = SOAPConnectionFactory.newInstance().createConnection(); URL url = new URL(urlWsdl); SOAPMessage res = con.call(message, url); ByteArrayOutputStream out = new ByteArrayOutputStream(); res.writeto(out); System.out.println(out.toString()); // Aqui temos o XML de retorno basta realizar a desserialização } catch (IOException ex) { System.out.println(ex.getMessage()); } 15

16 } } } catch (SOAPException ex) { System.out.println(ex.getMessage()); } 16

17 3. Módulo Consulta em Lote 3.1 Contexto A Consulta em Lote armazena em arquivo único o resultado obtido de um montante de consultas feitas ao Portal CESER. 3.2 Objetivo Disponibilizar resultado de consultas sequenciais feitas ao Portal CESER em arquivo consolidado. 4. Informações detalhadas do Módulo 4.1 Consulta em Lote O Módulo pode ser acessado seguindo os seguintes passos: Efetuar Log In no Portal CESER Acessar a opção de menu superior Lote Acessar a opção de menu lateral Consulta em lote Caso o objetivo seja consultar o resultado de um Lote, seguir os seguintes passos: Efetuar Log In no Portal CESER (Caso ainda não esteja logado). Acessar a opção de menu superior Lote Acessar a opção de menu lateral Pesquisar em lote 4.2 Considerações gerais sobre parâmetros de entrada e/ou saída Restrições: O Arquivo de entrada não pode ter mais do que Linhas. O Arquivo de entrada deve ter o formato CSV ou TXT O Arquivo de entrada deve ter apenas um parâmetro por linha (salvo quando a consulta exigir mais parâmetros de entrada, como é o caso do SINOB. Neste caso, os parâmetros devem ser separados por ; Ponto e Vírgula ) Arquivo(s) de entrada Todo arquivo de entrada não pode conter acentos, cedilhas ou caracteres especiais, somente caracteres alfanuméricos, e apenas um parâmetro por linha. 17

18 Exemplo de arquivo de entrada Os campos obrigatórios para consultar no SINOB são Nome do Titular e Data de Nascimento, os demais campos (Nome da Mãe e CPF) são opcionais e, quando informados, favorecem a assertividade do resultado. Todos os campos precisam ser clicados na tela. Arquivo em Excel (.csv) o arquivo deve conter os campos nesta ordem: 1ª coluna - nome do titular, 2ª coluna - nome da mãe (se não houver deixar a coluna em branco), 3ª coluna - CPF (com 11 dígitos e sem pontos ou hífen) e 4ª coluna - data de nascimento (DD/MM/AAAA). Arquivo.TXT sem cabeçalho e com a seguinte ordem: MARIA JOSÉ;MARIA DAS DORES; ;01/01/1980 Se não houver o nome da mãe será assim: MARIA JOSÉ;; ;01/01/1980 E após a última linha do arquivo, tanto no Excel quanto no.txt, não pode conter ENTER, senão, será considerado como uma nova linha e o sistema sinalizará com nova inconsistência Arquivo(s) de saída Os arquivos de retorno terão o formato XML. Desta forma, o usuário tem liberdade para trabalhar com o mesmo em várias ferramentas: Excel, Notepad, dentre outros Exemplo de arquivo de retorno retorno.xml <ConsultaResultadoMultiploResult> <Sinob> <Consulta> <DATA_OBITO/> <Resultado>Não localizado pelas comparações seguintes</resultado> <MunicipioNascimentoCodigo/> <MunicipioNascimento/> <CPF_OBITO/> <NOME_OBITO/> <MAE_OBITO/> <IDENTIDADE/> <CTPS/> <SERIE_CTPS/> <TITULO_ELEITOR/> <DV_TITULO_ELEITOR/> <LIVRO/> 18

19 <FOLHA/> <TERMO/> <NOME_CARTORIO/> <ENDERECO_CARTORIO/> <MunicipioCartorioCodigo/> <MunicipioCartorio/> <UF_CARTORIO/> <SEXO/> <EmissorDeIdentidade/> <DATAHORA>15/8/ :49:36</DATAHORA> <entrada_nomedotitular>maria teste</entrada_nomedotitular> <entrada_cpfdotitular> </entrada_cpfdotitular> <entrada_maedotitular>rosa teste</entrada_maedotitular> <entrada_campolivre/> <entrada_datadenascimento>01/01/ :00:00</entrada_DataDeNascimento> <UF_IDENTIDADE/> <UF_CTPS/> <BAIRRO_CARTORIO/> <saldo>0,00</saldo> <protocolo> </protocolo> </Consulta> </Sinob> </ConsultaResultadoMultiploResult> 5. Fluxo de utilização 5.1 Fluxo de Envio de Lote Efetuar login no sistema acessando o seguinte endereço: Selecionar a opção Lote 19

20 Repare que os últimos lotes já são exibidos, como mostra a ilustração. 20

21 Selecionar a opção: Consulta em Lote. 1º passo: Clicar em Adicionar e selecionar o arquivo com o lote de consultas a serem realizadas. Informar a quantidade de linhas do arquivo e clicar no campos relativos ao SINOB. Os campos nome do titular e data de nascimento são obrigatórios. Entretanto, todos os campos de consulta ao SINOB, obrigatórios ou não, deverão ser clicados: CPF, data de nascimento, mãe do titular e nome do titular. 21

22 2º passo: selecionar o método: SINOB envio de requisição 22

23 3º passo: Após clicar em enviar, confira os dados fornecidos na tela seguinte e se estiver de acordo, selecione a opção Estou de acordo com as consultas e valores acima, mesmo que esteja zerado. Clique em enviar. O valor aqui mencionado será de acordo com o contratado para a operação. 23

24 Neste ponto seu lote já foi enviado e estará automaticamente sendo gerado. 24

25 5.2 Fluxo de Retorno de Lote No menu lateral selecione a opção Pesquisar Lote Entre com uma das informações do filtro e clique em Pesquisar. 25

26 Uma vez selecionado o protocolo, realize o download do arquivo de saída. 26

27 5.2.1 Fluxo de Retorno de Lote (arquivo com inconsistência) Se o arquivo enviado apresentou inconsistência, clicar no protocolo conforme marcado na tela a seguir. 27

28 Ao clicar no protocolo, abrirá uma nova tela com o arquivo de saída. Clicar no arquivo que abrirá um.txt informando em quais linhas ou campos do arquivo estão os erros que não permitiram o processamento do lote. 28

29 5.2.2 Fluxo de Retorno de Lote (arquivo com SUCESSO) Os arquivos de retorno terão o formato XML. Desta forma, o usuário tem liberdade para trabalhar com o mesmo em várias ferramentas: Excel, Notepad, dentre outros. Para isto, salve o arquivo gerado e ao abrir execute os seguintes passos: 1º passo: Obs.: Pode ser utilizada qualquer ferramenta de extração de arquivos (WinZip, WinRar etc.) 2º passo: 29

30 3º passo: Clicar em OK, abrirá um arquivo XML (linguagem usada pela TI), salve-o na sua máquina, para abri-lo em Excel arraste o arquivo XML para dentro da planilha. Seu processamento aparecerá com o formato habitual do Excel, separado por colunas. 30