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

O que é

Na Consulta ANTT - Registro Nacional de Transportadores Rodoviários de Cargas - é possível visualizar informações sobre um transportador, se está registrado (Registro Nacional de Transportadores Rodoviários de Cargas) e se apto a transportar cargas de forma remunerada.

Veja mais informações em nossa central de ajuda: ANTT - Registro Nacional de Transportadores Rodoviários de Cargas

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/antt-rntrc

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

cpfCnpj

string

Somente se rntrc não for informado

CPF ou CNPJ do transportador, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

rntrc

string

Somente se cpfCnpj não for informado

RNTRC do transportador.

placa

string

Não

Placa 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 )

Valores possíveis do campo “status“

Status

Significado

ativo

Registro existe e está apto a realizar transporte remunerado

pendente

Registro existe, mas está com alguma pendência

erro

Nenhum registro encontrado para os dados informados

Valores possíveis do campo “statusVeiculo“

Status

Significado

cadastrado

Indica que a mensagem de status do veículo contém o texto pode ser utilizado para o transporte

nao_cadastrado

Indica que a mensagem de status do veículo contém o texto Não está cadastrado na frota

Resposta com registro encontrado

{
  "status": "ativo",
  "statusVeiculo": "cadastrado",
  "transportador": "Transportador",
  "cpfCnpj": "123.456.789-00",
  "rntrc": "123456789",
  "dataCadastro": "11/11/2001",
  "dataValidade": "11/11/2001",
  "municipioUf": "Belo Horizonte\/MG",
  "dadosVeiculo": {
    "tipo": "Veículo Automotor",
    "placa": "ABC-1234",
    "identificacaoEletronica": "Não instalada"
  },
  "observacao": "Esse transportador está apto a realizar o transporte remunerado de cargas.",
  "pdf": "{PDF EM BASE64}"
}
{
  "status": "pendente",
  "statusVeiculo": "",
  "transportador": "Nome do transportado",
  "cpfCnpj": "999.999.999-99",
  "rntrc": "999999999",
  "dataCadastro": "05/07/2017",
  "dataValidade": "05/07/2022",
  "municipioUf": "Contagem/MG",
  "dadosVeiculo": null,
  "observacao": "Esse transportador NÃO está apto a realizar o transporte remunerado de cargas.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

{
  "status": "erro",
  "mensagem": "RNTRC inválido",
  "pdf": "{PDF EM BASE64}"
}
{
  "status": "erro",
  "mensagem": "Não foram encontrados transportadores para o filtro informado.",
  "pdf": "{PDF EM BASE64}"
}
  • No labels