Estrutura de erros¶

Estrutura da mensagem de retorno¶

Os campos da tabela abaixo compõem a estrutura principal do retorno da chamada quando houver algum erro.

Campo	Descrição	Obrigatório
`slug`	Identificação do erro que representa o cenário de negócio em questão.	Sim
`message`	Mensagem descritiva do erro ocorrido.	Sim
`details`	Detalhamento do erro ocorrido.	Não

Exemplos¶

Erro 400 - Bad Resquest¶

{
   "slug":"BAD_REQUEST",
   "message":"Bad Resquest",
   "details":[
      {
         "field":"name",
         "location":"query",
         "slug":"INVALID_PARAMETER",
         "message":"Invalid parameter"
      }
   ]
}

Erro 401 - Unauthorized¶

{
  "slug": "UNAUTHORIZED",
  "message": "Unauthorized"
}

Erro 403 - Forbidden¶

{
  "slug": "FORBIDDEN",
  "message": "Forbidden"
}

Erro 404 - Not Found¶

{
  "slug": "NOT_FOUND",
  "message": "Not found"
}

Erro 409 - Conflict¶

{
   "slug":"CONFLICT",
   "message":"Conflict",
   "details":[
      {
         "field":"condition",
         "location":"body",
         "slug":"ENTITY_WITH_SAME_KEY_ALREADY_EXISTS",
         "message":"There is already an condition"
      }
   ]
}

Erro 422 - Unprocessable Entity¶

{
   "slug":"UNPROCESSABLE_ENTITY",
   "message":"Unprocessable entity",
   "details":[
      {
         "field":"condition",
         "location":"body",
         "slug":"INVALID_PARAMETER_VALUE",
         "message":"Invalid condition type"
      }
   ]
}

Erro 429 - Too Many Requests¶

{
  "slug": "TOO_MANY_REQUESTS",
  "message": "You have sent too many requests in a given amount of time"
}

Erro 500 - Internal Server Error¶

{
  "slug": "SERVER_ERROR",
  "message": "Internal server error"
}

Erro 502 - Bad Gateway¶

{
  "slug": "BAD_GATEWAY",
  "message": "Bad gateway"
}

Erro 503 - Service Unavailable¶

{
  "slug": "SERVICE_UNAVAILABLE",
  "message": "Service unavailable"
}

Erro 504 - Gateway Timeout¶

{
  "slug": "GATEWAY_TIMEOUT",
  "message": "Gateway timeout"
}