View Source ExDatacube.API.Resposta (ExDatacube v0.3.1)
Resposta padrão de retorno da API consultasdeveiculos
Link to this section Summary
Types
Mensagem de erro da API quando status: false
Indica o status da requisição. Se status
for false
, houve algum erro na requisição
e neste caso detalhes podem ser acessados na variável msg
.
Link to this section Types
@type error_message() :: String.t()
Mensagem de erro da API quando status: false
@type status() :: boolean()
Indica o status da requisição. Se status
for false
, houve algum erro na requisição
e neste caso detalhes podem ser acessados na variável msg
.
@type t() :: %ExDatacube.API.Resposta{ code: pos_integer(), http_code: pos_integer(), msg: error_message(), paid: boolean(), request_uid: String.t(), result: map(), status: boolean() }
Link to this section Functions
@spec new(map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}