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 8 Next »

O que é

Consulta pública sobre informações de situações de veículos cadastrados no Detran do Rio Grande do Sul.

Veja mais informações em nossa central de ajuda: Detran RS - Consulta Individual de Veículo.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/detran-rs/veiculos/consulta-individual-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

placa

string

Sim

Placa do veículo a ser pesquisado.

renavam

string

Sim

Renavam do veículo a ser pesquisado.

Estrutura da resposta

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 quando você faz a requisição:

Status 201

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

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

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

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

  {
    "marca": "FORD",
    "modelo": "ECOSPORT FSL1.6FLEX",
    "renavam": "99999999",
    "placa": "AAA0000",
    "municipio": "PORTO ALEGRE",
    "tipo": "Camioneta",
    "especie": "Misto",
    "chassi": "9A9A99999AAAAA99990",
    "situacao": "Em circulação",
    "furtado": false,
    "emDeposito": false,
    "anoFabricacao": 2013,
    "anoModelo": 2013,
    "cpfProprietario": "99999999999",
    "cor": "Preta",
    "validadeUltimoLicenciamento": "30/04/2017",
    "dataUltimoLicenciamento": "27/01/2017",
    "ipva": [
        {
            "vencimento": "06/04/2020",
            "valorOriginal": 932.38,
            "exercicio": 2020,
            "dividaAtiva": true,
            "situacao": "Com DAT"
        }
    ],
    "infracoes": [
        {
            "orgaoAutuador": 999999,
            "serie": "E99999999",
            "dataHora": "31/03/2020 14:46",
            "descricao": "TRANSITAR EM VELOCIDADE SUPERIOR À MÁXIMA PERMITIDA EM ATÉ 20%",
            "valor": 130.16,
            "local": "AV XXX, 843 - SANTA ISABEL",
            "pontuacao": 4,
            "situacao": "A Vencer"
        }
    ],
    "licenciamento": {
        "codigoSegurancaCrlv": null,
        "descricaoDocumento": "CRLV",
        "crlve": false,
        "exercicio": 2016,
        "fac": false,
        "codigoRastreamentoSedex": "AA999999999BR",
        "postadoCorreios": "27/01/2017",
        "situacaoDocumento": "Documento entregue ao destinatário"
    },
    "restricoes": [
        {
            "descricao": "SNG - Alienação Fiduciária",
            "campos": [
                {
                    "nome": "Data do Contrato",
                    "valor": "20/04/2011"
                }
            ]
        }
    ],
    "dpvat": [
        {
            "exercicio": "2020",
            "valor": 5.23,
            "situacao": "Seguro não pago"
        },
        {
            "exercicio": "2019",
            "valor": 16.21,
            "situacao": "Seguro não pago"
        }
    ],
    "pdf":"..."
}

Resposta com erro

Placa não encontrada:

{
  "status": "erro",
  "mensagem": "Nenhum veículo encontrado com os critérios informados."
}

Renavam inválido:

{
  "status": "erro",
  "mensagem": "O Código RENAVAM informado não é deste veículo."
}

Placa incorreta e renavam correto:

{
  "status": "erro",
  "mensagem": "A placa do veículo é: AAA0000. Informe esta placa para efetuar a consulta."
}

  • No labels