Todas as respostas são JSON com o campo status.
Sucesso com um registro
{ "status": "ok", "id_ordem": 123456, "situacao": "P" }
Sucesso com uma lista
{ "status": "ok", "data": [ { "id_ordem": 123456 }, { "id_ordem": 123457 } ] }
Erro: status error e um objeto errors com o campo e a mensagem.
{ "status": "error", "errors": { "id_ordem": "Valor inválido" } }
| Código | Significado | O que fazer |
|---|---|---|
200 |
Sucesso | — |
400 |
Dados inválidos ou regra de negócio (ex.: cancelar ordem que não está pendente) | Leia errors, corrija e envie de novo |
401 |
Autenticação falhou | Confira identificador, data (Brasília), valor e A — veja Autenticação |
403 |
Sem permissão para o método, ou registro fora do seu escopo | Veja Perfis e escopo |
404 |
Endereço inexistente | Confira o caminho (maiúsculas e minúsculas contam) |
405 |
Método não existe neste endpoint | Veja os métodos de cada endpoint |
5xx |
Falha no servidor | Tente de novo em alguns minutos; se continuar, avise o suporte com a hora e o endpoint |
400 como resposta de negócio (mostre a mensagem ao usuário); repita automaticamente só 5xx, com espera crescente.id devolvido pelo PetroW em toda gravação: é a chave para consultar, alterar e cancelar depois.