Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

O que é

Na consulta Detran MT - Consulta Veículo - você verifica informações e restrições de um veículo com placa registrada no Mato Grosso:

  • informações como marca, modelo, categoria, cor, ano de fabricação

  • se possui débitos, restrições, multas

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/detran-mt/veiculos/consulta-veiculo

...

Include Page
URL Base
URL Base

Parâmetros do header

Nome

Tipo

Obrigatório?

Descrição

Authorization

String

Sim

Chave de API gerada no cadastro no Plexi, prefixada com Bearer

Callback

String

Não

URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body

Nome

Tipo

Obrigatório?

Descrição

placa

string

Sim

Placa do veículo a ser pesquisado.

renavam

string

Sim

Renavam do veículo a ser pesquisado.

cpfCnpj

string

Sim

CPF ou CNPJ do proprietário do veículo a ser pesquisado.

Retornos possíveis da requisição

Status

Significado

Descrição

Informações retornadas

201

Created

Solicitação criada

Campo requestId, com o ID da requisição criada.

422

Unprocessable Entity

A solicitação contém erro

Em quais campos houve erro.

Exemplos de retornos

Status 201

Code Block
{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

...

Code Block
{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é obrigatório."
    ]
  }
}

 

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Observações:

  • Informações relacionadas a débitos são apresentadas de 2 formas:

    • A propriedade “itens“ apresenta os débitos, quando existem

    • A propriedade “mensagem“ exibe alguma mensagem quando não há débitos. Exemplos de mensagens: “Nenhuma observação encontrada“, “Nenhuma restrição encontrada“.

    • As mensagens são exibidas exatamente como retornadas da fonte original.

...