Boletim Eletrônico de Registro de Acidente de Trânsito sem Vítimas

Transcrição

1 Boletim Eletrônico de Registro de Acidente de Trânsito sem Vítimas EBRAT CONSULTAS Manual do Produto Versão 2.2 Junho/2017

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 Consulta por Dados do Acidente Consulta Protocolo Exemplos: Exemplo de consultas realizadas com sucesso Exemplo de retorno com erro na consulta Parâmetro Inválido Possíveis retornos com erro na consulta: Retornos específicos deste produto... 9 Retornos gerais Acesso Webservice Protocolo de Comunicação 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 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 Consulta por Dados do Acidente Consulta por Protocolo... 15

3 1. Informações gerais sobre o produto 1.1 Contexto O E-Brat Consultas foi criado através de um convênio firmado entre a Fenaseg/CNseg e a PMERJ, onde foi desenvolvido um sistema para registro OnLine de acidentes de trânsito, sem vítimas, envolvendo até cinco veículos, no estado do Rio de Janeiro. Contém as informações sobre os dados da ocorrência, do veículo principal, de proprietário e condutor, veículos envolvidos e testemunhas caso tenha sido declarado, e informações complementares sobre o acidente. É possível também a inclusão de fotos. Diariamente a Fenaseg/CNseg recebe informações sobre os Boletins de Ocorrência registrados. 1.2 Objetivo Permitir às seguradoras e aos parceiros acesso aos registros de acidentes de trânsito sem vítimas, disponibilizados no banco de dados do e-brat. 1.3 Nome Boletim Eletrônico de Registro de Acidente de Trânsito sem Vítimas. 1.4 Endereço do arquivo WSDL Homologação: Produção: Requisitos e orientações para o acesso Para entrar em contato com a Superintendência Executiva de Negócios da CNseg, seja em caso de dúvida, reclamações, sugestões ou para solicitação de informações sobre nossas soluções, acione o Canal de Atendimento ao Cliente. Para utilizar o Canal de Atendimento ao Cliente, acesse cnseg.org.br clicando no banner Soluções Tecnológicas para o Mercado e, em seguida, no banner Atendimento ao Cliente. Informamos que o login é o seu e no seu primeiro acesso você deverá solicitar uma senha, clicando em recuperar senha. 3

4 Os novos usuários deverão solicitar seu acesso a um usuário já cadastrado no Canal de Atendimento ao Cliente, conforme abaixo: Após o primeiro acesso é possível alterar sua senha, através dos passos a seguir: 1º Passo: Após logar, na primeira tela apresentada, no menu superior clique em Alterar Senha. 2º Passo: Preencha com a senha de sua escolha e clique em Concluir Abertura para finalização. 2. Informações detalhadas do serviço 2.1 Acesso via Browser Endereço/Link de acesso Homologação: Produção: Telas 4

5 Consulta por Dados do Acidente Consulta Protocolo 5

6 2.1.3 Exemplos: Exemplo de consultas realizadas com sucesso 6

7 7

8 8

9 Exemplo de retorno com erro na consulta Parâmetro Inválido Indica que um ou mais campos estão nulos ou inválidos Possíveis retornos com erro na consulta: Retornos específicos deste produto Retorno Deve ser informado outro parâmetro além da data Descrição Indica que a consulta não pode ser realizada informando-se apenas o campo data 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 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 que 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á saldo 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. 9

10 Método inválido Produto inválido Produto em desenvolvimento 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 Protocolo de Comunicação O protocolo de comunicação com o webservice é o SOAP 1.1. Esse protocolo aceita apenas requisições POST 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. Descrição da Consulta Consulta por Dados do Acidente Consulta Protocolo Nome da Operação consultaebrat consultaebratunico 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 BDV realizadas com sucesso Estrutura dos Dados Nome do Campo Tipo Tamanho Descrição do Campo Dados da Ocorrência DataOcorrencia Char 10 Data da ocorrência do Brat HoraOcorrencia Char 5 Hora da ocorrência do Brat LocalOcorrencia Char 200 Local da ocorrência do Brat EspecificacaoLocal Char 200 Especificação do local da ocorrência Cep Char 8 CEP do endereço da ocorrência Logradouro Char 100 Logradouro do endereço da ocorrência Numero Char 10 Número do endereço da ocorrência Bairro Char 50 Bairro do endereço da ocorrência Cidade Char 50 Cidade do endereço da ocorrência Uf Char 2 UF do endereço da ocorrência Complemento Char 100 Complemento do endereço da ocorrência PontoReferencia Char 100 Ponto de referência do endereço da ocorrência Visibilidade Char 20 Condição da visibilidade no momento da ocorrência Pista Char 20 Condição da pista no momento da ocorrência Sinalizacao Char 20 Condição da sinalização no momento da ocorrência TipoAcidente Char 200 Tipo do acidente 10

11 Descricao Char 4000 Texto descritivo do acidente ocorrido Char 100 do criador do Brat Fotos Char 100 Foto ProtocoloBrat Char 20 Protocolo identificador do Brat Dados dos Veículos Placa Char 7 Placa do Veículo Renavam Char 11 Renavam do Veículo TipoVeiculo Char 20 Indica se o veículo é o principal ou envolvido na ocorrência MarcaModelo Char 25 Marca e modelo do Veículo Cor Char 15 Cor do Veículo Chassi Char 20 Chassi do Veículo UfVeiculo Char 2 UF do Veículo AnoFabricacao Number 4 Ano de fabricação do Veículo AnoModelo Number 4 Ano do modelo do Veículo DanoLD Number 1 Indicador de dano lateral direito do Veículo. 0 Sem dano 1 Com dano DanoLE Number 1 Indicador de dano lateral esquerdo do Veículo. 0 Sem dano 1 Com dano DanoDD Number 1 Indicador de dano dianteiro direito do Veículo. 0 Sem dano 1 Com dano DanoDE Number 1 Indicador de dano dianteiro esquerdo do Veículo. 0 Sem dano 1 Com dano DanoTD Number 1 Indicador de dano traseiro direito do Veículo. 0 Sem dano 1 Com dano DanoTE Number 1 Indicador de dano traseiro esquerdo do Veículo. 0 Sem dano 1 Com dano Dados dos Motoristas (ligados aos Veículos) NomeMotorista Char 8000 Nome do Motorista SexoMotorista Number 1 Sexo do Motorista EstadoCivilMotorista Char 20 Estado civil do Motorista CpfCnpjMotorista Char 1000 CPF ou CNPJ do Motorista DataNascimentoMotorista Char 10 Data de nascimento do Motorista TipoMotorista Char 20 Indica se o motorista é condutor ou proprietário do veículo Cep Char 8 CEP do endereço do Motorista Logradouro Char 100 Logradouro do endereço do Motorista Numero Char 10 Número do endereço do Motorista Bairro Char 50 Bairro do endereço do Motorista Cidade Char 50 Cidade do endereço do Motorista Uf Char 2 UF do endereço do Motorista Complemento Char 100 Complemento do endereço do Motorista Dados das Testemunhas NomeTestemunha Char 8000 Nome da testemunha CpfTestemunha Char 1000 CPF da testemunha TelefoneFixoTestemunha Char 1000 Número do telefone fixo da testemunha TelefoneMovelTestemunha Char 1000 Número do telefone móvel da testemunha EnderecoTestemunha Char 8000 Endereço da testemunha Identificação da Consulta 11

12 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. <consulta> <EBRAT> <DataOcorrencia>26/06/2010</DataOcorrencia> <HoraOcorrencia>12:53</HoraOcorrencia> <LocalOcorrencia>Numa via urbana</localocorrencia> <EspecificacaoLocal>Numa via de mão dupla</especificacaolocal> <EnderecoOcorrencia> <Cep> </Cep> <Logradouro>rua 100</Logradouro> <Numero>s/n</Numero> <Bairro>centro</Bairro> <Cidade>itaborai</Cidade> <Uf>RJ</Uf> <Complemento /> <PontoReferencia>esquina com 101</PontoReferencia> </EnderecoOcorrencia> <Condicoes> <Visibilidade>Boa</Visibilidade> <Pista>Deficiente</Pista> <Sinalizacao>Sem Sinalização</Sinalizacao> </Condicoes> <TipoAcidente>Colisão</TipoAcidente> <Veiculos> <Veiculo> <Placa>XXX0000</Placa> <Renavam> </Renavam> <TipoVeiculo>Principal</TipoVeiculo> <MarcaModelo>MARCA/MODELO</MarcaModelo> <Cor>PRATA</Cor> <Chassi>00W000M00C </Chassi> <UfVeiculo>RJ</UfVeiculo> <AnoFabricacao>2011</AnoFabricacao> <AnoModelo>2012</AnoModelo> <Danos> <DanoLD>0</DanoLD> <DanoLE>0</DanoLE> <DanoDD>1</DanoDD> <DanoDE>1</DanoDE> <DanoTD>0</DanoTD> <DanoTE>0</DanoTE> </Danos> <Motoristas> <Motorista> <NomeMotorista>NOME DO MOTORISTA</NomeMotorista> <SexoMotorista>1</SexoMotorista> <EstadoCivilMotorista>Solteiro(a)</EstadoCivilMotorista> <CpfCnpjMotorista> </CpfCnpjMotorista> <DataNascimentoMotorista>16/08/1950 </DataNascimentoMotorista> 12

13 <TipoMotorista>Proprietário</TipoMotorista> <EnderecoMotorista> <Cep> </Cep> <Logradouro>Rua Constantina</Logradouro> <Numero>000</Numero> <Bairro>João Caetano (Itambi)</Bairro> <Cidade>Itaboraí</Cidade> <Uf>RJ</Uf> <Complemento /> </EnderecoMotorista> </Motorista> </Motoristas> </Veiculo> <Veiculo> <Placa>ABC1111</Placa> <Renavam /> <TipoVeiculo>Envolvido</TipoVeiculo> <MarcaModelo /> <Cor>branco</Cor> <Motoristas> <Motorista> <NomeMotorista>viação</NomeMotorista> <SexoMotorista>0</SexoMotorista> <EstadoCivilMotorista /> <CpfCnpjMotorista /> <DataNascimentoMotorista /> <TipoMotorista>Condutor</TipoMotorista> <EnderecoMotorista> <Cep /> <Logradouro>avenida</Logradouro> <Numero /> <Bairro>BAIRRO</Bairro> <Cidade>CIDADE</Cidade> <Uf>UF</Uf> <Complemento /> </EnderecoMotorista> <CNHMotorista /> <ValidadeCNHMotorista /> </Motorista> </Motoristas> </Veiculo> </Veiculos> <Testemunhas> <Testemunha> <NomeTestemunha>NOME DA TESTEMUNHA</NomeTestemunha> <CpfTestemunha> </CpfTestemunha> <TelefoneFixoTestemunha> </TelefoneFixoTestemunha> <TelefoneMovelTestemunha> </TelefoneMovelTestemunha> <EnderecoTestemunha>rua ABC numero 123, bairro</enderecotestemunha> </Testemunha> </Testemunhas> <Descricao>O ônibus seguia pela rua 100 e eu condutor seguia no mesmo sentido, quando ao chegar na esquina da rua 101 parou para descer passageiros, e então engatou a marcha ré e bateu na veículo.</descricao> < >ricardofiuza007@ibest.com.br</ > <Fotos /> <ProtocoloBrat> </ProtocoloBrat> 13

14 <saldo>87</saldo> <protocolo> </protocolo> </EBRAT> </consulta> Informações de retorno: caso de erro Informações detalhadas de retorno para consultas realizadas com erro Parâmetros de retorno: caso de erro 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 Exemplo de retorno: caso de erro <?xml version="1.0" encoding="utf-8"?> <consulta> < EBRAT> <retorno>parametro invalido</retorno> <saldo>0,00</saldo> <protocolo> </protocolo> </ EBRAT> </consulta> 2.4 Parâmetros de entrada das consultas Consulta por Dados do Acidente Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário Placa Varchar 7 Não* Informar Placa para consulta Chassi Varchar 21 Não* Informar Chassi para consulta CNPJ/CPF Varchar 11/14 Não* Informar CPF/CNPJ para consulta Datas Varchar 10 Não Informar Data da ocorrência Tipo De Veículo Varchar 255 Não Informar se o veículo é o principal ou 14

15 envolvido. Preencher com: - Principal - Envolvido *Campos não são obrigatórios, mas ao menos um deles deve ser preenchido Consulta por Protocolo Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário Protocolo Varchar 20 Sim Informar Protocolo do Brat para consulta 15