GET /api/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.
Importante: Caso a Ordem de Abastecimento retorne como Validada, 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.
Headers
Content-Type | application/json |
Authorization | Bearer {token} |
Request Query String application/json
Schema:
Campo | Tipo | Descrição | Obrigatório |
localizador | String | Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista. | Sim |
Response Body application/json
Schema:
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. |
TanqueCheio | Boolean | Indica se a Ordem de Abastecimento é para Tanque Cheio. Nesse caso, o Valor Total da Ordem será a Quantidade de Litros Abastecidos multiplicado pelo Valor Litro Negociado (Disponibilizado nesse objeto) |
Campos | Array of Objects | Valores de Campos solicitados pelo Transportador. |
Campos:
Campo | Tipo | Descrição |
Chave | String | Chave do Campo, que será enviada no momento da Validação. |
Descricao | String | Descrição do Campo para ser utilizado como Legenda/Label. |
Tipo | String | Tipo do Campo que será apresentado.
|
IdentificadorTipo | Integer | Identificador do Tipo do Campo. |
Obrigatorio | Boolean | Booleana que identifica se o Campo é obrigatório. |
JSON:
{
"validada": false
"tanqueCheio": true
"campos": [
{
"chave": "23",
"descricao": "Hodômetro",
"tipo": "integer",
"identificadorTipo": 2,
"obrigatorio": true
},
{
"chave": "24",
"descricao": "Placa",
"tipo": "string",
"identificadorTipo": 1,
"obrigatorio": true
}
]
}