Consultar Status de Boletins

Requisição

Usado para saber o que aconteceu com um ou mais boletins, informados no body pela referência do boletim no dispositivo (refBoletimSilvDispositivos). Se houver, também retorna o status do equipamento vinculado ao boletim. Regra de reenvio: apontamentos com status Erro podem ser enviados novamente enquanto o processo de importação ainda estiver com Erro. Apontamentos Cancelados só podem ser enviados quando o processo de importação estiver como Processado.

Segurança

API-Key and Client-Code

Corpoapplication/jsonobrigatório

refBoletimSilvDispositivosArray of strings, non-emptyobrigatório

Exemplo:

[
  "REF-0001"
]

curl -i -X POST \
  https://api-alliances.inflor-qas.cloud/api/v2/roads/bulletin-status \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Client-Code: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "refBoletimSilvDispositivos": [
      "REF-0001"
    ]
  }'

Respostas

Sucesso.

Corpoapplication/json

requestIdstring or null

statusstring

Resultado da requisição. Lista aberta: novos valores podem ser adicionados; clientes devem tolerar valores desconhecidos.

Enum:"success""processing""accepted""bad_request""unprocessable_entity""error""service_unavailable"

Exemplo:"success"

messagestring

dadosArray of objects

Exemplo:

[
  {
    "apontamentoId": "REF-0001",
    "status": "Processado",
    "mensagem": null,
    "equipamentos": [ … ]
  }
]

errorsobject or null

Erros de validação ou de recusa, por campo (campo -> lista de mensagens). A chave $ identifica uma recusa sem campo específico. É nulo nas falhas técnicas.

Resposta

{
  "requestId": "string",
  "status": "success",
  "message": "string",
  "dados": [
    { … }
  ],
  "errors": {
    "property1": [ … ],
    "property2": [ … ]
  }
}