Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

GET /api/broker/ordemAbastecimento/{localizador}

Endpoint responsável por Localizar uma Ordem de Abastecimento e retornar os dados da mesma para que seja disponibilizado na interface do Sistema de Pagamento.

...

Campo

Tipo

Descrição

Validada

Boolean

Indica se a Ordem de Abastecimento já se encontra Validada. Em caso positivo, a etapa de Validação da Ordem de Abastecimento não deve ser apresentada, avançando direto para a etapa de Autorização da Ordem de Abastecimento.

Combustiveis

Array of Objects <Combustivel>

Valores de Combustíveis existentes no Estabelecimento para serem apresentados em uma Combo de Seleção no momento da Validação.

Campos

Array of Objects <Campo>

Valores de Campos solicitados pelo Transportador.

Detalhes

Array of Objects <Detalhes>

Dados da Ordem de Abastecimento a serem apresentados para o Usuário na Tela de Detalhes da Ordem de Abastecimento.

UsuarioAutorizador

Boolean

Booleana que indica se o Usuário Logado tem privilégios de Autorizar uma Ordem de Abastecimento. No caso negativo, sistema não poderá Avançar a Tela de Detalhes da Ordem de Abastecimento. Opção utilizada apenas por Parceiros que possuem privilégios diferentes para os usuários que estão acessando a plataforma.

<Combustivel>:

Campo

Tipo

Descrição

Valor

String

Valor do Combustível, que deverá ser enviado no momento da Validação.

Descricao

String

Descrição do Combustível, que deverá ser apresentado na Combo de Seleção.

...