Portaria DETRAN/RS nº 471 DE 26/10/2015

Norma Estadual - Rio Grande do Sul - Publicado no DOE em 26 out 2015

Dispõe sobre o sistema de filmagem de aulas práticas e exames práticos de direção veicular do processo de habilitação de condutores.

O Diretor-Geral do Departamento Estadual de Trânsito do Estado do Rio Grande do Sul - DETRAN/RS, no exercício da competência que lhe foi conferida pelo art. 6º da Lei Estadual nº 10.847/1996, c/c o art. 5º da Lei Estadual nº 14.479/2014, e;

Considerando a competência estabelecida no art. 22, inciso II, da Lei Federal nº 9.503/1997, que institui o Código de Trânsito Brasileiro - CTB - e atribui ao Órgão Executivo Estadual de Trânsito a realização, fiscalização e controle do processo de habilitação de condutores;

Considerando o disposto na Resolução CONTRAN nº 168/2004;

Considerando o disposto na Resolução CONTRAN nº 361/2010;

Considerando a Portaria DENATRAN nº 238/2014;

Considerando a disponibilidade de novas tecnologias que incorporadas ao processo de habilitação possibilitem sua qualificação e segurança;

Considerando o contido no expediente SPI nº 00408-24.44/12-1 que trata do Sistema de Prova Prática Eletrônica;

Considerando, por fim, o contido no SPD nº 8772/2015.

Resolve:

Art. 1º Instituir, no âmbito do Departamento Estadual de Trânsito do Rio Grande do Sul - DETRAN/RS, o sistema de filmagem de aulas práticas e exames práticos de direção veicular do processo de habilitação de condutores.

§ 1º O sistema previsto no caput deste artigo aplica-se as aulas e os exames práticos de direção veicular das categorias A, B, C, D, e E, bem como para a obtenção da Autorização para Conduzir Ciclomotores - ACC. (Redação do parágrafo dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017).

Nota: Redação Anterior:
§ 1º O sistema previsto no caput deste artigo aplica-se a aulas e exames práticos de direção veicular de categoria B, C, D, e E.

§ 2º O sistema de filmagem compreende áudio e vídeo.

§ 3º Nas aulas e nos exames práticos de direção veicular para habilitação na categoria A, bem como para obtenção de Autorização para Conduzir Ciclomotores - ACC - o monitoramento de que trata o caput será realizado através da filmagem panorâmica das Pistas de Motos. (Parágrafo acrescentado pela Portaria DETRAN/RS Nº 336 DE 26/07/2017).

Art. 2º A filmagem das aulas será responsabilidade dos Centros de Formação de Condutores - CFCs, podendo o conjunto de imagens ser utilizado pelo DETRAN/RS para fins de supervisão, fiscalização e auditoria.

Art. 3º O sistema de filmagem implantado pelos CFCs deverá gerar obrigatoriamente informações sobre as aulas ministradas, as quais integrarão o Relatório Eletrônico de Aulas, nos termos do art. 4º da Portaria DENATRAN nº 238/2014.

I - Identificação do candidato, do instrutor de trânsito e do Centro de Formação de Condutores.

II - Dados do veículo de aprendizagem, incluindo quilometragem inicial e final e horário de início e término da aula.

III - identificação detalhada do percurso realizado pelo candidato em cada aula, incluindo o(s) horário(s), exceto para a categoria A e ACC; (Redação do inciso dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017);

Nota: Redação Anterior:
III - Identificação detalhada do percurso realizado pelo candidato em cada aula, incluindo o(s) horário(s).

IV - Detalhamento do desempenho do candidato.

V - Avaliação do conhecimento do candidato sobre as normas de circulação, conduta e infrações estabelecidas pelo Código de Trânsito Brasileiro e Resoluções do Conselho Nacional de Trânsito.

VI - Infrações de trânsito e faltas porventura cometidas durante o processo de aprendizagem, com identificação precisa dos dispositivos previstos no Código de Trânsito Brasileiro e na Resolução CONTRAN nº 168/2004.

VII - Observações adicionais que venham a ser estabelecidas pelo Órgão Executivo Estadual de Trânsito.

§ 1º As informações que integrarão o Relatório Eletrônico de Aulas deverão ser enviadas e registradas nos sistemas informatizados do DETRAN/RS pertinentes à habilitação de condutores nos termos do descritivo técnico constante no Anexo I desta Portaria.

§ 2º As imagens do mapa com o trajeto percorrido, das fotografias aleatórias do candidato e os registros efetuados pelo instrutor durante as aulas, ficarão armazenados pelo fornecedor da solução e disponibilizados para acesso do DETRAN/RS através de links de internet, com controle de acesso - usuário e senha - pelo prazo de um ano, período de duração do processo de habilitação.

§ 3º Os arquivos da filmagem das aulas, compreendendo áudio e vídeo, deverão ser armazenados pelo prazo de 20 (vinte) dias, e poderão ser requisitados para acesso e visualização pelo DETRAN/RS, sendo o CFC responsável pelo encaminhamento quando solicitado. (Redação do parágrafo dada pela Portaria DETRAN/RS Nº 321 DE 22/06/2018).

Nota: Redação Anterior:
§ 3º Os arquivos da filmagem das aulas, compreendendo áudio e vídeo, deverão ser armazenados pelo prazo de 30 dias, e poderão ser requisitados para acesso e visualização pelo DETRAN/RS, sendo o CFC responsável pelo envio das imagens quando solicitado.

§ 4º A solução deverá contemplar a captura de, no mínimo, 05 (cinco) fotografias aleatórias do candidato durante a aula, exceto para a categoria A e ACC onde deverá haver captura de 02 (duas) fotografias do candidato, sem capacete, e 02 (duas) fotografias do instrutor, uma no início e outra no final da aula utilizando o tablet. (Redação do parágrafo dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017).

Nota: Redação Anterior:
§ 4º A solução deverá contemplar a realização de, no mínimo, 05 (cinco) fotografias aleatórias do candidato durante a aula.

§ 5º As integrações sistêmicas para sincronização de horário dos dispositivos móveis deverão atender aos termos do descritivo técnico constante do Anexo II desta Portaria.

Art. 4º A especificação técnica do sistema eletrônico de anotação, transmissão e recepção dos relatórios de avaliação elaborados pelos instrutores relativos às aulas de prática de direção veicular ministradas aos pretendentes à obtenção do documento de habilitação deverá seguir o constante do Anexo da Portaria DENATRAN nº 238/2014.

Art. 5º A filmagem de exames práticos de direção veicular será realizada através da solução contratada pelos CFCs, com resguardo de sigilo, sendo os arquivos da filmagem, compreendendo áudio e vídeo, propriedade do Órgão Executivo Estadual de Trânsito, devendo ser armazenados pelo prazo de 90 (noventa) dias e, após, ser imediatamente excluídos, ficando sob a responsabilidade do CFC o sigilo, a guarda e envio das imagens na forma e critérios estabelecidos pelo DETRAN/RS. (Redação do caput dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
Art. 5º A filmagem de exames práticos de direção veicular será realizada através da solução contratada pelos CFCs, sendo os arquivos da filmagem, compreendendo áudio e vídeo, propriedade do Órgão Executivo Estadual de Trânsito, devendo ser enviados ao DETRAN/RS no prazo de 24 horas após o término do exame, no formato a ser estabelecido posteriormente.

§ 1º O sistema de filmagem deverá ser integrado ao aplicativo PPE - Provas Práticas Eletrônicas, de propriedade do DETRAN/RS, durante execução dos exames práticos de direção veicular, nos termos estabelecidos no Anexo III desta Portaria.

§ 2º Para a utilização e melhor desempenho do aplicativo PPE, os dispositivos móveis a serem utilizados pelo sistema de filmagem deverão atender aos requisitos mínimos estabelecidos no Anexo IV desta Portaria.

§ 3º A solução deverá suportar distância de até 06 (seis) metros sem que haja interrupção da conectividade entre os equipamentos do sistema de filmagem e o dispositivo móvel (tablet).

§ 3º A solução deverá suportar distância de até 10 metros sem que haja interrupção da conectividade entre os equipamentos do sistema de filmagem e o dispositivo móvel (tablet). (Redação do parágrafo dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Art. 6º O sistema de filmagem de aulas práticas e exames práticos de direção veicular deverá contemplar a integração com o controle biométrico, estabelecido na Resolução CONTRAN nº 361/2010 , sendo que o cadastro e a validação da impressão digital ficarão a cargo do DETRAN/RS ou de empresa por esse designada. (Redação do artigo dada pela  Portaria DETRAN/RS Nº 531 DE 20/11/2015).

Nota: Redação Anterior:
Art. 6º O sistema de filmagem de aulas práticas e exames práticos de direção veicular deverá contemplar a integração com o controle biométrico, estabelecido na Resolução CONTRAN nº 361/2010.

Art. 7º O sistema de filmagem de aulas práticas e exames práticos de direção veicular, para fins de monitoramento e controle, será composto pelos seguintes equipamentos: (Redação do caput dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017):

Nota: Redação Anterior:
Art. 7º O sistema de filmagem de exames práticos de direção veicular será composto pelos seguintes equipamentos: (Redação do caput dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).
Nota: Redação Anterior:
Art. 7º O sistema de filmagem de aulas práticas e exames práticos de direção veicular será composto pelos seguintes equipamentos:

I - 1 (um) dispositivo móvel (tablet);

II - 1 (um) suporte veicular para tablet;

III - 1 (um) leitor biométrico;

IV - no mínimo, 1 (uma) câmera de vídeo interna, na parte superior frontal do veículo, com foco no candidato e instrutor/examinador de trânsito, de forma a permitir o monitoramento do procedimento, exceto para categoria A e para obtenção de ACC que observam o disposto no parágrafo único deste artigo. (Redação do inciso dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017).

Nota: Redação Anterior:
IV - no mínimo, 4 (quatro) câmeras de vídeo, dispostas da seguinte forma:

a) 1 (uma) câmera interna, na parte superior frontal do veículo, com foco no candidato e instrutor/examinador de trânsito.

b) 1 (uma) câmera interna, com foco nos pedais do instrutor/examinador de trânsito.

c) 1 (uma) câmera, na parte superior frontal do veículo, com foco no trajeto.

d) 1 (uma) câmera externa, no retrovisor direito, com foco na lateral do veículo, permitindo a visualização do meio-fio.

V. 1 (um) equipamento DVR -Digital Video Recorder. (Inciso acrescentado pela Portaria DETRAN/RS Nº 531 DE 20/11/2015).

Parágrafo único. Nas categorias A e para obtenção de ACC o cumprimento do disposto no caput dar-se-á com filmagem panorâmica das Pistas de Motos, nas quais deverão ser instalada(s) a(s) câmera(s) necessária(s) ao monitoramento, de forma a abranger todo o percurso e as manobras realizadas pelo candidato à habilitação. (Parágrafo acrescentado pela Portaria DETRAN/RS Nº 336 DE 26/07/2017).

Art. 8º A especificação técnica mínima dos equipamentos componentes da solução consta do Anexo IV desta Portaria, sendo de responsabilidade do fornecedor que esses permitam a integração com os sistemas informatizados da Autarquia, bem como o uso do sistema de filmagem sem lentidão ou paradas indesejadas.

Art. 9º A autorização da solução será de responsabilidade do DETRAN/RS e as empresas fornecedoras, a serem contratadas pelos CFCs, deverão submeter-se ao plano de testes da Autarquia.

Art. 10. Os Centros de Formação de Condutores - CFCs - são responsáveis pelo pleno funcionamento e integração do sistema de filmagens durante aulas práticas e exames práticos de direção veicular, condição para a realização dos mesmos, devendo contratar fornecedor que atenda ao disposto nesta Portaria, cuja solução esteja devidamente autorizada pelo DETRAN/RS.

Nota: O prazo constante no artigo 11 passa a contar a partir da publicação desta Portaria DETRAN/RS Nº 531 DE 20/11/2015.

Art. 11. O sistema de filmagem de aulas práticas e exames práticos de direção veicular deverá estar operante no prazo de até 120 (cento e vinte) dias, a partir da data da publicação desta Portaria.

Art. 12. As empresas autorizadas para fornecimento da solução, objeto desta Portaria, poderão integrar seus sistemas com demais sistemas de gestão dos CFCs.

Art. 13. Esta Portaria entra em vigor na data de sua publicação.

Ildo Mário Szinvelski,

Diretor-Geral.

(Redação do anexo dada pela Portaria DETRAN/RS Nº 189 DE 29/04/2019):

ANEXO ÚNICO SERVIÇOS DE INTEGRAÇÃO DE AULAS PRÁTICAS

Este documento tem por objetivo a definição de especificações e serviços para as integrações necessárias entre os softwares de aulas práticas utilizados em Centros de Formação de Condutores e os sistemas corporativos do DETRAN/RS.

Obs.: Grandes volumes de envio de aulas práticas deverão ser realizados no período entre 20 horas e 07 horas.

Aulas prioritárias poderão ser enviadas a qualquer momento.

Característica Descrição
Padrão da mensagem A Integração se dará com serviços WEB HTTP desenvolvidos e hospedados na PROCERGS, utilizando a arquitetura REST (Representational State Transfer).
REST Conceitos: http://pt.wikipedia.org/wiki/REST
HTTP STATUS http://pt.wikipedia.org/wiki/Anexo:Lista_de_códigos_de_status_HTTP
Meio de comunicação Internet
Padrão de troca de mensagens Troca de mensagens no formato texto através do content-type JSON (Javascript Object Notation).
Autorização de acesso DETRAN/RS vai fornecer os dados para acesso para cada empresa que desejar fazer a integração.
Serviços previstos 1. Serviço para agendar aula prática e obter os tickets de biometria;
2. Serviço para obter LADV Eletrônica;
3. Serviço para incluir aula prática;
4. Serviço para excluir aula prática;
5. Serviço para listar aulas práticas em situação de inconformidade;
6. Serviço para consultar dados de uma aula prática.
Falhas no recebimento Somente o retorno do serviço com HTTP.STATUS = 200 é garantia do recebimento da aula prática com sucesso.
Outros status ou se não houver retorno do sistema do DETRAN/RS (Ex: devido algum erro de conexão, timeout, etc), deve ser realizada uma nova tentativa de envio dos dados.

1) SERVIÇO PARA AGENDAR A AULA PRÁTICA E OBTER OS TICKETS DE BIOMETRIA

1. O sistema solicita a inclusão.

2. DETRAN/RS: valida a solicitação de inclusão. Aceita ou rejeita a inclusão com base nas validações básicas.

3. Exemplo de uso:

URL HTTP:

https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/aulaPratica/agenda

Método HTTP:

@POST

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

"idAulaPratica": "1",

"cfc": "CHC99999",

"renach": "RS999999999",

"cpfAluno": "99999999999",

"cpfInstrutor": "99999999999",

"turno": "D",

"dthIniAula": "9999-99-99 99:99",

"dthFimAula": "9999-99-99 99:99",

"cargaHoraria":"1",

"categoria": "B",

"placa": "XXX9999", }

Descrição do envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem Código único de aula na empresa
cfc Alfa 8 S Código do credenciado Ex.: CHC99999
renach Alfa 11 N RENACH do aluno Ex.: RS999999999
cpfAluno Alfa 11 S CPF do Aluno  
cpfInstrutor Alfa 11 S CPF do Instrutor  
turno Alfa 1 S Turno da aula D - Diurno N - Noturno
dthIniAula Alfa 16 S Data/Hora do início da aula yyyy-MM-dd HH:mm
dthFimAula Alfa 16 S Data/Hora do fim da aula yyyy-MM-dd HH:mm
cargaHoraria Numérico 1 S Carga horária da aula, que pode ser 1 hora aula ou 2 horas aula - 50 minutos - 100 minutos
categoria Alfa 4 S Categoria pretendida A, ACC, B, C, D ou E
placa Alfa 7 S Placa do veículo Ex.: IAM1234

Descrição do retorno:

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 200 retorna o ticket da aula agendada (para posterior envio no serviço de inclusão de aula), eventuais alertas e a lista de tickets de biometria no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
ticketAulaAgendada Numérico 12 S Ticket da aula, gerado pela PROCERGS no agendamento da aula/geração tickets de biometria Este ticket deve ser enviado no serviço de inclusão de aulas práticas.
listaAlertas       Tabela com os alertas da aula  
  codMsg Alfa 8 N    
  txtMsg Alfa 200 N    
listaTickets     N Tabela com os tickets de biometria que serão usados na aula. Se o biometria não estiver implantada no CFC, então esta lista estará vazia.
  ticket Numérico 12 S Ticket de biometria  
  evento Numérico 2 S Momento em que o ticket deverá ser utilizado 25-aluno no início 26-aluno no fim instrutor no início instrutor no fim
  renach Alfa 11 N RENACH do aluno  
  renach_img Alfa 11 N RENACH do aluno que contem imagens na C - E.D. Utilizar este campo para fazer a verificação biométrica
  cpfInstrutor Numérico 11 N CPF do instrutor  
  maxTentativas Numérico 2 S Quantidade máxima de dedos que poderão ser
validados
 
  maxErros Numérico 2 S Quantidade de vezes que um mesmo dedo poderá ser validado  
  ordenacao Numérico 1 S Ordem em que os dedos serão solicitados melhor qualidade último usado

Exemplo ilustrativo:

{"

ticketAulaAgendada":999999999,

"listaAlertas":[

{"codMsg": "S600",

"txtMsg": "LADV não encontrada para o RENACH",

"listaTickets":[

"ticket":12345,

"evento":25,

"renach": "RS999999999",

"renach_img": "RS888888888",

"cpf_instrutor":null,

"maxTentativas":3,

"maxErros":2,

"ordenacao":0,

"ticket":12346,

"evento":26,

"renach": "RS999999999",

"renach_img": "RS888888888",

"cpf_instrutor":null,

"maxTentativas":2,

"maxErros":1,

"ordenacao":1,

"ticket":12347,

"evento":27,

"renach":null,

"renach_img":null,

"cpf_instrutor":99999999999,

"maxTentativas":3,

"maxErros":2,

"ordenacao":0,

"ticket":12348,

"evento":28,

"renach":null,

"renach_img":null,

"cpf_instrutor":99999999999,

"maxTentativas":2,

"maxErros":1,

"ordenacao":1,

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = E001

msgErro = Identificação da aula deve ser informada.

2. SERVIÇO PARA OBTER LADV ELETRÔNICA

1. O sistema solicita a consulta da imagem da LADV eletrônica.

2. DETRAN/RS: valida solicitação e aceita ou rejeita a ação, com base nas validações do sistema. A validação ocorre com base na data em que está sendo feita a ação.

3. Exemplo de uso:

URL HTTP:

https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/aulaPratica/ladv

Método HTTP:

@GET

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

"cfc": "CHC99999",

"renach": "RS999999999",

"cpfAluno": "99999999999"

Descrição do envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
cfc Alfa 8 S Código do credenciado cliente da empresa de filmagem Ex.: CHC99999
renach Alfa 11 S RENACH do aluno Ex.: RS999999999
cpfAluno Alfa 11 S CPF do aluno  
ladvID Numérico 11 N Código da LADV Quando informado, será validada a LADV solicitada. Neste caso não é devolvido o arquivo base64.

Descrição do retorno:

Status http Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 200 retorna uma lista de inconformidades conforme descrito abaixo, no formato JSON.

Campo Tipo Descrição Obs.
renach Alfa RENACH do aluno Ex.: RS999999999
categoria2Rodas Alfa Categoria 2 rodas da LADV  
categoria4Rodas Alfa Categoria 4 rodas da LADV  
dthEmissao Alfa Data/Hora da emissão da LADV yyyy-MM-dd HH:mm
dtValidade Alfa Data/Hora do fim da aula yyyy-MM-dd
ladvID Numérico Código da LADV  
ladv Alfa LADV eletrônica Arquivo PNG Codificação base64

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = S600

msgErro = LADV venceu antes da data informada

3. SERVIÇO PARA INCLUIR UMA AULA PRÁTICA

1. O sistema solicita a inclusão.

2. DETRAN/RS: valida a solicitação de inclusão. Aceita ou rejeita a inclusão com base nas validações básicas.

3. Exemplo de uso:

URL HTTP:

https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/aulaPratica

Método HTTP:

@POST

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

{"

ticketAulaAgendada":999999999

"imei": "123456789123456",

"idAulaPratica": "1",

"cfc": "CHC99999",

"cpfAluno": "99999999999",

"cpfInstrutor": "99999999999",

"turno": "D",

"viaAula": "R",

"dthIniAula": "9999-99-99 99:99",

"dthFimAula": "9999-99-99 99:99",

"cargaHoraria": "1",

"categoria": "B",

"placa": "XXX9999",

"kmInicial": "100",

"kmFinal": "120",

"situacao": "1",

"origem": "1",

"indAdaptado": "0",

"justificativaAula": "",

"observacao":"OBS",

"indForaSede": "0",

"linkMapa": "http://empresa.com.br/mapa/id=1",

"linkVideo": "http://empresa.com.br/video/id=1",

"linkImagem": "http://empresa.com.br/imagem/id=1",

"qtdEventos": "2",

"listaEventos":[{"tipoEvento": "01","codEvento": "1001","dthEvento": "2015.06.05 10:31:12","observacao": "evento teste 1"},

{"tipoEvento": "01","codEvento": "1002","dthEvento": "2015.06.05 10:33:55","observacao": "evento teste 2"}]}

Descrição do envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
ticketAulaAgendada Numérico 12 N Ticket da aula, gerado pela PROCERGS no agendamento da aula/geração tickets de biometria Enviar este atributo quando a aula prática for com biometria.
imei Alfa 18 S Código do Equipamento Se não houver imei, enviar identificação única do equipamento
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem Código único de aula na empresa
cfc Alfa 8 S Código do credenciado Ex.:
CHC99999
cpfAluno Alfa 11 S CPF do Aluno  
cpfInstrutor Alfa 11 S CPF do Instrutor  
turno Alfa 1 S Turno da aula D - Diurno N - Noturno
viaAula Alfa 1 S Via da aula R - Rodovia U - Urbana
dthIniAula Alfa 16 S Data/Hora do início da aula yyyy-MM-dd HH:mm
dthFimAula Alfa 16 S Data/Hora do fim da aula yyyy-MM-dd HH:mm
cargaHoraria Numérico 1 S Carga horária da aula, que pode ser 1 hora aula ou 2 horas aula 1 - 50 minutos 2 - 100 minutos
categoria Alfa 4 S Categoria pretendida A, ACC, B, C, D ou E
placa Alfa 7 S Placa do veículo Ex.: IAM1234
kmInicial Numérico 9 S Quilometragem do veículo no início da aula  
kmFinal Numérico 9 S Quilometragem do veículo no fim da aula  
situacao Numérico 1 S - realizada - Atendeu todos os requisitos - incompleta - Não atendeu o requisito do tempo 1 - realizada
2 - incompleta Aulas realizadas e incompletas devem ser enviadas para o DETRAN. Situação incompleta exige justificativa.
origem Numérico 1 S - Aula com registro automático no dispositivo móvel/Camada Cliente - Aula com registro manual no sistema Web/Camada Servidor 1 - Automático 2 - Manual (contingência)
indAdaptado Numérico 1 S Aula realizada para condutores que necessitam de veículos adaptados - Não - Sim
justificativaAula Alfa 500 N Motivo da aula ter sido interrompida (situação incompleta) ou motivo do registro em contingência manual (origem manual) Obrigatório quando situação incompleta ou aulas enviadas em contingência
observacao Alfa 500 N Observações do Instrutor sobre a aula  
indForaSede Numérico 1 S   - aula na sede - aula em município fora da sede
linkMapa Alfa 100 S Link internet do mapa
do percurso da aula
Campo opcional
para categoria A e ACC. Senha de acesso deve ser fornecido ao DETRAN/RS
linkVideo Alfa 100 S Link internet da filmagem da aula Senha de acesso deve ser fornecido ao DETRAN/RS
linkImagem Alfa 100 S Link internet das imagens aleatórias da aula Campo opcional para categoria A e ACC. Senha de acesso deve ser fornecido ao DETRAN/RS
qtdEventos Númérico 4 S Quantidade de eventos sendo enviados na lista  
listaEventos     S Tabela com os eventos ocorridos na aula. Devem ser informados infrações e erros.  
dthEvento Alfa 19 S Data/Hora do evento yyyy-MM-dd HH:mm:ss
tipoEvento Alfa 2 S Tipo do evento que pode corresponder ao conteúdo pedagógico, infração e outros... Os tipos de eventos são fornecidos pelo DETRAN/RS
codEvento Alfa 8 S Código do evento que pode corresponder ao conteúdo pedagógico, infração e outros. Os códigos de eventos são fornecidos pelo DETRAN/RS
observacao Alfa 500 N Observação sobre o evento Obrigatório quando no evento de comportamento foi informado "Outros"
         

Descrição do retorno:

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = F007

msgErro = Placa Inválida

4. SERVIÇO PARA EXCLUIR UMA AULA PRÁTICA

1. O sistema solicita a exclusão de uma aula prática.

2. DETRAN/RS: valida solicitação e aceita ou rejeita a ação, com base nas validações do sistema.

3. Exemplo de uso:

URL HTTP:

https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/aulaPratica

Método HTTP:

@DELETE

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

"idAulaPratica": 1,

"cfc": "CHC99999",

"cpfAluno": "99999999999"

"motivo": "Exclusão de aula incompleta devido a problema técnico"

Descrição do envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem  
cfc Alfa 8 S Código do credenciado Ex.: CHC99999
cpfAluno Alfa 11 S CPF do Aluno Ex.: 99999999999
motivo Alfa 500 S Motivo da exclusão da aula  

Descrição do retorno:

Status http Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = E001

msgErro = Identificação da aula deve ser informada

5. SERVIÇO PARA LISTAR AS AULAS PRÁTICAS EM SITUAÇÃO DE INCONFORMIDADE

1. O sistema solicita a lista de aulas práticas em inconformidade.

2. DETRAN/RS: valida solicitação e aceita ou rejeita a ação, com base nas validações do sistema.

3. Exemplo de uso:

URL HTTP:

https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/aulaPratica/listaInconformidade

Método HTTP:

@GET

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

"cfc": "CHC99999",

"dtPeriodoInicio": "2017.01.01",

"dtPeriodoFim": "2017.01.07",

Descrição do envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
cfc Alfa 8 S Filtro código do credenciado cliente da empresa de filmagem Ex.: CHC99999
dtPeriodoInicio Alfa 10 S Filtro período inicial yyyy-MM-dd
dtPeriodoFim Alfa 10 S Filtro período final yyyy-MM-dd

Descrição do retorno:

Status http Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 200 retorna uma lista de inconformidades conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem Código único de aula na empresa
cpfAluno Alfa 11 S CPF do Aluno  
cpfInstrutor Alfa 11 S CPF do Instrutor  
dthIniAula Alfa 16 S Data/Hora do início da aula yyyy-MM-dd HH:mm
dthFimAula Alfa 16 S Data/Hora do fim da aula yyyy-MM-dd HH:mm
placa Alfa 7 S Placa do veículo Ex.: IAM1234
txtInconformidade Alfa 4000 S Texto com a inconformidade da aula prática  

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = E001

msgErro = Identificação da aula deve ser informada

6. SERVIÇO PARA CONSULTAR DADOS DE UMA AULA PRÁTICA

1. O sistema solicita a consulta de dados de uma aula prática.

2. DETRAN/RS: valida solicitação e aceita ou rejeita a ação, com base nas validações do sistema.

3. Exemplo de uso:

URL HTTP:

https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/aulaPratica

Método HTTP:

@GET

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

"idAulaPratica": 1,

"cfc": "CHC99999",

"cpfAluno": "99999999999"

Descrição do envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem  
cfc Alfa 8 S Código do credenciado cliente da empresa de filmagem Ex.: CHC99999
cpfAluno Alfa 11 S CPF do Aluno Ex.: 99999999999

Descrição do retorno:

Status http Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 200 retorna uma lista de inconformidades conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem Código único de aula na empresa
cpfAluno Alfa 11 S CPF do Aluno  
cpfInstrutor Alfa 11 S CPF do Instrutor  
dthIniAula Alfa 16 S Data/Hora do início da aula yyyy-MM-dd HH:mm
dthFimAula Alfa 16 S Data/Hora do fim da aula yyyy-MM-dd HH:mm
turno Alfa 1 S Turno da aula D - Diurno N - Noturno
viaAula Alfa 1 S Via da aula R - Rodovia U - Urbana
cargaHoraria Numérico 1 S Carga horária da aula, que pode ser 1 hora aula ou 2 horas aula - 50 minutos - 100 minutos
categoria Alfa 4 S Categoria pretendida A, ACC, B, C, D ou E
placa Alfa 7 S Placa do veículo Ex.: IAM1234
kmInicial Numérico 9 S Quilometragem do veículo no início da aula  
kmFinal Numérico 9 S Quilometragem do veículo no fim da aula  
situacaoAula Detran Numerico 2 S Situação da aula no sistema do Detran 3 - Aguardando processamento
4- Inconformidade
6 - Registrada
8 - Aula cancelada
10 - Incompleta
11 - Aguardando homologação
12 - Rejeitada
14 - Excluída
15 - Inutilizada
txtInconformidade Alfa 4000 N Texto com a inconformidade da aula prática  

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = E001

msgErro = Identificação da aula deve ser informada

Nota: Redação Anterior:

(Redação do anexo dada pela Portaria DETRAN/RS Nº 675 DE 21/12/2018):

ANEXO ÚNICO

Nota: Redação Anterior:

(Redação do anexo dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017):

ANEXO I

Serviço de Integração de Aulas Práticas Este documento tem por objetivo a definição de especificações e serviços para as integrações necessárias entre os softwares de aulas práticas utilizados em Centros de Formação de Condutores e os sistemas corporativos do DETRAN/RS.

Característica Descrição
Padrão da mensagem A Integração se dará com serviços WEB HTTP desenvolvidos e hospedados na PROCERGS, utilizando a arquitetura REST (Representational State Transfer).
REST Conceitos: http://pt.wikipedia.org/wiki/REST
HTTP STATUS http://pt.wikipedia.org/wiki/Anexo:Lista_de_códigos_de_status_HTTP
URL de acesso https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/aulaPratica
Meio de comunicação Internet
Padrão de troca de mensagens Troca de mensagens no formato texto através do content-type JSON (Javascript Object Notation).
Autorização de acesso DETRAN/RS vai fornecer os dados para acesso para cada empresa que desejar fazer a integração.
Serviços previstos Incluir uma aula prática Excluir uma aula prática Listar aulas práticas em inconformidades Consultar a situação de uma aula prática
Falhas no recebimento Somente o retorno do serviço com HTTP.STATUS = 200 é garantia do recebimento da aula prática com sucesso.
Outros status ou se não houver retorno do sistema do DETRAN/RS (Ex: devido algum erro de conexão, timeout, etc), deve ser realizada uma nova tentativa de envio dos dados.

1) Serviço para incluir uma aula prática

1.1) O sistema solicita a inclusão.

1.2) DETRAN/RS: valida a solicitação de inclusão. Aceita ou rejeita a inclusão com base nas validações básicas.

1.3) Exemplo de uso:

Método HTTP:

@POST

Headers HTTP

organizacao: NomeEmpresa matricula: 99999999

senha: x9x9x9x Parâmetros:

"imei":"123456789123456",

"idAulaPratica":"1",

"cfc":"CHC99999",

"cpfAluno":"99999999999",

"cpfInstrutor":"99999999999",

"turno":"D",

"viaAula":"R",

"dthIniAula":"9999-99-99 99:99",

"dthFimAula":"9999-99-99 99:99",

"cargaHoraria":"1",

"categoria":"B",

"placa":"XXX9999",

"kmInicial":"100",

"kmFinal":"120",

"situacao":"1",

"origem":"1",

"indAdaptado":"0",

"justificativaAula":"",

"observacao":"OBS",

"indForaSede":"0",

"linkMapa":"http://empresa.com.br/mapa/id=1",

"linkVideo":"http://empresa.com.br/video/id=1",

"linkImagem":"http://empresa.com.br/imagem/id=1",

"qtdEventos":"2",

"listaEventos":[{"tipoEvento":"01","codEvento":"1001","dthEvento":"2015-06-05 10:31:12","observacao":"eventoteste

1"},{"tipoEvento":"01","codEvento":"1002","dthEvento":"2015-06-05

10:33:55","observacao":"evento teste 2"}]}

Campo Tipo Tamanho Obrigatório Descrição Obs.
imei Alfa 18 S Código do Equipamento Se não houver imei, enviar identificação única do equipamento
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem Código único de aula na empresa
cfc Alfa 8 S Código do credenciado Ex.: CHC99999
cpfAluno Alfa 11 S CPF do Aluno  
cpfInstrutor Alfa 11 S CPF do Instrutor  
turno Alfa 1 S Turno da aula D - Diurno N - Noturno
viaAula Alfa 1 S Via da aula R - Rodovia U - Urbana
dthIniAula Alfa 16 S Data/Hora do início da aula yyyy-MM-dd HH:mm
dthFimAula Alfa 16 S Data/Hora do fim da aula yyyy-MM-dd HH:mm
cargaHoraria Numérico 1 S Carga horária da aula, que pode ser 1 hora aula ou 2 horas aula - 50 minutos - 100 minutos
categoria Alfa 4 S Categoria pretendida A, ACC, B, C, D ou E
placa Alfa 7 S Placa do veículo Ex.: IAM1234
kmInicial Numérico 9 S Quilometragem do veículo no início da aula  
kmFinal Numérico 9 S Quilometragem do veículo no fim da aula  
situacao Numérico 1 S - realizada - Atendeu todos os requisitos - incompleta - Não atendeu o requisito do tempo 1 - realizada 2-incompleta
origem Numérico 1 S 1 - Aula com registro automático no dispositivo móvel/Camada Cliente
2 - Aula com registro manual no sistema Web/Camada Servidor
1 - Automático 2 - Manual (contingência)
indAdaptado Numérico 1 S Aula realizada para condutores que necessitam de veículos adaptados 0 - Não 1 - Sim

.

justificativaAula Alfa 500 N Motivo da aula ter sido interrompida (situação incompleta) ou motivo do registro Obrigatório quando situação incompleta ou aulas enviadas em contingência
        em contingência manual (origem manual)  
observacao Alfa 500 N Observações do Instrutor sobre a aula  
indForaSede Numérico 1 S   - aula na sede - aula em município fora da sede
linkMapa Alfa 100 S Link internet do mapa do percurso da aula Campo opcional para categoria A e ACC. Senha de acesso deve ser fornecido ao DETRAN/RS
linkVideo Alfa 100 N Link internet da filmagem da aula Senha de acesso deve ser fornecido ao DETRAN/RS
linkImagem Alfa 100 S Link internet das imagens aleatórias da aula Senha de acesso deve ser fornecido ao DETRAN/RS
qtdEventos Númérico 4 S Quantidade de eventos sendo enviados na lista  
listaEventos     S Tabela com os eventos ocorridos na aula. Devem ser informados infrações e erros.  
  dthEvento Alfa 19 S Data/Hora do evento yyyy-MM-dd HH:mm:ss
  tipoEvento Alfa 2 S Tipo do evento que pode corresponder ao conteúdo pedagógico, infração e outros... Os tipos de eventos são fornecidos pelo DETRAN/RS
  codEvento Alfa 8 S Código do evento que pode corresponder ao conteúdo pedagógico, infração e outros. Os códigos de eventos são fornecidos pelo DETRAN/RS
  observacao Alfa 500 N Observação sobre o evento Obrigatório quando no evento de comportamento foi informado "Outros"

Descrição do retorno:

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = F007

msgErro = Placa Inválida

2) Para excluir uma aula prática

2.1) O sistema solicita a exclusão de uma aula prática.

2.2) DETRAN/RS: valida solicitação e aceita ou rejeita a ação, com base nas validações do sistema.

2.3) Exemplo de uso:

Método HTTP:

@DELETE

Headers HTTP:

organizacao: NomeEmpresa matricula: 99999999

senha: x9x9x9x

Parâmetros:

"idAulaPratica": 1,

"cfc": "CHC99999",

"cpfAluno": "99999999999"

"motivo": "Exclusão de aula incompleta devido a problema técnico"

Descrição do envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem  
cfc Alfa 8 S Código do credenciado Ex.: CHC99999
cpfAluno Alfa 11 S CPF do Aluno Ex.: 99999999999
motivo Alfa 500 S Motivo da exclusão da aula  

Descrição do retorno:

Status http Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Os códigos de erros serão retornados pelo DETRAN/RS, conforme definido abaixo.
401 Não autorizado Falha de autenticação.

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = E001

msgErro = Identificação da aula deve ser informada

3) Serviço para listar as aulas práticas em situação de inconformidade

3.1) O sistema solicita a lista de aulas práticas em inconformidade.

3.2) DETRAN/RS: valida solicitação e aceita ou rejeita a ação, com base nas validações do sistema.

3.3) Exemplo de uso:

Método HTTP:

@GET

Headers HTTP:

organizacao: NomeEmpresa matricula: 99999999

senha: x9x9x9x Parâmetros:

"cfc": "CHC99999",

"dtPeriodoInicio": "2017-01-01",

"dtPeriodoFim": "2017-01-07", }

Descrição do envio:
 

Campo Tipo Tamanho Obrigatório Descrição Obs.
cfc Alfa 8 S Filtro código do credenciado cliente da empresa de filmagem Ex.: CHC99999
dtPeriodoInicio Alfa 10 S Filtro período inicial yyyy-MM-dd
dtPeriodoFim Alfa 10 S Filtro período final yyyy-MM-dd

Descrição do retorno:

Status http Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 200 retorna uma lista de inconformidades conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem Código único de aula na empresa
cpfAluno Alfa 11 S CPF do Aluno  
cpfInstrutor Alfa 11 S CPF do Instrutor  
dthIniAula Alfa 16 S Data/Hora do início da aula yyyy-MM-dd HH:mm
dthFimAula Alfa 16 S Data/Hora do fim da aula yyyy-MM-dd HH:mm
Placa Alfa 7 S Placa do veículo Ex.: IAM1234
txtInconformidade Alfa 4000 S Texto com a inconformidade da aula prática  

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = E001

msgErro = Identificação da aula deve ser informada

4) Serviços para consultar dados de uma aula prática

4.1) O sistema solicita a consulta de dados de uma aula prática.

4.2) DETRAN/RS: valida solicitação e aceita ou rejeita a ação, com base nas validações do sistema.

4.3) Exemplo de uso:

Método HTTP:

@GET

Headers HTTP:

organizacao: NomeEmpresa matricula: 99999999

senha: x9x9x9x

Parâmetros:

"idAulaPratica": 1,

"cfc": "CHC99999",

"cpfAluno": "99999999999"

Descrição do envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem  
CFC Alfa 8 S Código do credenciado cliente da empresa de filmagem Ex.: CHC99999
cpfAluno Alfa 11 S CPF do Aluno Ex.: 99999999999

Descrição do retorno:

Status http Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo. Os códigos e as mensagens de erros são fornecidos pelo DETRAN/RS
401 Não autorizado Falha de autenticação

Requisição com status 200 retorna uma lista de inconformidades conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem Código único de aula na empresa
cpfAluno Alfa 11 S CPF do Aluno  
cpfInstrutor Alfa 11 S CPF do Instrutor  
dthIniAula Alfa 16 S Data/Hora do início da aula yyyy-MM-dd HH:mm
dthFimAula Alfa 16 S Data/Hora do fim da aula yyyy-MM-dd HH:mm
Turno Alfa 1 S Turno da aula D - Diurno N- Noturno
viaAula Alfa 1 S Via da aula R - Rodovia U - Urbana
cargaHoraria Numérico 1 S Carga horária da aula, que pode ser 1 hora aula ou 2 horas aula - 50 minutos - 100 minutos
Categoria Alfa 4 S Categoria pretendida A, ACC, B, C, D ou E
Placa Alfa 7 S Placa do veículo Ex.: IAM1234
kmInicial Numérico 9 S Quilometragem do veículo no início da aula  
kmFinal Numérico 9 S Quilometragem do veículo no fim da aula  
situacaoAula Detran Numerico 2 S Situação da aula no sistema do Detran 3 - Aguardando processamento
4 - Inconformidade 6 - Registrada
8 - Aula cancelada 10 - Incompleta - Aguardando homologação - Rejeitada - Excluída - Inutilizada
txtInconformidade Alfa 4000 N Texto com a inconformidade da aula prática  

Requisição com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
odErro Alfa 8 S Código do erro  
sgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = E001

msgErro = Identificação da aula deve ser informada

Nota: Redação Anterior:

ANEXO I

Serviço de Integração de Aulas Práticas Este documento tem por objetivo a definição de especificações e serviços para as integrações necessárias entre os softwares de aulas práticas utilizados em Centros de Formação de Condutores e os sistemas corporativos do DETRAN/RS.


Obs.: Grandes volumes de envio de aulas práticas deverão ser realizados no horário entre 20 horas e 07 horas. Aulas prioritárias poderão ser enviadas a qualquer tempo.

Característica Descrição
Padrão da mensagem A Integração se dará com serviços WEB HTTP desenvolvidos e hospedados na PROCERGS, utilizando a arquitetura REST (Representational State Transfer).
REST Conceitos: http://pt.wikipedia.org/wiki/REST
HTTP STATUS http://pt.wikipedia.org/wiki/Anexo:Lista_de_códigos_de_status_HTTP
URL de acesso https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/aulaPratica
Meio de comunicação Internet
Padrão de troca de mensagens Troca de mensagens no formato texto através do content-type JSON (Javascript Object Notation).
Autorização de acesso DETRAN/RS vai fornecer os dados para acesso para cada empresa que desejar fazer a integração.

1. Os serviços previstos são:

1.1) @POST

Serviço para inclusão de uma aula prática

1.2) @DELETE

Serviço para cancelamento de uma aula prática

2) @POST - Serviço para inclusão de uma aula prática

2.1) O sistema solicita a inclusão.

2.2) DETRAN/RS: valida a solicitação de inclusão. Aceita ou rejeita a inclusão com base nas validações básicas.

2.3) Exemplo de uso:

Método HTTP:

@POST

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

{

"imei":"123456789123456",

"idAulaPratica":"1",

"cfc":"CHC99999",

"cpfAluno":"99999999999",

"cpfInstrutor":"99999999999",

"turno":"D",

"viaAula":"R",

"dthIniAula":"9999-99-99 99:99",

"dthFimAula":"9999-99-99 99:99",

"cargahoraria":"1",

"categoria":"B",

"placa":"XXX9999",

"kmInicial":"100",

"kmFinal":"120",

"situacao":"1",

"origem":"1",

"indAdaptado":"0",

"justificativaAula":"",

"observacao":"OBS",

"indForaSede":"0",

"linkMapa":"http://empresa.com.br/mapa/id=1",

"linkImagem":"http://empresa.com.br/imagem/id=1",

"qtdEventos":"1",

"listaEventos":[{"tipoEvento":"01","codEvento":"1001","horaEvento":"2015-06-05 10:31:12","descrEvento":"evento teste 1"},{"tipoEvento":"01","codEvento":"1002","horaEvento":"2015-06-05 10:33:55","descrEvento":"evento teste 2"}]}

Descrição do envio:

Campo Tipo Tama nho Obriga tório Descrição Obs.
Imei Alfa 18 S Código do Equipamento O equipamento deve estar registrado no cadastro de equipamentos
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem Código único
cfc Alfa 8 S Código do credenciado Ex.: CHC99999
cpfAluno Alfa 11 S CPF do Aluno  
cpfInstrutor Alfa 11 S CPF do Instrutor  
turno Alfa 1 S Turno da aula D=Diurno N=Noturno
viaAula Alfa 1 S Via da aula R=Rodovia U=Urbana
dthIniAula Alfa 16 S Data/Hora do início da aula yyyy-MM-dd HH:mm
dthFimAula Alfa 16 S Data/Hora do fim da aula yyyy-MM-dd HH:mm
cargahoraria Numérico 1 S Carga horária da aula, que pode ser 1 hora aula ou 2 horas aula 1 - 50 minutos
2 - 100 minutos
categoria Alfa 4 S Categoria pretendida ACC, A, B, C, D, E.
placa Alfa 7 S Placa do veículo Ex.:IAM1234
KmInicial Numérico 9 S Km do veículo no início da aula  
KmFinal Numérico 9 S Km do veículo no fim da aula  
situacao Numérico 1 S 1 - realizada - Atendeu todos os requisitos 1- realizada
2 - incompleta - Não atendeu o requisito do tempo 2 - incompleta
origem Numérico 1 S 1- Aula com registro automático no dispositivo móvel/Camada Cliente 1 - Automático
2- Aula com registro manual no sistema Web/Camada Servidor 2 - Manual
indAdaptado Numérico 1 S Aula realizada para condutores que necessitam de veículos adaptados 0 - Não
1 - Sim
justificativaAula Alfa 500 N Justificativa para o cancelamento da aula ou para o registro manual (offline) Obrigatório quando incompleta ou offline
observacao Alfa 500 N Observações adicionais  
indForaSede Numérico 1 S   0 - aula na sede
1 - aula em município fora da sede
linkMapa Alfa 100 S Link internet do mapa do percurso da aula Senha de acesso deverá ser fornecida ao DETRAN/RS
linkImagem Alfa 100 S Link internet das imagens do percurso da aula Senha de acesso deverá ser fornecida ao DETRAN/RS
qtdEventos Númérico 4 S Quantidade de eventos sendo enviados na lista  
listaEventos     S Tabela com os eventos ocorridos na aula. Devem ser informados infrações e erros.  
DataHo raEvent o Alfa 19 S Hora do evento yyyy-MM-dd HH:mm:ss
tipoEve nto Alfa 2 S Tipo do evento Código do evento que pode corresponder ao conteúdo pedagógico, infração e outros... Os tipos serão definidos em tabelas fornecidas pelo DETRAN/RS
codEve nto Alfa 8 S Código do evento que pode corresponder ao conteúdo pedagógico, infração e outros. Os códigos de eventos serão definidos em tabelas fornecidas pelo DETRAN/RS
Obser vacao Alfa 500 N Observação  
           

Descrição do retorno:

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo.
401 Não autorizado Falha de autenticação

Requisições com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tama nho Obriga tório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = EQP001

msgErro = Equipamento não cadastrado

3) @DELETE - Serviço para cancelamento de uma aula prática

3.1) Sistema de Gestão do CFC: O sistema solicita o cancelamento de uma aula prática.


3.2) DETRAN/RS: valida solicitação e aceita ou rejeita a ação, com base nas validações do sistema.

3.3) Exemplo de uso:

Método HTTP:

@DELETE

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

{

"idAulaPratica":1,

"cfc":"CHC99999",

"cpfAluno":"99999999999"

"motivo": "Problemas no motor do carro"

}

Descrição do envio:

Campo Tipo Tama nho Obriga tório Descrição Obs.
idAulaPratica Numérico 12 S Identificação da aula no sistema de origem  
cfc Alfa 8 S Código do credenciado Ex.: CHC99999
cpfAluno Alfa 11 S CPF do Aluno Ex.: 99999999999
motivo Alfa 500 S    

Descrição do retorno:

Status http Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo.
401 Não autorizado Falha de autenticação

Requisições com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tama nho Obrigat ório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

codErro = EQP001

msgErro = Equipamento não cadastrado

4) Falhas no recebimento, por conexão, timeout ou outro.

Se não houver retorno do sistema do DETRAN/RS (Ex: devido algum erro de conexão, timeout, etc...), a aula não será recebida.

Somente o retorno do serviço com HTTP.STATUS = 200 é o recebimento com sucesso.

Deverá ser feita uma nova tentativa de envio dos dados.

(Redação do anexo dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017):

ANEXO II

Serviço de Consulta Data e Hora Oficial Este documento tem por objetivo a definição de especificação e serviço para a consulta de data e hora oficial do servidor DETRAN/RS.

Característica Descrição
Padrão da mensagem A Integração se dará com serviços WEB HTTP desenvolvidos e hospedados na PROCERGS, utilizando a arquitetura REST (Representational State Transfer).
REST Conceitos: http://pt.wikipedia.org/wiki/REST
HTTP STATUS http://pt.wikipedia.org/wiki/Anexo:Lista_de_códigos_de_status_HTTP
URL de acesso https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/dataHoraOficial
Meio de comunicação Internet
Padrão de troca de mensagens Troca de mensagens no formato texto através do content-type JSON (Javascript Object Notation).
Autorizaçã o de acesso DETRAN/RS vai fornecer os dados para acesso para cada empresa que desejar fazer a integração.

O serviço:

1.1) @POST

Serviço para validação da data e hora local do dispositivo móvel com o horário oficial do DETRAN/RS

2) Validação data e hora

2.1) O equipamento móvel da empresa fornecedora solicita a validação.

2.2) O sistema do DETRAN/RS valida a data e hora enviada pelo dispositivo móvel. Validar o horário ao menos uma vez ao dia. Sugestão de uso do serviço ao sincronizar as aulas com o equipamento.

2.3) Exemplo de uso:

Método HTTP:

@POST

Headers HTTP:

organizacao: NomeEmpresa matricula: 99999999

senha: x9x9x9x Parâmetros:

"cfc": "CHC99999"

"imei":"123456789123456"

"dataHora":9999-99-99 99:99:99

Descrição do envio:

Campo Tipo Tamanho Obrigatór io Descrição Obs.
cfc Alfa 8 S Código do CFC  
imei Alfa 18 S Código do dispositivo móvel  
dataHora Alfa 19 S Data e hora do dispositivo móvel yyyy-MM-dd HH:mm:ss

Descrição do retorno:

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, definidos pelo sistema do DETRAN/RS, conforme definido abaixo.
401 Não autorizado Falha de autenticação

Requisições com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro

Exemplo ilustrativo:

codErro = DTH001

msgErro = Horário do equipamento móvel dessincronizado. Ajuste o horário.

Nota: Redação Anterior:

ANEXO II

SERVIÇO DE CONSULTA DATA E HORA OFICIAL

Este documento tem por objetivo a definição de especificação e serviço para a consulta de data e hora oficial do servidor DETRAN/RS.

Característica Descrição
Padrão da mensagem A Integração se dará com serviços WEB HTTP desenvolvidos e hospedados na PROCERGS, utilizando a arquitetura REST (Representational State Transfer).
REST Conceitos: http://pt.wikipedia.org/wiki/REST
HTTP STATUS http://pt.wikipedia.org/wiki/Anexo:Lista_de_códigos_de_status_HTTP
URL de acesso https://mgfc.detran.rs.gov.br/gfc/rest/gfcmobile/dataHoraOficial
Meio de comunicação Internet
Padrão de troca de mensagens Troca de mensagens no formato texto através do content-type JSON (Javascript Object Notation).
Autorização de acesso DETRAN/RS vai fornecer os dados para acesso para cada empresa que desejar fazer a integração.

1. O serviço:

1.1) @POST


Serviço para validação da data e hora local do equipamento móvel.

2) Validação data e hora

2.1) O equipamento móvel da empresa fornecedora solicita a validação.

2.2) O sistema do DETRAN/RS valida a data e hora enviada e o equipamento enviado.

2.3) Exemplo de uso:

Método HTTP:

@POST

Headers HTTP:

organizacao: NomeEmpresa

matricula: 99999999

senha: x9x9x9x

Parâmetros:

{"cfc": "CHC99999"

"imei":"123456789123456"

"dataHora":9999-99-99 99:99:99}

Descrição do envio:

Campo Tipo Tama nho Obrigató rio Descrição Obs.
cfc Alfa 8 S Código do CFC  
Imei Alfa 18 S Código do dispositivo móvel O equipamento deve estar registrado no cadastro de equipamentos
dataHora Alfa 19 S Data e hora do dispositivo móvel yyyy-MM-dd HH:mm:ss

Descrição do retorno:

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Erro de validação Será retornado os códigos de erro, conforme definido abaixo.
401 Não autorizado Falha de autenticação

Requisições com status 400 retorna uma lista de erros conforme descrito abaixo, no formato JSON.

Campo Tipo Taman ho Obrigat ório Descrição Obs.
codErro Alfa 8 S Código do erro  
msgErro Alfa 200 S Mensagem do erro  

Exemplo ilustrativo:

Erro 1:

codErro = EQP001

msgErro = Equipamento não cadastrado

Erro 2:

codErro = DTH001

msgErro = Horário do equipamento móvel dessincronizado. Ajuste o horário.

(Redação do anexo dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017):

ANEXO III

Integração sistema PPE com solução de Filmagens Este documento tem por objetivo a definição de especificações e serviços para as integrações necessárias entre o sistema de exame prático (sistema PPE) do DETRAN/RS e o software de filmagem contratado pelos Centros de Formação de Condutores.

A empresa fornecedora do software de filmagem deve implementar estes serviços de comunicação e disponibilizar no equipamento gerenciador das câmeras em cada veículo.

Característica Descrição
Padrão da mensagem A Integração se dará com serviços WEB HTTP utilizando a arquitetura REST (Representational State Transfer).
REST Conceitos: http://pt.wikipedia.org/wiki/REST
HTTP STATUS http://pt.wikipedia.org/wiki/Anexo:Lista_de_códigos_de_status_HTTP
URL de acesso O fornecedor da solução deverá informar qual a URL do seu gerenciador de filmagens para cada tablet cadastrado
Meio de comunicação A comunicação dos tablets com os equipamentos gerenciadores de filmagens dos carros será feita através de rede WI-FI. Os nomes das redes deverão conter a placa do veículo em seu nome SSID, no formato AAA9999, e deverão estar previamente configuradas na lista de redes WI-FI com segurança avançada (WPA/WAP2) conhecidas (com a chave de segurança já informada e salva) do tablet. Todas as redes dos veículos que irão participar da turma devem estar cadastradas em cada um dos tablets da turma.
Padrão de troca de mensagens Troca de mensagens no formato texto através do content-type JSON (Javascript Object Notation).
Credencial de acesso A comunicação com as câmeras não utilizará credenciais.

Método de acesso.

Comunicação através dos métodos:

POST - utilizado nos serviços de inclusão.

GET - utilizado nos serviços de consulta.

Serviços previstos para comunicação.

Abaixo estão descritos os serviços para comunicação do sistema PPE com o software de filmagem contratada pelo CFC.

2.1) Teste da filmagem http:///filmagem/teste

2.2) Início da filmagem http:///filmagem/inicio

2.3) Teste da conexão http:///filmagem/status

2.4) Fim da filmagem http:///filmagem/fim

3. Códigos de retorno previstos.

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Requisição inválida A requisição foi concluída com erros.

O detalhamento dos dados de retorno para os Status HTTP será descrito em cada serviço.

4) Teste da filmagem.

Este serviço, obrigatoriamente, deverá ser utilizado no momento do checklist do veículo.

4.1) O sistema PPE executa chamada deste serviço, enviando por parâmetro a Placa do veículo e legenda.

4.2) A aplicação gerenciadora das câmeras efetua a ativação e gravação da filmagem de todas as câmeras instaladas no veículo.

4.3) Deve gerar 3 segundos de vídeo e finalizar a gravação da filmagem.

4.4) Deve aparecer na filmagem o parâmetro "legendaFilme" enviado.

4.5) A aplicação gerenciadora das câmeras retorna ao sistema PPE a identificação do vídeo, a placa do veículo em que a rede local está conectada e a data e hora do fim da filmagem.

Descrição dos dados de envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
placaVeiculo Alfa 07 S Placa do veículo no PPE Fomato: XXX9999
legendaFilme Alfa 50 S Texto para constar na filmagem (marca d'água)  

Descrição dos dados de retorno - Status 200:

Campo Tipo Tamanho Obrigatório Descrição Obs.
IdVideo Alfa 255 S URL de consulta do vídeo no sistema da empresa fornecedora  
placaVeiculo Alfa 07 S Placa do veículo em que o equipamento de filmagem está conectado. Formato: XXX9999
dataHora Alfa 19 S Data e hora fim da filmagem YYYY-MM-DD HH:MM:SS

Descrição dos dados de retorno - Status 400:

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro  

Exemplo de erros de retorno - Status 400:

codErro MsgErro
TF001 Parâmetro Placa veículo inválido ou não informado
TF002 Parâmetro Legenda filme não informado
TF003 Problema no equipamento de filmagem
TF004 Falta de espaço para armazenamento da filmagem
TF005 Aplicativo conectado em rede WI-FI diferente da placa da prova

Abaixo exemplo de uso do serviço Teste da Filmagem:

Método HTTP:

@POST

Parâmetros de envio:

"placaVeiculo":"ABC1234",

"legendaFilme":"ABC1234 - Teste Filmagem"

Parâmetros de retorno - Status 200:

"idVideo":"https://empresafornecedora.com.br/videosDetran/consulta/?idVideo=xyz"

"placaVeiculo":"ABC1234",

"dataHora":"2015-09-05 08:56:00"

Parâmetros de retorno - Status 400:

"codErro":"TF001",

"msgErro": "Parâmetro Placa veículo inválido ou não informado"

5) Início da filmagem.

Este serviço deverá ser utilizado no momento do início do exame prático. Será chamado pelo sistema PPE no clique do botão "Pronto para início".

5.1) O sistema PPE envia solicitação para início da filmagem, enviando o número do exame, a placa do veículo e a legenda.

5.2) A aplicação gerenciadora das câmeras efetua a ativação e gravação da filmagem de todas as câmeras instaladas no veículo, vinculando o número do exame ao arquivo de vídeo.

5.3) Deve aparecer na filmagem o parâmetro "legendaFilme" enviado.

5.4) A aplicação retorna o número do exame, a placa do veículo em que a rede local está conectada, a identificação do vídeo e a data e hora do início da filmagem.

Descrição dos dados de envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
NroExame Numérico 10 S Identificação do exame prático  
placaVeiculo Alfa 07 S Placa do veículo no PPE Fomato: XXX9999
legenda Filme Alfa 50 S Texto para constar na filmagem (marca dágua)  


Descrição dos dados de retorno - Status 200:

Campo Tipo Tamanho Obrigatório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
placaVeiculo Alfa 07 S Placa do veículo em que o equipamento de filmagem está conectado. Fomato: XXX9999
idVideo Alfa 255 S URL de consulta do vídeo do exame no sistema da empresa fornecedora  
dataHora Alfa 19 S Data e hora do início da filmagem do gerenciador de filmagem YYYY-MM- DD HH:MM:SS

Descrição dos dados de retorno - Status 400:

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro  

Exemplo de erros de retorno - Status 400:

codErro MsgErro
IF001 Parâmetro Número Exame inválido ou não informado
IF002 Parâmetro Legenda filme não informado
IF003 Problema no equipamento de filmagem
IF004 Falta de espaço para armazenamento da filmagem
IF005 Outra gravação em andamento
IF006 Aplicativo conectado em rede WI-FI diferente da placa da prova

Abaixo exemplo de uso deste serviço:

Método HTTP:

@POST

Parâmetros de envio:

"nroExame":0001234567,

"placaVeiculo":"ABC1234",

"legendaFilme":"Nro.Exame 00012345-67"

Parâmetros de retorno - Status 200:

"nroExame": 0001234567,

"placaVeiculo":"ABC1234",

"idVideo":"https://empresafornecedora.com.br/videosDetran/consulta/?idVideo=wxy",

"dataHora":"2015-09-05 10:00:00"

Parâmetros de retorno - Status 400:

"codErro":"TF001",

"msgErro": "Parâmetro Legenda filme não informado"

6) Teste da conexão.

Este serviço será utilizado para verificação da conexão do sistema PPE com a aplicação gerenciadora da filmagem. Este serviço será ativado, em intervalos de tempo, durante a filmagem da aplicação do Exame Prático.

6.1) O sistema PPE, aleatoriamente, envia o número do exame, a placa do veículo e a identificação do vídeo para teste de conexão com a aplicação gerenciadora da filmagem.

6.2) A aplicação retorna o número do exame, a placa do veículo, a identificação do vídeo e a data e hora do teste da filmagem.

Descrição dos dados de envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
placaVeiculo Alfa 07 S Placa do veículo no PPE Fomato: XXX9999
idVideo Alfa 255 S URL de consulta do vídeo do exame no sistema da empresa fornecedora  

Descrição dos dados de retorno - Status 200:

Campo Tipo Tamanho Obrigatório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
placaVeiculo Alfa 07 S Placa do veículo em que o equipamento de filmagem está conectado. Fomato: XXX9999
idVideo Alfa 255 S URL de consulta do vídeo do exame no sistema da empresa fornecedora  
dataHora Alfa 19 S Data e hora do início da filmagem do gerenciador de filmagem YYYY-MM-DD HH:MM:SS

Descrição dos dados de retorno - Status 400:

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro  

Exemplo de erros de retorno - Status 400:

codErro MsgErro
TC001 Parâmetro Número Exame inválido ou não informado
TC002 Problema no equipamento de filmagem
TC004 Falta de espaço para armazenamento da filmagem
TC005 Outra gravação em andamento
TC005 Nenhuma gravação em andamento
TC006 Aplicativo conectado em rede WI-FI diferente da placa da prova

Abaixo exemplo de uso deste serviço:

Método HTTP:

@POST

Parâmetros de envio:

"nroExame":0001234567,

"placaVeiculo":"ABC1234",

"idVideo":"https://empresafornecedora.com.br/videosDetran/consulta/?idVideo=wxy"

Parâmetros de retorno - Status 200:

"nroExame":0001234567,

"placaVeiculo":"ABC1234",

"idVideo":"https://empresafornecedora.com.br/videosDetran/consulta/?idVideo=wxy",

"dataHora":"2015-09-05 10:00:00"

Parâmetros de retorno - Status 400:

"codErro":"TC001",

"msgErro": "Parâmetro Número Exame inválido ou não informado"

7) Fim da filmagem.

Este serviço deverá ser utilizado no momento do final da gravação do exame prático. Será chamado pelo aplicativo PPE no clique do botão "STOP" do percurso.

7.1) O sistema PPE envia solicitação para fim da filmagem, enviando o número do exame, a placa do veículo e a identificação do vídeo.

7.2) A aplicação gerenciadora das câmeras efetua a desativação e finalização da gravação da filmagem de todas as câmeras instaladas no veículo.

7.3) A aplicação retorna o número do exame, a placa do veículo e a identificação do vídeo e data e hora do fim da filmagem.

Descrição dos dados de envio:

Campo Tipo Tamanho Obrigatório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
placaVeiculo Alfa 07 S Placa do veículo no PPE Fomato: XXX9999
idVideo Alfa 255 S URL de consulta do vídeo do exame no sistema da empresa fornecedora  

Descrição dos dados de retorno - Status 200:

Campo Tipo Tamanho Obrigatório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
placaVeiculo Alfa 07 S Placa do veículo em que o equipamento de filmagem está conectado. Fomato: XXX9999
idVideo Alfa 255 S URL de consulta do vídeo do exame no sistema da empresa fornecedora  
dataHora Alfa 21 S Data e hora do fim da filmagem YYYY-MM- DD HH:MM:SS

Descrição dos dados de retorno - Status 400:

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro  

Exemplo de erros de retorno - Status 400:

codErro msgErro
FF001 Parâmetro Número Exame inválido ou não informado
FF002 Parâmetro Idetificação Vídeo inválido ou não informado
FF003 Problema no equipamento de filmagem
FF004 Outra gravação em andamento
FF005 Nenhuma gravação em andamento
FF006 Aplicativo conectado em rede WI-FI diferente da placa da prova

Abaixo exemplo de uso deste serviço:

Método HTTP:

@POST

Parâmetros de envio:

"nroExame": 0001234567,

"placaVeiculo":"ABC1234",

"idVideo":"https://empresafornecedora.com.br/videosDetran/consulta/?idVideo=wxy", }

Parâmetros de retorno - Status 200:

"nroExame":0001234567,

"placaVeiculo":"ABC1234",

"idVideo":"https://empresafornecedora.com.br/videosDetran/consulta/?idVideo=wxy",

"dataHora":"2015-09-05 10:15:00"

Parâmetros de retorno - Status 400:

"codErro":"FF001",

"msgErro": "Parâmetro Número Exame inválido ou não informado"

Nota: Redação Anterior:

ANEXO III

INTEGRAÇÃO SISTEMA PPE COM SOLUÇÃO DE FILMAGENS

Este documento tem por objetivo a definição de especificações e serviços para as integrações necessárias entre o sistema de exame prático (sistema PPE) do DETRAN/RS e o software de filmagem contratado pelos Centros de Formação de Condutores.

A empresa fornecedora do software de filmagem deve implementar estes serviços de comunicação e disponibilizar no equipamento gerenciador das câmeras em cada veículo.

Característica Descrição
Padrão da mensagem A Integração se dará com serviços WEB HTTP utilizando a arquitetura REST (Representational State Transfer).
REST Conceitos: http://pt.wikipedia.org/wiki/REST
HTTP STATUS http://pt.wikipedia.org/wiki/Anexo:Lista_de_códigos_de_status_HTTP
URL de acesso http://PPE. < PlacaVeiculo >
O fornecedor da solução deverá criar este "Alias" no equipamento gerenciador de filmagem no carro, onde < PlacaVeiculo > utiliza somente letras e números.
Meio de comunicação Rede WI-FI do Equipamento gerenciador de filmagens no carro. O
nome da rede deverá ser a < PlacaVeiculo > utiliza somente letras e números.
Padrão de troca de mensagens Troca de mensagens no formato texto através do content-type JSON (Javascript Object Notation).
Credencial de acesso A comunicação com as câmeras não utilizará credenciais.

Método de acesso.

Comunicação através dos métodos:

POST - utilizado nos serviços de inclusão.

GET - utilizado nos serviços de consulta.

1. Serviços previstos para comunicação.

Abaixo estão descritos os serviços para comunicação do sistema PPE com o software de filmagem contratada pelo CFC.

2.1) Teste da filmagem http://PPE. < PlacaVeiculo > /filmagem/teste

2.2) Início da filmagem http://PPE. < PlacaVeiculo > /filmagem/inicio

2.3) Teste da conexão http://PPE. < PlacaVeiculo > /filmagem/status

2.4) Fim da filmagem http://PPE. < PlacaVeiculo > /filmagem/fim

3. Códigos de retorno previstos.

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Requisição inválida A requisição foi concluída com erros.

O detalhamento dos dados de retorno para os Status HTTP será descrito em cada serviço.

4) Teste da filmagem.

Este serviço, obrigatoriamente, deverá ser utilizado no momento do checklist do veículo.

4.1) O sistema PPE executa chamada deste serviço, enviando por parâmetro a Placa do veículo e legenda.

4.2) A aplicação gerenciadora das câmeras efetua a ativação e gravação da filmagem de todas as câmeras instaladas no veículo.

4.3) Deve gerar 3 segundos de vídeo e finalizar a gravação da filmagem.

4.4) Deve aparecer na filmagem o parâmetro "legendaFilme" enviado.

4.5) A aplicação gerenciadora das câmeras retorna ao sistema PPE a placa do veículo, a identificação do vídeo e a data e hora do fim da filmagem.

Descrição dos dados de envio:

Campo Tipo Tama nho Obriga tório Descrição Obs.
placaVeiculo Alfa 07 S Placa do veículo Fomato: XXX9999
LegendaFilme Alfa 50 S Texto para constar na filmagem (marca dágua)  

Descrição dos dados de retorno - Status 200:

Campo Tipo Tama nho Obriga tório Descrição Obs.
placaVeiculo Alfa 07 S Placa do veículo Formato: XXX9999
idVideo Alfa 10 S Identificação do vídeo do exame prático  
dataHora Alfa 19 S Data e hora fim da filmagem YYYY-MM-DD HH:MM:SS

Descrição dos dados de retorno - Status 400:

Campo Tipo Tama nho Obrigat ório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro

Exemplo de erros de retorno - Status 400:

codErro msgErro
TF001 Parâmetro Placa veículo inválido ou não informado
TF002 Parâmetro Legenda filme não informado
TF003 Problema no equipamento de filmagem
TF004 Falta de espaço para armazenamento da filmagem
   

Abaixo exemplo de uso do serviço Teste da Filmagem:

Método HTTP:

@POST

Parâmetros de envio:

{

"placaVeiculo":"ABC1234",

"legendaFilme":" 2015-09-05 08:55:10 - ABC1234 - Teste Filmagem"

}

Parâmetros de retorno - Status 200:

{

"placaVeiculo":"ABC1234",

"idVideo": "ABC1234"

"dataHora":"2015-09-05 08:56:00"


}

Parâmetros de retorno - Status 400:

{

"codErro":"TF001",

"msgErro": "Parâmetro Placa veículo inválido ou não informado"

}

5) Início da filmagem.

Este serviço deverá ser utilizado no momento do início do exame prático. Será chamado pelo sistema PPE no clique do botão "Pronto para inicio".

5.1) O sistema PPE envia solicitação para início da filmagem, enviando número do exame e legenda.

5.2) A aplicação gerenciadora das câmeras efetua a ativação e gravação da filmagem de todas as câmeras instaladas no veículo, vinculando o número do exame ao arquivo de vídeo.

5.3) Deve aparecer na filmagem o parâmetro "legendaFilme" enviado.

5.4) A aplicação retorna o número do exame, a identificação do vídeo e a data e hora do início da filmagem.

5.5) O vídeo da filmagem deve ser único em formato mosaico.

Descrição dos dados de envio:

Campo Tipo Tama nho Obriga tório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
legenda Filme Alfa 50 S Texto para constar na filmagem (marca dágua)

Descrição dos dados de retorno - Status 200:

Campo Tipo Tama nho Obrigat ório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
idVideo Alfa 10 S Identificação do vídeo do exame prático  
dataHora Alfa 19 S Data e hora do início da filmagem do gerenciador de filmagem YYYY-MM-DD HH:MM:SS

Descrição dos dados de retorno - Status 400:

Campo Tipo Tama nho Obrigat ório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro  

Exemplo de erros de retorno - Status 400:

codErro msgErro
IF001 Parâmetro Número Exame inválido ou não informado
IF002 Parâmetro Legenda filme não informado
IF003 Problema no equipamento de filmagem
IF004 Falta de espaço para armazenamento da filmagem
IF005 Outra gravação em andamento
   

Abaixo exemplo de uso deste serviço:

Método HTTP:

@POST

Parâmetros de envio:

{

"nroExame":0001234567,

"legendaFilme":" 2015-09-05 08:55:10 - Nro.Exame 000123456-7"

}

Parâmetros de retorno - Status 200:

{

"nroExame": 0001234567,

"idVideo": "0001234567",

"dataHora":"2015-09-05 10:00:00"

}

Parâmetros de retorno - Status 400:

{

"codErro":"TF001",

"msgErro": "Parâmetro Legenda filme não informado"

}


6) Teste da conexão.

Este serviço será utilizado para verificação da conexão do sistema PPE com a aplicação gerenciadora da filmagem e será ativado, em intervalos de tempo, durante a filmagem da aplicação do Exame Prático.

6.1) O sistema PPE, aleatoriamente, envia o número do exame e a identificação do vídeo para teste de conexão com a aplicação gerenciadora da filmagem.

6.2) A aplicação retorna o número do exame, a identificação do vídeo e a data e hora do teste da filmagem.

Descrição dos dados de envio:

Campo Tipo Tama nho Obriga tório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
idVideo Alfa 10 S Identificação do vídeo do exame prático  

Descrição dos dados de retorno - Status 200:

Campo Tipo Tama nho Obriga tório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
idVideo Alfa 10 S Identificação do vídeo do exame prático  
dataHora Alfa 19 S Data e hora do início da filmagem do gerenciador de filmagem YYYY-MM-DD HH:MM:SS

Descrição dos dados de retorno - Status 400:

Campo Tipo Tama nho Obrigat ório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro  

Exemplo de erros de retorno - Status 400:

codErro msgErro
TC001 Parâmetro Número Exame inválido ou não informado
TC002 Problema no equipamento de filmagem
TC004 Falta de espaço para armazenamento da filmagem
TC005 Outra gravação em andamento
TC005 Nenhuma gravação em andamento
   

Abaixo exemplo de uso deste serviço:

Método HTTP:

@POST

Parâmetros de envio:

{

"nroExame":0001234567,

"idVideo":" "0001234567"

}

Parâmetros de retorno - Status 200:

{

"nroExame":0001234567,

"idVideo": "0001234567",

"dataHora":"2015-09-05 10:00:00"

}

Parâmetros de retorno - Status 400:

{

"codErro":"TC001",

"msgErro": "Parâmetro Número Exame inválido ou não informado"

}

7) Fim da filmagem.

Este serviço deverá ser utilizado no momento do final da gravação do exame prático. Será chamado pelo aplicativo PPE no clique do botão "STOP" do percurso.

7.1) O sistema PPE envia solicitação para fim da filmagem, enviando o número do exame e a identificação do vídeo.

7.2) A aplicação gerenciadora das câmeras efetua a desativação e finalização da gravação da filmagem de todas as câmeras instaladas no veículo.

7.3) A aplicação retorna o número do exame, a identificação do vídeo e data e hora do fim da filmagem.

Descrição dos dados de envio:

Campo Tipo Tama nho Obriga tório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
idVideo Alfa 10 S Identificação do vídeo do exame prático

Descrição dos dados de retorno - Status 200:

Campo Tipo Tama nho Obrigat ório Descrição Obs.
nroExame Numérico 10 S Identificação do exame prático  
idVideo Alfa 10 S Identificação do vídeo do exame prático  
dataHora Alfa 21 S Data e hora do fim da filmagem YYYY-MM-DD HH:MM:SS

Descrição dos dados de retorno - Status 400:

Campo Tipo Tama nho Obrigat ório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro

Exemplo de erros de retorno - Status 400:

codErro msgErro
FF001 Parâmetro Número Exame inválido ou não informado
FF002 Parâmetro Idetificação Vídeo inválido ou não informado
FF003 Problema no equipamento de filmagem
FF004 Outra gravação em andamento
FF005 Nenhuma gravação em andamento
   

Abaixo exemplo de uso deste serviço:

Método HTTP:

@POST

Parâmetros de envio:

{

"nroExame": 0001234567,

"idVideo": "0001234567", }

Parâmetros de retorno - Status 200:

{

"nroExame":0001234567,

"idVideo": "0001234567",

"dataHora":"2015-09-05 10:15:00"

}

Parâmetros de retorno - Status 400:

{

"codErro":"FF001",

"msgErro": "Parâmetro Número Exame inválido ou não informado"

}

(Redação do anexo dada pela Portaria DETRAN/RS Nº 336 DE 26/07/2017):

ANEXO IV REQUISITOS MÍNIMOS DOS EQUIPAMENTOS

1. TABLET

1.1. Equipamento de computação pessoal tipo TABLET com, no mínimo, "7", com tela sensível ao toque;

1.2. Tela:

1.2.1. Tecnologia capacitiva;

1.2.2. Capacidade de multitoques para 10 pontos simultâneos;

1.2.3. Tecnologia LCD/IPS colorida;

1.2.4. Retro iluminada por LEDs;

1.2.5. Diagonal mínima de 7 polegadas;

1.2.6. Resolução mínima de 1024 x 600 pontos;

1.2.7. Contraste mínimo de 800:1 sob luz solar;

1.3. Processador:

1.3.1. Mínimo de quatro núcleos;

1.4. Memória RAM:

1.4.1. Capacidade mínima de 1 GByte;

1.5. Memória de armazenamento interno:

1.5.1. Capacidade mínima de 8 GBytes;

1.5.2. Tecnologia NAND FLASH;

1.6. Conectividade Wireless:

1.6.1. Wi-Fi IEEE 802.11 b/g/n

1.6.2. Bluetooth 4.0, A2DP;

1.7. Conectividade 3G Quad Band para operação com os protocolos:

1.7.1. HSDPA em 850, 900, 1900 e 2100 MHz;

1.7.2. GSM em 850, 900, 1800 e 1900 MHz;

1.7.3. GPRS;

1.7.4. EDGE;

1.8. Sistema de geolocalização por GPS assistido (A-GPS);

1.9. Câmera Frontal: 2 MegaPixels ou superior, microfone interno para videoconferência;

1.10. Porta USB 2.0 no formato micro USB com suporte a OTG;

1.11. Leitor de cartões de memória tipo microSD (Secure Digital) com capacidades mínima de 8 GigaBytes;

1.12. Cartão de memória tipo microSD (Secure Digital) com capacidades mínima de 8 GigaBytes;

1.13. Alto falantes stereo internos;

1.14. Conector de saída de áudio externo Stereo de 3,5 mm (P2) conjugado com entrada para microfone; sensor de movimento, detectando a orientação do aparelho de forma vertical e horizontal;

1.15. Sistema operacional Android 4.3 (JellyBean) ou superior em Português do Brasil;

1.16. Bateria de Polímero de Lítio com capacidade mínima de 3600 mAh e operação por pelo menos 8 horas em condições de uso normal;

1.17. Peso máximo do equipamento em condição normal de uso de 580 gramas;

1.18. Deve possuir selo de homologação e/ou certificação pela Anatel;

2. CÂMERA DO VEÍCULO (Especificações mínimas do equipamento)

2.1. Resolução óptica mínima de 640 x480 pixels;

2.2. Taxa de pelo menos 30 frames por segundo;

2.3. Resolução Horizontal: 420 linhas

2.4. Controle automático de ganho e balanço de branco;

2.5. Sensibilidade a luz a partir de 1 Lux;

2.6. Compressão de vídeo H.264 e MJPEG;

2.7. Possibilidade de inserir data e hora em posições fixas da imagem reproduzida;

2.8. Microfone embutido;

2.9. Sistema: NTSC

3. Qualidade de Vídeo (resolução mínima do arquivo de vídeo)

3.1 Resolução mínima de 320x240 pixels;

3.2 Taxa de pelo menos 5 frames por segundo.

4. Digital Vídeo Recorder - DVR - ou solução tecnológica equivalente ou superior, desde que seja possível realizar a conexão, integração e comunicação do PPE - Sistema de Prova Prática Eletrônica - com o sistema de filmagem, dentro dos critérios definidos pelo DETRAN/RS, que garanta a segurança e integridade das informações.

Nota: Redação Anterior:

(Redação do anexo dada pela Portaria DETRAN/RS Nº 531 DE 20/11/2015):

 ANEXO IV - REQUISITOS MÍNIMOS DOS EQUIPAMENTOS

1. TABLET

1.1. Equipamento de computação pessoal tipo TABLET 7" com tela sensível ao toque; (Redação dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
1.1. Equipamento de computação pessoal tipo TABLET 8" com tela sensível ao toque;

1.2. Tela:

1.2.1. Tecnologia capacitiva;

1.2.2. Capacidade de multitoques para 10 pontos simultâneos;

1.2.3. Tecnologia LCD/IPS colorida ou TFT colorida; (Redação dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
1.2.3. Tecnologia LCD/IPS colorida;

1.2.4. Retro iluminada por LEDs;

1.2.5. Diagonal mínima de 7 polegadas; (Redação dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
1.2.5. Diagonal mínima de 8 polegadas;

1.2.6. Resolução mínima de 1024 x 600 pontos; (Redação dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
1.2.6. Resolução mínima de 1024 x 768 pontos;

1.2.7. Contraste mínimo de 800:1 sob luz solar;

1.3. Processador:

1.3.1. Mínimo de quatro núcleos (quadcore); (Redação dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
1.3.1. Mínimo de quatro núcleos;

1.4. Memória RAM:

1.4.1. Capacidade mínima de 1 GByte;

1.5. Memória de armazenamento interno:

1.5.1. Capacidade mínima de 8 GBytes; (Redação dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
1.5.1. Capacidade mínima de 16 GBytes;

1.5.2. Tecnologia NAND FLASH;

1.6. Conectividade Wireless:

1.6.1. Wi-Fi IEEE 802.11 b/g/n

1.6.2. Bluetooth 4.0, A2DP;

1.7. Conectividade 3G Quad Band para operação com os protocolos:

1.7.1.HSDPA em 850, 900, 1900 e 2100 MHz;

1.7.2. GSM em 850, 900, 1800 e 1900 MHz;

1.7.3. GPRS;

1.7.4. EDGE;

1.8. Sistema de geolocalização por GPS assistido (A-GPS);

1.9. Câmera:

1.9.1. Frontal: 2 MegaPixels ou superior, microfone interno para videoconferência;

1.9.2 Traseira de 2 MegaPixels ou superior com autofoco; (Redação dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
1.9.2. Traseira de 5 MegaPixels ou superior com autofoco;

1.10. Porta USB 2.0 no formato micro USB com suporte a OTG;

1.11. Leitor de cartões de memória tipo microSD (Secure Digital) com capacidades mínima de 8 GigaBytes;

1.12. Cartão de memória tipo microSD (Secure Digital) com capacidades mínima de 8 GigaBytes;

1.13. Alto falantes stereo internos;

1.14. Conector de saída de áudio externo Stereo de 3,5 mm (P2) conjugado com entrada para microfone; sensor de movimento, detectando a orientação do aparelho de forma vertical e horizontal;

1.15. Sistema operacional Android 4.3 (JellyBean) ou superior em Português do Brasil;

1.16. Bateria de Polímero de Lítio com capacidade mínima de 3600 mAh e operação por pelo menos 9 horas em condições de uso normal; (Redação dada pela Portaria DETRAN/RS Nº 113 DE 11/04/2016).

Nota: Redação Anterior:
1.16. Bateria de Polímero de Lítio com capacidade mínima de 6000 mAh e operação por pelo menos 10 horas em condições de uso normal;

1.17. Peso máximo do equipamento em condição normal de uso de 580 gramas;

1.18. Deve possuir selo de homologação e/ou certificação pela Anatel;

2.CÂMERA

2.1. Resolução óptica mínima de 640 x 480 pixels;

2.2. Taxa de pelo menos 30 frames por segundo

2.3. Resolução Horizontal: 420 linhas

2.4. Controle automático de ganho e balanço de branco;

2.5. Sensibilidade a luz a partir de 1 Lux;

2.6. Compressão de vídeo H.264 e MJPEG;

2.7. Possibilidade de inserir data e hora em posições fixas da imagem reproduzida;

2.8. Microfone embutido;

2.9. Sistema: NTSC

3. LEITOR BIOMETRICO

3.1. Resolução mínima de 500 dpi

3.2. Tecnologia de detecção de dedo "vivo" (LFD -Live Finger Detection)

3.3. Cores: 256 níveis de cinza

3.4. Umidade relativa do ar: de 0 a 100%

Nota: Redação Anterior:
ANEXO IV

REQUISITOS MÍNIMOS DOS EQUIPAMENTOS

1. TABLET

1.1. Equipamento de computação pessoal tipo TABLET 10" com tela sensível ao toque;

1.2. Tela:

1.2.1. Tecnologia capacitiva;

1.2.2.Capacidade de multitoques para 10 pontos simultâneos;

1.2.3. Tecnologia LCD/IPS colorida;

1.2.4. Retro iluminada por LEDs;

1.2.5. Diagonal mínima de 10 polegadas;

1.2.6. Resolução mínima de 1920 x 1080 pontos;

1.2.7.Contraste mínimo de 800:1 sob luz solar;

1.3. Processador:

1.3.1.Mínimo de quatro núcleos;

1.3.2. Clock mínimo de 1.9 GHz;

1.4. Memória RAM:

1.4.1.Capacidade mínima de 2 GByte;

1.4.2. Tecnologia DDR3 SDRAM;

1.5. Memória de armazenamento interno:

1.5.1. Capacidade mínima de 16 GBytes;


1.5.2. Tecnologia NAND FLASH;

1.6. Conectividade Wireless:

1.6.1.Wi-Fi IEEE 802.11 b/g/n

1.6.2.Bluetooth 4.0, A2DP;

1.7. Conectividade 3G Quad Band para operação com os protocolos:

1.7.1.HSDPA em 850, 900, 1900 e 2100 MHz;

1.7.2.GSM em 850, 900, 1800 e 1900 MHz;

1.7.3.GPRS;

1.7.4.EDGE;

1.8. Sistema de geolocalização por GPS assistido (A-GPS);

1.9. Câmera:

1.9.1. Frontal: 2 MegaPixels ou superior, microfone interno para videoconferência;

1.9.2. Traseira de 8 MegaPixels ou superior com autofoco;

1.10. Porta USB 2.0 no formato micro USB com suporte a OTG;

1.11. Leitor de cartões de memória tipo microSD (Secure Digital) com capacidades mínima de 8 GigaBytes;

1.12. Cartão de memória tipo microSD (Secure Digital) com capacidades mínima de 8 GigaBytes;

1.13. Alto falantes stereo internos;

1.14. Conector de saída de áudio externo Stereo de 3,5 mm (P2) conjugado com entrada para microfone; sensor de movimento, detectando a orientação do aparelho de forma vertical e horizontal;

1.15. Sistema operacional Android 4.3 (JellyBean) ou superior em Português do Brasil;

1.16. Bateria de Polímero de Lítio com capacidade mínima de 6000 mAh e operação por pelo menos 10 horas em condições de uso normal;

1.17. Peso máximo do equipamento em condição normal de uso de 580 gramas;

1.18. Deve possuir selo de homologação e/ou certificação pela Anatel;

2. CÂMERA

2.1. Resolução óptica mínima de 640 x 480 pixels;

2.2. Taxa de pelo menos 30 frames por segundo

2.3. Resolução Horizontal: 420 linhas

2.4. Controle automático de ganho e balanço de branco;

2.5. Sensibilidade a luz a partir de 1 Lux;

2.6. Compressão de vídeo H.264 e MJPEG;

2.7. Possibilidade de inserir data e hora em posições fixas da imagem reproduzida;

2.8. Microfone embutido;

2.9. Sistema: NTSC

3. LEITOR BIOMETRICO

3.1. Resolução mínima de 500 dpi

3.2. Tecnologia de detecção de dedo "vivo" (LFD - Live Finger Detection)

3.3. Cores: 256 níveis de cinza

3.4. Umidade relativa do ar: de 0 a 100%

(Anexo acrescentado pela Portaria DETRAN/RS Nº 336 DE 26/07/2017):

ANEXO V Cadastro de equipamentos móveis dos fornecedores da solução de filmagens para uso do PPE

Este documento tem por objetivo a definição dos serviços para o cadastro de equipamentos móveis (tablets) das empresas fornecedoras da solução de filmagens para utilização do sistema de exame prático (PPE) do DETRAN/RS.

Característica Descrição
Padrão da mensagem A Integração se dará com serviços WEB HTTP utilizando a arquitetura REST (Representational State Transfer).
REST Conceitos: http://pt.wikipedia.org/wiki/REST
HTTP STATUS http://pt.wikipedia.org/wiki/Anexo:Lista_de_códigos_de_status_HTTP
URL de acesso https://m.prv.rs.gov.br/provas/rest/internet/equipamento/*
Meio de comunicação Rede internet da empresa fornecedora
Padrão de troca de mensagens Troca de mensagens no formato texto através do content-type JSON (Javascript Object Notation).
Credencial de acesso Usuário de sistema da empresa fornecedora, fornecido pelo DETRAN- RS

Método de acesso.

Comunicação através dos métodos:

POST - utilizado nos serviços de inclusão/alteração.

Serviços previstos para comunicação.

Abaixo estão descritos os serviços para cadastramento ou desativação de equipamentos móveis para uso do PPE.

2.1) Cadastramento de equipamento https://m.prv.rs.gov.br/provas/rest/internet/equipamento/cadastra

2.2) Desativação de equipamento https://m.prv.rs.gov.br/provas/rest/internet/equipamento/desativa

3. Códigos de retorno previstos.

Status HTTP Descrição Obs.
200 OK A requisição foi concluída com sucesso.
400 Requisição inválida A requisição foi concluída com erros.

O detalhamento dos dados de retorno para os Status HTTP será descrito em cada serviço.

4) Cadastramento de equipamento.

Este serviço deverá ser utilizado sempre que um equipamento móvel do CFC estiver sendo disponibilizado para o DETRAN aplicar exames práticos com o uso do PPE.

O serviço serve para inclusão de um novo equipamento ou atualização de um equipamento já existente. O campo chave do equipamento na base de dados do DETRAN será o nro IMEI. Se o IMEI já existir na base de dados, ele será atualizado. Se não existir, ele será criado.

Método HTTP:

POST

Descrição dos dados de envio (header):

Campo Tipo Tamanho Obrigatório Descrição Obs.
Organizacao Alfa 8 S Código de Organização SOE fornecido pelo DETRAN  
Matricula Numérico 10 S Código de Usuário SOE fornecido pelo DETRAN  
Senha Alfa 20 S Senha do Usuário SOE, definida pela empresa fornecedora  

Descrição dos dados de envio (body):

Campo Tipo Tamanho Obrigatório Descrição Obs.
Descricao Alfa 50 S Descrição do equipamento  
Modelo Alfa 30 S Marca/Modelo do equipamento  
tipoEquip Numérico 2 S 1=smartphone; 2=tablet  
Imei Alfa 18 S Nro IMEI do equipamento  
Cfc Alfa 8 S Código de Organização no SOE do CFC que irá utilizar o equipamento CHC99999
urlFilmagem Alfa 50 S Prefixo da URL dos serviços de filmagem que o equipamento irá acessar no DVR da empresa fornecedora Exemplo: http://filmage m

Se o retorno for Status HTTP 200, o equipamento foi cadastrado/atualizado com sucesso.

Se o retorno for Status HTTP 400, ocorreu erro no cadastramento/atualização. Nesse caso, os dados de retorno são os seguintes:

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro  

5) Desativação de equipamento.

Este serviço deverá ser utilizado quando um equipamento estiver sendo descartado/inutilizado pela empresa fornecedora.

Método HTTP:

POST

Descrição dos dados de envio (header):

Campo Tipo Tamanho Obrigatório Descrição Obs.
Organizacao Alfa 8 S Código de Organização SOE fornecido pelo DETRAN  
Matricula Numérico 10 S Código de Usuário SOE fornecido pelo DETRAN  
Senha Alfa 20 S Senha do Usuário SOE, definida pela empresa fornecedora  

Descrição dos dados de envio (body):

Campo Tipo Tamanho Obrigatório Descrição Obs.
tipoEquip Numérico 2 S 1=smartphone; 2=tablet  
Imei Alfa 18 S Nro IMEI do  
        equipamento  
Cfc Alfa 8 S Código de Organização no SOE do CFC que irá utilizar o equipamento CHC99999

Se o retorno for Status HTTP 200, o equipamento foi cadastrado/atualizado com sucesso.

Se o retorno for Status HTTP 400, ocorreu erro no cadastramento/atualização. Nesse caso, os dados de retorno são os seguintes:

Campo Tipo Tamanho Obrigatório Descrição Obs.
codErro Alfa 08 S Código do erro  
msgErro Alfa 200 S Mensagem de erro