Detran PI - Consulta Licenciamento

O que é

Na consulta Detran PI - Consulta Licenciamento - você verifica informações e a situação de um veículo com placa registrada no Piauí: débitos do detran, multas, situação do IPVA e do licenciamento.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/detran-pi/veiculos/consulta-licenciamento

URL Base:

Parâmetros do header

Nome	Tipo	Obrigatório?	Descrição

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

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.

Retornos possíveis da requisição

Status	Significado	Descrição	Informações retornadas

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": {
    "placa": [
      "O campo placa é obrigatório."
    ],
    "renavam": [
      "O campo renavam é 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",
	"exercicio": "2020",
	"taxasDetran": {
		"mensagem": "Nenhum débito encontrado para este exercício",
		"itens": [
			{
				"vencimento": "31/03/2020",
				"tipo": "Seguro",
				"descricao": "Seguro obrigatório (DPVAT) 2020",
				"exercicio": "2020",
				"valor": 5.78
			},
			{
				"vencimento": "31/10/2020",
				"tipo": "Licencimanto",
				"descricao": "Renovação Licenciamento",
				"exercicio": "2020",
				"valor": 120.01
			}
		]
	},
	"multas": {
		"mensagem": "Nenhum débito encontrado para este exercício",
		"itens":[
			{
				"dataInfracao": "30/12/2019 14:38",
				"vencimentoPenalidade": "30/10/2020",
				"vencimentoBoleto": "30/10/2020",
				"descricao": "nº AUTO: A0000000000 Codigo infração: 54870 ESTACIONAR AO LADO DE OUTRO VEICULO EM FILA DUPLA",
				"orgaoAutuador": "PICOS",
				"local": "RUA ...",
				"status": "Penalizada",
				"valor": 156.18
			}
		]
	},
	"ipva": {
		"mensagem": "Nenhum débito encontrado para este exercício",
		"itens": [
			{
				"vencimento": "28/09/2020",
				"descricao": "IPVA - Pagamento Integral",
				"parcela": "Unica",
				"exercicio": "2020",
				"valorTotal": 3368.61
			}
		]
	}
}

Resposta com erro

Veículo não encontrado:

{
  "status":"erro",
  "mensagem":"400 - Veículo não encontrado",
  "pdf": "JVBER..."
}

Placa invalida:

{
  "status":"erro",
  "mensagem":"Placa inválida"
  "pdf": "JVBER..."
}