Erros

A API do To Aqui Escola usa os códigos de status HTTP convencionais para indicar o sucesso ou falha de uma requisição. Em geral, códigos 2xx indicam sucesso, códigos 4xx indicam erros de cliente, e códigos 5xx indicam erros do servidor.

Códigos de status HTTP

200

OK

A requisição foi bem-sucedida.

400

Bad Request

A requisição foi malformada, geralmente por parâmetros ausentes ou inválidos.

401

Unauthorized

Os cabeçalhos de autenticação estão ausentes ou inválidos.

404

Not Found

O recurso solicitado não foi encontrado.

422

Unprocessable Entity

Os dados enviados são semanticamente incorretos. Verifique os campos obrigatórios e formatos.

503

Service Unavailable

O serviço está temporariamente indisponível.

Formato dos erros

Erros de validação retornam um objeto JSON com uma lista de erros.

Erro de validação 400 
{
  "success": false,
  "errors": [
    "O campo school_cnpj é obrigatório.",
    "O campo enrollment_number é obrigatório."
  ]
}
Recurso não encontrado 404 
{
  "success": false,
  "message": "Aluno não encontrado."
}
Status com contexto de frequência 400 
{
  "status": "ALREADY_CHECKED_IN",
  "message": "O aluno já realizou check-in hoje."
}