Base de Dados de Veículos Roubados e Furtados RENAVAM Base Estadual. Manual do Produto Versão 2.5

Transcrição

1 Base de Dados de Veículos Roubados e Furtados RENAVAM Base Estadual Manual do Produto Versão 2.5 Junho/2017

2 Índice 1. INFORMAÇÕES GERAIS SOBRE O SERVIÇO 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 Placa e UF... 5 Consulta por Chassi e UF Exemplos Exemplo de consultas realizadas com sucesso Consulta por Placa e UF e Consulta por Chassi e UF Exemplo de retorno com erro na consulta Parâmetro Inválido Possíveis retornos com erro na consulta 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 Consulta por placa e UF e Consulta por Chassi e UF Informações de retorno: caso de erro Parâmetros de retorno: caso de erro Estrutura dos Dados Exemplo de retorno: caso de erro PARÂMETROS DE ENTRADA DAS CONSULTAS Consulta por Placa Consulta por Chassi CONSULTA EM LOTE Contexto Objetivo Consulta em Lote Considerações gerais sobre parâmetros de entrada e/ou saída Arquivo(s) de entrada Arquivo(s) de saída... 19

3 1. Informações gerais sobre o serviço 1.1 Contexto Base de dados do DETRAN, acessada via DENATRAN, para consulta sobre dados técnicos de um veículo do Estado (UF) onde o mesmo é registrado. Contém todos os dados da BIN Fabril, mais os dados de emplacamento, existência de valores de multas e inadimplência de IPVA. 1.2 Objetivo Obter e validar informações de um veículo em uma determinada UF utilizando os dados da BIN Fabril, mais os dados de emplacamento, existência de valores de multas e inadimplência de IPVA 1.3 Nome RENAVAM Base Estadual Registro Nacional de Veículos Automotores 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. Os novos usuários deverão solicitar seu acesso a um usuário já cadastrado no Canal de Atendimento ao Cliente, conforme abaixo: 3

4 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 Placa e UF Consulta por Chassi e UF Exemplos Exemplo de consultas realizadas com sucesso Consulta por Placa e UF e Consulta por Chassi e UF 5

6 6

7 Exemplo de retorno com erro na consulta Parâmetro Inválido Possíveis retornos com erro na consulta 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. 7

8 Campo <nome do campo> fora da especificação de tamanhos Indica que o campo <nome do campo> foi preenchido incorretamente 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 Chassi e UF Consulta por Placa e UF Nome da Operação ConsultaSerpro941 ConsultaSerpro 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 realizadas com sucesso Estrutura dos Dados Nome do Campo Tipo Tamanho Descrição do Campo codmetodo Char 10 Código do Método utilizado nomemetodo Char 50 Nome do Método utilizado ufjurisdicao Char 2 UF da Jurisdição ufjurisidicao Char 2 UF da Jurisdição qtdeocorrencias Char 2 Quantidade de ocorrências chassi Char 21 Chassi do Veículo codchassi Char 21 Chassi do Veículo placa Char 7 Placa do Veículo renavam Char 9 Renavam do Veículo codmodelo Char 6 Código da Marca/Modelo do Veículo marcamodelo Char 50 Descrição da Marca/Modelo do Veículo codcor Char 2 Código da cor do Veículo 8

9 nomecor Char 100 Descrição da cor do Veículo, podendo ser: 2 - AZUL 3 - BEGE 4 - BRANCA 05 - CINZA 6 - DOURADA 7 - GRENA 8 - LARANJA 9 - MARROM 10 - PRATA 11 - PRETA 12 - ROSA 13 - ROXA 14 - VERDE 15 - VERMELHA 16 - FANTASIA 0 - NAO INFORMADO 1 - AMARELA 99 - NAO INFORMADO anofabricacao Char 4 Ano de fabricação do Veículo anomodelo Char 4 Ano do modelo do Veículo codcombustivel Char 2 Código do tipo de combustível do Veículo nomecombustivel Char 50 Descrição do tipo de combustível utilizado pelo veículo, podendo ser: 0 - NAO INFORMADO 1 - ALCOOL 2 - GASOLINA 3 - DIESEL 4 - GASOGENIO 5 - GAS METANO 6 - ELETRICO/FONTE INTERNA 7 - ELETRICO/FONTE EXTERNA 8 - GASOL/GAS NATURAL COMBUSTIVEL 9 - ALCOOL/GAS NATURAL COMBUSTIVEL 10 - DIESEL/GAS NATURAL COMBUSTIVEL 11 - VIDE/CAMPO/OBSERVACAO 12 - ALCOOL/GAS NATURAL VEICULAR 13 - GASOLINA/GAS NATURAL VEICULAR 14 - DIESEL/GAS NATURAL VEICULAR 15 - GAS NATURAL VEICULAR 16 - ALCOOL/GASOLINA 17 - GASOLINA/ALCOOL/GAS NATURAL 18 - GASOLINA/ELETRICO codtipoveiculo Char 2 Código do tipo do Veículo nometipoveiculo Char 100 Nome do tipo do veículo, podendo ser: 1 - Bicicleta 2 - Ciclomotor 3 - Motoneta 9

10 4 - Motocicleta 5 - Triciclo 6 - Automovel 7 - Microonibus 8 - Onibus 9 - Bonde 10 - Reboque 11 - Semi reboque 12 - Charrete 13 - Camioneta 14 - Caminhao 15 - Carroca 16 - Carro de mao 17 - Caminhao trator 18 - Trator de rodas 19 - Trator de esteiras 20 - Trator misto 21 - Quadriciclo 22 - Chassi plataforma 23 - Caminhonete 24 - Side car 25 - Utilitario codespecie Char 1 Código da espécie do Veículo nomeespecie Char 50 Nome da espécie do Veículo, podendo ser: 0 - NAO INFORMADO 1 - PASSAGEIRO 2 - CARGA 3 - MISTO 4 - CORRIDA 5 - TRACAO 6 - ESPECIAL 7 - COLECAO codcategoria Char 2 Código da categoria do Veículo nomecategoria Char 100 Nome da categoria do Veículo, podendo ser: 1 - PARTICULAR 2 - ALUGUEL 3 - OFICIAL 4 - EXPERIENCIA 5 - APRENDIZAGEM 6 - FABRICANTE 7 - CHEFE DE MISSAO DIPLOMATICA 8 - CORPO CONSULAR 9 - ORGANISMOS INTERNACIONAIS 10 - CORPO DIPLOMATICO 11 - MISSAO/REPARTICAO/REPRESENTACAO 12 - AC.DE COOPERACAO INTERNACIONAL potencia Char 3 Potência do Veículo cilindradas Char 4 Número de Cilindradas do Veículo 10

11 nummotor Char 21 Número do motor do Veículo cxcambio Char 21 Número da caixa de câmbio do Veículo numeixotraseiro Char 21 Número de eixo Traseiro numeixoauxiliar Char 21 Número de eixo auxiliar numcarroceria Char 21 Número da carroceria do Veículo tipocarroceria Char 3 Código do tipo da carroceria do Veículo nomecarroceria Char 50 Nome do tipo da carroceria do Veículo, podendo ser: 0 - NAO INFORMADO AMBULANCIA BASCULANTE BLINDADA BOMBEIRO BUGGY CABINE DUPLA CARROCERIA ABERTA CARROCERIA FECHADA CHASSI PORTA CONTEINER CONVERSIVEL FUNERAL FURGAO JIPE KIT MOTOCICLETA/TRICICLO LIMUSINE MECANISMO OPERACIONAL MOTOR CASA PRANCHA SIDE CAR/INTERCAMBIAVEL SILO TANQUE TRAILER TRANSPORTE MILITAR TRANSPORTE DE PRESOS TRANSPORTE RECREATIVO TRANSPORTE TRABALHADORES PR.P.CONTEINER CONV.P/C.ABERTA PRANCHA PORTA CONTEINER CABINE ESTENDIDA TRIO ELETRICO DOLLY INTERCAMBI_VEL ROLLON ROLLOFF ABERTA/CABINE DUPLA ABERTA/CABINE ESTENDIDA ABERTA/CABINE SUPLEMENTAR FECHADA/CABINE DUPLA FECHADA/CABINE ESTENDIDA FECHADA/CABINE SUPLEMENTAR ABERTA/INTERCAMBIAVEL 11

12 141 - CABINE DUPLA/INACABADA MECANISMO OPERACIONAL/CAB/DUPL TRANSPORTE TORAS/MADEIRA BRUTA INACABADA/CABINE ESTENDIDA ABERTA/MECANISMO OPERACIONAL FECHADA/MECANISMO OPERACIONAL TANQUE/MECANISMO OPERACIONAL PRANCHA/MECANISMO OPERACIONAL ABERTA/MEC OPERACIONAL/C DUPLA ABERTA/MEC OPERACIONAL/C ESTEN ABERTA/MEC OPERACIONAL/C SUPL FECHADA/MEC OPERACIONAL/C DUPL FECHADA/MEC OPERACIONAL/C EST FECHADA/MEC OPERACIONAL/C SUP TANQUE/CABINE DUPLA TANQUE/CABINE ESTENDIDA TANQUE/CABINE SUPLEMENTAR TANQUE/MEC OPERACIONAL/C DUPLA TANQUE/MEC OPERACIONAL/C EST TANQUE/MEC OPERACIONAL/C SUPL ROLLON ROLLOFF/CABINE DUPLA ROLLON ROLLOFF/C ESTENDIDA ROLLON ROLLOFF/C SUPLEMENTAR BASCULANTE/CABINE DUPLA BASCULANTE/CABINE ESTENDIDA BASCULANTE/CABINE SUPLEMENTAR PRANCHA/CABINE DUPLA PRANCHA/CABINE ESTENDIDA PRANCHA/CABINE SUPL PRANCHA/MEC OPERAC/C DUPLA PRANCHA/MEC OPERAC/C ESTENDIDA PRANCHA/MEC OPERAC/C SUPLEMENT ABERTA/INTERCAMBIAVEL/CAB DUPL ABERTA/INTERCAMBIAVEL/CAB EST ABERTA/INTERCAMBIAVEL/CAB SUP ABERTA/CABINE TRIPLA FECHADA/CABINE TRIPLA COM_RCIO TRANSP GRANITO SILO/BASCULANTE BASCULANTE/MEC OPERACIONAL CHASSI CTEINER/CAB ESTENDIDA MEC OPERAC/C ESTENDIDA SILO/CABINES ESTENDIDA CONTEINER/C ABERTA/C ESTENDIDA PRANCHA CONTEINER/C ESTENDIDA TRANSP DE TORAS/C ESTENDIDA SILO/BASCULANTE/C ESTENDIDA cmtveiculo Char 5 Capacidade máxima de tração do Veículo 12

13 pbtveiculo Char 5 Peso bruto total do Veículo capacidadecarga Char 5 Capacidade de carga do Veículo cappassageiro Char 3 Capacidade de passageiros do Veículo numeroeixo Char 2 Número de eixos do Veículo tiporemarcacao Char 1 Tipo de remarcação procedencia Char 1 Procedência do Veículo nomerestricao1 Char 20 Nome da primeira restrição nomerestricao2 Char 20 Nome da segunda restrição nomerestricao3 Char 20 Nome da terceira restrição nomerestricao4 Char 20 Nome da quarta restrição datalimiteresttrib Char 8 Data Limite de Restituição Tributária tipodocprop Char 1 Tipo da documentação do Proprietário tipodocproprietario Char 1 Tipo da documentação do Proprietário identpropri Char 14 Número do documento do Proprietário numidentproprietario Char 14 Número do documento do Proprietário nomeproprietario Char 40 Nome do Proprietário situacao Char 1 Tipo da situação do Veículo debitoipva Char 1 Código do débito de IPVA debitomulta Char 1 Código do débito de Multas codmunicipio Char 4 Código do Município do Emplacamento nomecidade Char 50 Nome do Município do Emplacamento dataultimaatualiza Char 8 Data da última atualização valordebitoipva Char 8 Valor do débito de IPVA valordebitolicenc Char 8 Valor do débito de Licenciamento Valordebitomulta Char 8 Valor do débito de Multas valordebitodpvat Char 8 Valor do débito de DPVAT 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 por placa e UF e Consulta por Chassi e UF <consulta> <registro> <codmetodo>941env1 </codmetodo> <nomemetodo>consulta por Chassi e UF </nomemetodo> <ufjurisidicao>rj </ufjurisidicao> <chassi> </chassi> <placa>abc0000 </placa> <renavam> </renavam> <codmodelo> </codmodelo> <marcamodelo /> <codcor>05 </codcor> <nomecor /> 13

14 <anofabricacao>2013 </anofabricacao> <anomodelo>2013 </anomodelo> <codcombustivel>16 </codcombustivel> <nomecombustivel /> <codtipoveiculo>06 </codtipoveiculo> <nometipoveiculo /> <codespecie>1 </codespecie> <nomeespecie /> <codcategoria>01 </codcategoria> <nomecategoria /> <potencia>104 </potencia> <cilindradas>1598 </cilindradas> <nummotor>aaaa00000 </nummotor> <cxcambio /> <numeixotraseiro /> <numeixoauxiliar /> <numcarroceria /> <tipocarroceria>999 </tipocarroceria> <nomecarroceria /> <cmtveiculo>00000 </cmtveiculo> <pbtveiculo>00000 </pbtveiculo> <capacidadecarga>00000 </capacidadecarga> <cappassageiro>000 </cappassageiro> <numeroeixo>02 </numeroeixo> <tiporemarcacao>2 </tiporemarcacao> <procedencia>1 </procedencia> <nomerestricao1>alienacao FIDUCIARIA </nomerestricao1> <nomerestricao2 /> <nomerestricao3 /> <nomerestricao4 /> <datalimiteresttrib> </datalimiteresttrib> <tipodocproprietario>1 </tipodocproprietario> <numidentproprietario> </numidentproprietario> <nomeproprietario>nome PROPRIETARIO </nomeproprietario> <situacao>s </situacao> <debitoipva>0 </debitoipva> <debitomulta>0 </debitomulta> <codmunicipio>6001 </codmunicipio> <nomecidade /> <dataultimaatualiza> </dataultimaatualiza> <valordebitoipva /> <valordebitolicenc /> <valordebitomulta /> <valordebitodpvat /> <saldo>0,00 </saldo> <protocolo> </protocolo> </registro> </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 Código Retorno Retorno 001 Nenhum registro encontrado 003 Existem mais registros do que o previsto para essa consulta 14

15 017 Veículo não cadastrado e com ocorrência de roubo/furto 018 Veículo não cadastrado e com sinalização de alarme 019 Veículo cadastrado e com sinalização de alarme 048 Veículo cadastrado e com ocorrência de roubo/furto 054 Número do documento de identificação do proprietário inválido 065 Código do Renavam inválido 075 UF Jurisdição inválida 076 Placa inválida 077 Chassi inválido 085 Não foi possível conexão com a UF de origem 087 Código órgão de Segurança Invalido 088 UF Boletim ocorrência invalido 089 Número do boletim de ocorrência invalido 090 Ano boletim ocorrência invalido 096 Categoria da ocorrência invalido Acesso não permitido para o IP Campo <nome do campo> fora da especificação de tamanhos Cliente já utilizou todas as consultas do Contrato de Experiência de Uso para esse método Cliente não possui crédito disponível Cliente não possui permissão para o método Contrato inativo ou fora do período de vigência Erro na aplicação Método inválido Não há retorno para esta consulta Parâmetro inválido Produto em desenvolvimento Produto inválido Sua consulta não foi realizada, entre em contato com o suporte Usuário ou Senha Inválido Estrutura dos Dados Nome do Campo Tipo Tamanho Descrição do Campo codmetodo Char 10 Código do Método utilizado nomemetodo Char 50 Nome do Método utilizado codret Char 3 Código de erro mensagem Char 50 Mensagem de erro protocolo Char 20 Número de protocolo da consulta saldo Decimal 13,2 Saldo só deve ser considerado para contratos Pré-pago Exemplo de retorno: caso de erro <consulta> 15

16 <registro> <codmetodo>942env1 </codmetodo> <nomemetodo>consulta por Placa e UF </nomemetodo> <codret> </codret> <mensagem>parâmetro inválido </mensagem> <saldo>96 </saldo> <protocolo> </protocolo> </registro> </consulta> 2.4 Parâmetros de entrada das consultas Consulta por Placa 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 IdUF Varchar 2 Sim UF para consulta IdPlaca Varchar 10 Sim Placa para consulta Consulta por Chassi 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 IdUF Varchar 2 Sim UF para consulta IdChassi Varchar 10 Sim Chassi para consulta 2.5 Consulta em Lote Contexto A Consulta em Lote armazena em arquivo único o resultado obtido de um montante de consultas feitas ao Portal de Serviços e Soluções Objetivo Disponibilizar resultado de consultas sequenciais feitas ao Portal de Serviços e Soluções em arquivo consolidado. 16

17 2.5.3 Consulta em Lote O Módulo pode ser acessado seguindo os seguintes passos: Efetuar Log In no Portal de Serviços e Soluções 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 de Serviços e Soluções (Caso ainda não esteja logado). Acessar a opção de menu superior Lote Acessar a opção de menu lateral Pesquisar em lote 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 exige mais parâmetros de entrada. Neste caso, os parâmetros devem ser separados por ; Ponto e Vírgula ) Arquivo(s) de entrada Todo arquivo de entrada deve ter por padrão, apenas um parâmetro por linha. Ex.: Nome do arquivo xxxxxxxxxx.txt ou yyyyyyyyyyy.csv KYT6013 KQL1309 LJB5663 Em caso de utilizar os dois parâmetros: KYT6013;9BFZF55P8B LJB5663; 9BGTB11NNNC Após a última linha do arquivo, tanto no Excel quanto no.txt, não pode conter ENTER, senão, será considerada como uma nova linha e o sistema sinalizará como inconsistência na quantidade de linhas informadas. 17

18 No produto RENAVAM BASE ESTADUAL, as consultas podem ser por UF e Placa (como mostrado no exemplo) ou por UF e Chassi. Verificar se a informação de número de linhas está correta, selecionar a opção de acordo e enviar. Após processado poderá ser realizado o download do arquivo final. Selecionar o link indicado pela seta, onde consta o protocolo do arquivo enviado. 18

19 Realizar o download do arquivo no local indicado pela seta 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. Para isto, salve o arquivo final 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: 19

20 3º passo: Clicar em OK, abrirá um arquivo xml, para abri-la em Excel, arraste o arquivo xml para dentro de uma planilha Excel. Seu processamento aparecerá com o formato habitual do Excel, separado por colunas. 20