Os códigos de resposta HTTP presentes no Open Keys abrangem a tabela descritiva abaixo.
Situação | Código HTTP | Notas | POST | GET | DELETE | PATCH | PUT |
|---|---|---|---|---|---|---|---|
Consulta concluída com sucesso. | 200 OK. | No caso de POST, retornar 200 apenas quando não acarretar alteração de recurso | Sim | Sim | Não | Sim | Sim |
Execução normal. A solicitação foi bem sucedida. | 201 Created. | A operação resulta na criação de um novo recurso. | Sim | Não | Não | Não | Não |
Operação de exclusão concluída com sucesso. | 204 No Content. |
| Não | Não | Sim | Não | Não |
A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. | 400 Bad Request. | A operação solicitada não será realizada. | Sim | Sim | Sim | Sim | Sim |
Cabeçalho de autenticação ausente/inválido ou token inválido. | 401 Unauthorized. | A operação foi recusada devido a um problema de autenticação. | Sim | Sim | Sim | Sim | Sim |
O recurso solicitado não existe ou não foi implementado. | 404 Not Found. |
| Sim | Sim | Sim | Sim | Sim |
A solicitação foi bem formada, mas não pôde ser processada devido à lógica de negócios específica da solicitação. | 422 Unprocessable Entity. | Se aplicável ao endpoint, espera-se que esse erro resulte em um payload de erro. | Sim | Sim | Não | Sim | Sim |
Ocorreu um erro no gateway da API ou no microsserviço. | 500 Internal Server Error. | A operação falhou. | Sim | Sim | Sim | Sim | Sim |