Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

O que é

Na consulta Detran MA - Dados do Veículo - você verifica informações e a situação de um veículo com placa registrada no Maranhão:

  • proprietário, placa, marca, ano, cor,

  • débitos de IPVA, infrações, taxa de licenciamento e seguro DPVAT.

Veja mais informações em nossa central de ajuda: Detran MA - Dados do Veículo

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/detran-ma/veiculos/dados-veiculo

URL Base:

https://api.plexi.com.br/

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

renavam

string

Somente se o chassi não for informado

Renavam do veículo a ser pesquisado.

chassi

string

Somente se o renavam não for informado

Chassi 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

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

Status 422

{
  "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 )

Resposta com registro encontrado

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“.

    • A propriedade “mensagem“ é preenchida quando o objeto de débitos relacionados é vazio. Da mesma forma, quando o objeto de débitos possui informação, a propriedade “mensagem“ é vazia.

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

{
	"placa": "AAA0000",
	"renavam": "999999999",
	"marca": "FORD",
	"modelo": "FIESTA",
	"cor": "PRATA",
	"proprietario": "NOME DO PROPRIETÁRIO",
	"municipio": "ITAPECURU MIRIM",
	"anoFabricacao": "2002",
	"anoModelo": "2003",
	"dataHoraConsulta": "01/01/2020 16:18:27",
	"ultimoLicenciamento": "2019",
	"possuiRestricao": "Não",
	"debitos": {
		"mensagem": "Nenhum du00e9bito encontrado",
		"itens": [
			{
				"descricao": "TAXA LICENCIAMENTO.:PARCELA UNICA",
				"exercicio": "2020",
				"situacao": "Vencido",
				"vencimento": "08/06/2020",
				"valor": 85.00
			},
			{
				"descricao": "INFRACAO ESTADUAL , AUTO: AAA9999999",
				"exercicio": "2020",
				"situacao": "Vencido",
				"vencimento": "05/01/2018",
				"valor": 220.27
			}
		]
	}
}

Resposta com erro

{
  "status":"erro",
  "mensagem":"RENAVAM/CHASSI NÃO EXISTE."
}
  • No labels