Portaria DETRAN/RS nº 189 DE 29/04/2019
Norma Estadual - Rio Grande do Sul - Publicado no DOE em 06 mai 2019
Altera o Anexo I da Portaria DETRAN/RS nº 471/2015, que estabelece os serviços de integração de aulas práticas e revoga a Portaria DETRAN/RS nº 675/2018.
O Diretor-Geral do Departamento Estadual de Trânsito do Estado do Rio Grande do Sul - DETRAN/RS, no uso das atribuições conferidas pelo art. 6º da Lei Estadual nº 10.847, de 20 de agosto de 1996, combinado com o art. 5º da Lei Estadual nº 14.479, de 23 de janeiro de 2014; e
Considerando a necessidade de qualificação dos serviços de habilitação de condutores;
Considerando o que consta no expediente de SPD nº 90829/2018,
Resolve:
Art. 1º Alterar o Anexo I da Portaria DETRAN/RS nº 471/2015, com redação estabelecida pelo Anexo I da Portaria DETRAN/RS nº 336/2017, que passa a vigorar conforme o Anexo Único da presente Portaria.
Art. 2º Revogar a Portaria DETRAN/RS nº 675/2018.
Art. 3º Esta Portaria entra em vigor na data de sua publicação.
Enio Bacci.
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