View Source ExDatacube.Veiculos behaviour (ExDatacube v0.4.0)

Define behaviour com chamadas da API de informações de veículos.

Link to this section Summary

Types

Adaptador a ser utilizado para comunicar-se com a API.

Placa do veículo a ser buscada

Callbacks

Retorna resultado da busca de veículos simplificada (sem proprietário) e mais em conta, no entanto há a possibilidade da informação de Renavam não retornar na consulta.

Retorna resultado da busca de veículos completa.

Retorna resultado da busca de veículos simplificada

Retorna resultado da busca de veículos simplificada V3 (sem informação de proprietário)

Link to this section Types

@type adaptador() :: module()

Adaptador a ser utilizado para comunicar-se com a API.

@type placa() :: String.t()

Placa do veículo a ser buscada

Link to this section Callbacks

Link to this callback

consulta_nacional_agregados(placa, shared_opts)

View Source
@callback consulta_nacional_agregados(placa(), ExDatacube.shared_opts()) ::
  {:ok, ExDatacube.Veiculos.Veiculo.t()} | {:error, ExDatacube.API.error()}

Retorna resultado da busca de veículos simplificada (sem proprietário) e mais em conta, no entanto há a possibilidade da informação de Renavam não retornar na consulta.

Link to this callback

consulta_nacional_completa(placa, shared_opts)

View Source
@callback consulta_nacional_completa(placa(), ExDatacube.shared_opts()) ::
  {:ok, ExDatacube.Veiculos.Veiculo.t()} | {:error, ExDatacube.API.error()}

Retorna resultado da busca de veículos completa.

Link to this callback

consulta_nacional_simples_v2(placa, shared_opts)

View Source
@callback consulta_nacional_simples_v2(placa(), ExDatacube.shared_opts()) ::
  {:ok, ExDatacube.Veiculos.Veiculo.t()} | {:error, ExDatacube.API.error()}

Retorna resultado da busca de veículos simplificada

Link to this callback

consulta_nacional_simples_v3(placa, shared_opts)

View Source
@callback consulta_nacional_simples_v3(placa(), ExDatacube.shared_opts()) ::
  {:ok, ExDatacube.Veiculos.Veiculo.t()} | {:error, ExDatacube.API.error()}

Retorna resultado da busca de veículos simplificada V3 (sem informação de proprietário)